diff --git a/docs/api/classes/AgentRuntime.md b/docs/api/classes/AgentRuntime.md index 87f1617f6b5..a883b0f759b 100644 --- a/docs/api/classes/AgentRuntime.md +++ b/docs/api/classes/AgentRuntime.md @@ -95,7 +95,7 @@ The ID of the agent [packages/core/src/runtime.ts:59](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L59) ---- +*** ### serverUrl @@ -111,7 +111,7 @@ The base URL of the server where the agent's requests are processed. [packages/core/src/runtime.ts:63](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L63) ---- +*** ### databaseAdapter @@ -127,7 +127,7 @@ The database adapter used for interacting with the database. [packages/core/src/runtime.ts:68](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L68) ---- +*** ### token @@ -143,7 +143,7 @@ Authentication token used for securing requests. [packages/core/src/runtime.ts:73](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L73) ---- +*** ### actions @@ -159,7 +159,7 @@ Custom actions that the agent can perform. [packages/core/src/runtime.ts:78](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L78) ---- +*** ### evaluators @@ -175,7 +175,7 @@ Evaluators used to assess and guide the agent's responses. [packages/core/src/runtime.ts:83](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L83) ---- +*** ### providers @@ -191,7 +191,7 @@ Context providers used to provide context for message generation. [packages/core/src/runtime.ts:88](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L88) ---- +*** ### modelProvider @@ -207,7 +207,7 @@ The model to use for generateText. [packages/core/src/runtime.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L93) ---- +*** ### fetch() @@ -242,7 +242,7 @@ Some environments may not have access to the global fetch function and need a cu [packages/core/src/runtime.ts:99](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L99) ---- +*** ### character @@ -258,7 +258,7 @@ The character to use for the agent [packages/core/src/runtime.ts:104](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L104) ---- +*** ### messageManager @@ -274,7 +274,7 @@ Store messages that are sent and received by the agent. [packages/core/src/runtime.ts:109](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L109) ---- +*** ### descriptionManager @@ -290,7 +290,7 @@ Store and recall descriptions of users based on conversations. [packages/core/src/runtime.ts:114](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L114) ---- +*** ### loreManager @@ -306,7 +306,7 @@ Manage the creation and recall of static information (documents, historical game [packages/core/src/runtime.ts:119](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L119) ---- +*** ### documentsManager @@ -318,7 +318,7 @@ Hold large documents that can be referenced [packages/core/src/runtime.ts:124](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L124) ---- +*** ### fragmentsManager @@ -330,7 +330,7 @@ Searchable document fragments [packages/core/src/runtime.ts:129](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L129) ---- +*** ### services @@ -344,7 +344,7 @@ Searchable document fragments [packages/core/src/runtime.ts:131](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L131) ---- +*** ### memoryManagers @@ -376,7 +376,7 @@ Searchable document fragments [packages/core/src/runtime.ts:134](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L134) ---- +*** ### getMemoryManager() @@ -398,7 +398,7 @@ Searchable document fragments [packages/core/src/runtime.ts:149](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L149) ---- +*** ### getService() @@ -424,7 +424,7 @@ Searchable document fragments [packages/core/src/runtime.ts:153](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L153) ---- +*** ### registerService() @@ -446,7 +446,7 @@ Searchable document fragments [packages/core/src/runtime.ts:161](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L161) ---- +*** ### getSetting() @@ -472,7 +472,7 @@ then chunks the content into fragments, embeds each fragment, and creates fragme [packages/core/src/runtime.ts:371](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L371) ---- +*** ### getConversationLength() @@ -494,7 +494,7 @@ The number of recent messages to be kept in memory. [packages/core/src/runtime.ts:393](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L393) ---- +*** ### registerAction() @@ -520,7 +520,7 @@ The action to register. [packages/core/src/runtime.ts:401](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L401) ---- +*** ### registerEvaluator() @@ -542,7 +542,7 @@ The evaluator to register. [packages/core/src/runtime.ts:410](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L410) ---- +*** ### registerContextProvider() @@ -564,7 +564,7 @@ The context provider to register. [packages/core/src/runtime.ts:418](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L418) ---- +*** ### processActions() @@ -596,11 +596,11 @@ The message to process. [packages/core/src/runtime.ts:427](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L427) ---- +*** ### evaluate() -> **evaluate**(`message`, `state`?): `Promise`\<`string`[]\> +> **evaluate**(`message`, `state`?, `didRespond`?): `Promise`\<`string`[]\> Evaluate the message and state using the registered evaluators. @@ -614,6 +614,10 @@ The message to evaluate. The state of the agent. +• **didRespond?**: `boolean` + +Whether the agent responded to the message. + #### Returns `Promise`\<`string`[]\> @@ -626,9 +630,9 @@ The results of the evaluation. #### Defined in -[packages/core/src/runtime.ts:499](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L499) +[packages/core/src/runtime.ts:500](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L500) ---- +*** ### ensureParticipantExists() @@ -658,9 +662,9 @@ An error if the participant cannot be added. #### Defined in -[packages/core/src/runtime.ts:565](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L565) +[packages/core/src/runtime.ts:571](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L571) ---- +*** ### ensureUserExists() @@ -694,9 +698,9 @@ The user name to ensure the existence of. #### Defined in -[packages/core/src/runtime.ts:581](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L581) +[packages/core/src/runtime.ts:587](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L587) ---- +*** ### ensureParticipantInRoom() @@ -718,9 +722,9 @@ The user name to ensure the existence of. #### Defined in -[packages/core/src/runtime.ts:601](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L601) +[packages/core/src/runtime.ts:607](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L607) ---- +*** ### ensureConnection() @@ -748,9 +752,9 @@ The user name to ensure the existence of. #### Defined in -[packages/core/src/runtime.ts:612](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L612) +[packages/core/src/runtime.ts:618](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L618) ---- +*** ### ensureRoomExists() @@ -779,9 +783,9 @@ An error if the room cannot be created. #### Defined in -[packages/core/src/runtime.ts:648](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L648) +[packages/core/src/runtime.ts:654](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L654) ---- +*** ### composeState() @@ -809,9 +813,9 @@ The state of the agent. #### Defined in -[packages/core/src/runtime.ts:661](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L661) +[packages/core/src/runtime.ts:667](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L667) ---- +*** ### updateRecentMessageState() @@ -831,4 +835,4 @@ The state of the agent. #### Defined in -[packages/core/src/runtime.ts:1094](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1094) +[packages/core/src/runtime.ts:1100](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1100) diff --git a/docs/api/classes/DatabaseAdapter.md b/docs/api/classes/DatabaseAdapter.md index a6a02a606ad..2bc9a6f6a6a 100644 --- a/docs/api/classes/DatabaseAdapter.md +++ b/docs/api/classes/DatabaseAdapter.md @@ -61,7 +61,7 @@ A Promise that resolves to the Account object or null if not found. [packages/core/src/database.ts:27](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L27) ---- +*** ### createAccount() @@ -89,7 +89,7 @@ A Promise that resolves when the account creation is complete. [packages/core/src/database.ts:34](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L34) ---- +*** ### getMemories() @@ -125,7 +125,7 @@ A Promise that resolves to an array of Memory objects. [packages/core/src/database.ts:41](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L41) ---- +*** ### getMemoriesByRoomIds() @@ -153,7 +153,7 @@ A Promise that resolves to an array of Memory objects. [packages/core/src/database.ts:48](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L48) ---- +*** ### getMemoryById() @@ -175,7 +175,7 @@ A Promise that resolves to an array of Memory objects. [packages/core/src/database.ts:54](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L54) ---- +*** ### getCachedEmbeddings() @@ -189,17 +189,17 @@ Retrieves cached embeddings based on the specified query parameters. An object containing parameters for the embedding retrieval. -• **params.query_table_name**: `string` +• **params.query\_table\_name**: `string` -• **params.query_threshold**: `number` +• **params.query\_threshold**: `number` -• **params.query_input**: `string` +• **params.query\_input**: `string` -• **params.query_field_name**: `string` +• **params.query\_field\_name**: `string` -• **params.query_field_sub_name**: `string` +• **params.query\_field\_sub\_name**: `string` -• **params.query_match_count**: `number` +• **params.query\_match\_count**: `number` #### Returns @@ -215,7 +215,7 @@ A Promise that resolves to an array of objects containing embeddings and levensh [packages/core/src/database.ts:61](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L61) ---- +*** ### log() @@ -251,7 +251,7 @@ A Promise that resolves when the log entry has been saved. [packages/core/src/database.ts:87](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L87) ---- +*** ### getActorDetails() @@ -281,7 +281,7 @@ A Promise that resolves to an array of Actor objects. [packages/core/src/database.ts:99](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L99) ---- +*** ### searchMemories() @@ -301,9 +301,9 @@ An object containing parameters for the memory search. • **params.embedding**: `number`[] -• **params.match_threshold**: `number` +• **params.match\_threshold**: `number` -• **params.match_count**: `number` +• **params.match\_count**: `number` • **params.unique**: `boolean` @@ -321,7 +321,7 @@ A Promise that resolves to an array of Memory objects. [packages/core/src/database.ts:106](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L106) ---- +*** ### updateGoalStatus() @@ -353,7 +353,7 @@ A Promise that resolves when the goal status has been updated. [packages/core/src/database.ts:120](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L120) ---- +*** ### searchMemoriesByEmbedding() @@ -371,7 +371,7 @@ The embedding vector to search with. Additional parameters for the search. -• **params.match_threshold?**: `number` +• **params.match\_threshold?**: `number` • **params.count?**: `number` @@ -397,7 +397,7 @@ A Promise that resolves to an array of Memory objects. [packages/core/src/database.ts:131](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L131) ---- +*** ### createMemory() @@ -433,7 +433,7 @@ A Promise that resolves when the memory has been created. [packages/core/src/database.ts:150](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L150) ---- +*** ### removeMemory() @@ -465,7 +465,7 @@ A Promise that resolves when the memory has been removed. [packages/core/src/database.ts:162](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L162) ---- +*** ### removeAllMemories() @@ -497,7 +497,7 @@ A Promise that resolves when all memories have been removed. [packages/core/src/database.ts:170](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L170) ---- +*** ### countMemories() @@ -533,7 +533,7 @@ A Promise that resolves to the number of memories. [packages/core/src/database.ts:179](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L179) ---- +*** ### getGoals() @@ -569,7 +569,7 @@ A Promise that resolves to an array of Goal objects. [packages/core/src/database.ts:190](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L190) ---- +*** ### updateGoal() @@ -597,7 +597,7 @@ A Promise that resolves when the goal has been updated. [packages/core/src/database.ts:202](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L202) ---- +*** ### createGoal() @@ -625,7 +625,7 @@ A Promise that resolves when the goal has been created. [packages/core/src/database.ts:209](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L209) ---- +*** ### removeGoal() @@ -653,7 +653,7 @@ A Promise that resolves when the goal has been removed. [packages/core/src/database.ts:216](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L216) ---- +*** ### removeAllGoals() @@ -681,7 +681,7 @@ A Promise that resolves when all goals have been removed. [packages/core/src/database.ts:223](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L223) ---- +*** ### getRoom() @@ -709,7 +709,7 @@ A Promise that resolves to the room ID or null if not found. [packages/core/src/database.ts:230](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L230) ---- +*** ### createRoom() @@ -737,7 +737,7 @@ A Promise that resolves to the UUID of the created room. [packages/core/src/database.ts:237](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L237) ---- +*** ### removeRoom() @@ -765,7 +765,7 @@ A Promise that resolves when the room has been removed. [packages/core/src/database.ts:244](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L244) ---- +*** ### getRoomsForParticipant() @@ -793,7 +793,7 @@ A Promise that resolves to an array of room IDs. [packages/core/src/database.ts:251](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L251) ---- +*** ### getRoomsForParticipants() @@ -821,7 +821,7 @@ A Promise that resolves to an array of room IDs. [packages/core/src/database.ts:258](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L258) ---- +*** ### addParticipant() @@ -853,7 +853,7 @@ A Promise that resolves to a boolean indicating success or failure. [packages/core/src/database.ts:266](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L266) ---- +*** ### removeParticipant() @@ -885,7 +885,7 @@ A Promise that resolves to a boolean indicating success or failure. [packages/core/src/database.ts:274](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L274) ---- +*** ### getParticipantsForAccount() @@ -941,7 +941,7 @@ A Promise that resolves to an array of Participant objects. [packages/core/src/database.ts:288](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L288) ---- +*** ### getParticipantsForRoom() @@ -969,7 +969,7 @@ A Promise that resolves to an array of UUIDs representing the participants. [packages/core/src/database.ts:295](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L295) ---- +*** ### getParticipantUserState() @@ -993,7 +993,7 @@ A Promise that resolves to an array of UUIDs representing the participants. [packages/core/src/database.ts:297](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L297) ---- +*** ### setParticipantUserState() @@ -1019,7 +1019,7 @@ A Promise that resolves to an array of UUIDs representing the participants. [packages/core/src/database.ts:301](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L301) ---- +*** ### createRelationship() @@ -1051,7 +1051,7 @@ A Promise that resolves to a boolean indicating success or failure of the creati [packages/core/src/database.ts:312](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L312) ---- +*** ### getRelationship() @@ -1083,7 +1083,7 @@ A Promise that resolves to the Relationship object or null if not found. [packages/core/src/database.ts:322](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L322) ---- +*** ### getRelationships() diff --git a/docs/api/classes/MemoryManager.md b/docs/api/classes/MemoryManager.md index 5b10d7eaf2a..b90d3e66ca2 100644 --- a/docs/api/classes/MemoryManager.md +++ b/docs/api/classes/MemoryManager.md @@ -52,7 +52,7 @@ The AgentRuntime instance associated with this manager. [packages/core/src/memory.ts:22](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L22) ---- +*** ### tableName @@ -96,7 +96,7 @@ A Promise resolving to the memory object, potentially updated with an embedding [packages/core/src/memory.ts:45](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L45) ---- +*** ### getMemories() @@ -142,7 +142,7 @@ A Promise resolving to an array of Memory objects. [packages/core/src/memory.ts:66](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L66) ---- +*** ### getCachedEmbeddings() @@ -164,7 +164,7 @@ A Promise resolving to an array of Memory objects. [packages/core/src/memory.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L93) ---- +*** ### searchMemoriesByEmbedding() @@ -182,7 +182,7 @@ The embedding vector to search with. Options including match threshold, count, user IDs, and uniqueness. -• **opts.match_threshold?**: `number` +• **opts.match\_threshold?**: `number` The similarity threshold for matching memories. @@ -214,7 +214,7 @@ A Promise resolving to an array of Memory objects that match the embedding. [packages/core/src/memory.ts:120](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L120) ---- +*** ### createMemory() @@ -246,7 +246,7 @@ A Promise that resolves when the operation completes. [packages/core/src/memory.ts:158](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L158) ---- +*** ### getMemoriesByRoomIds() @@ -272,7 +272,7 @@ A Promise that resolves when the operation completes. [packages/core/src/memory.ts:172](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L172) ---- +*** ### getMemoryById() @@ -294,7 +294,7 @@ A Promise that resolves when the operation completes. [packages/core/src/memory.ts:183](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L183) ---- +*** ### removeMemory() @@ -322,7 +322,7 @@ A Promise that resolves when the operation completes. [packages/core/src/memory.ts:193](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L193) ---- +*** ### removeAllMemories() @@ -350,7 +350,7 @@ A Promise that resolves when the operation completes. [packages/core/src/memory.ts:205](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L205) ---- +*** ### countMemories() diff --git a/docs/api/classes/Service.md b/docs/api/classes/Service.md index fbb3735e96b..19bb618ff5d 100644 --- a/docs/api/classes/Service.md +++ b/docs/api/classes/Service.md @@ -28,7 +28,7 @@ #### Defined in -[packages/core/src/types.ts:504](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L504) +[packages/core/src/types.ts:507](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L507) ## Methods @@ -38,7 +38,7 @@ #### Type Parameters -• **T** _extends_ [`Service`](Service.md) +• **T** *extends* [`Service`](Service.md) #### Returns @@ -46,4 +46,4 @@ #### Defined in -[packages/core/src/types.ts:506](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L506) +[packages/core/src/types.ts:509](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L509) diff --git a/docs/api/enumerations/Clients.md b/docs/api/enumerations/Clients.md index e90fff74a19..9f74cc22f0e 100644 --- a/docs/api/enumerations/Clients.md +++ b/docs/api/enumerations/Clients.md @@ -8,9 +8,9 @@ #### Defined in -[packages/core/src/types.ts:318](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L318) +[packages/core/src/types.ts:321](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L321) ---- +*** ### DIRECT @@ -18,9 +18,9 @@ #### Defined in -[packages/core/src/types.ts:319](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L319) +[packages/core/src/types.ts:322](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L322) ---- +*** ### TWITTER @@ -28,9 +28,9 @@ #### Defined in -[packages/core/src/types.ts:320](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L320) +[packages/core/src/types.ts:323](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L323) ---- +*** ### TELEGRAM @@ -38,4 +38,4 @@ #### Defined in -[packages/core/src/types.ts:321](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L321) +[packages/core/src/types.ts:324](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L324) diff --git a/docs/api/enumerations/GoalStatus.md b/docs/api/enumerations/GoalStatus.md index b382f55496e..c59410d5332 100644 --- a/docs/api/enumerations/GoalStatus.md +++ b/docs/api/enumerations/GoalStatus.md @@ -10,7 +10,7 @@ [packages/core/src/types.ts:57](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L57) ---- +*** ### FAILED @@ -20,11 +20,11 @@ [packages/core/src/types.ts:58](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L58) ---- +*** -### IN_PROGRESS +### IN\_PROGRESS -> **IN_PROGRESS**: `"IN_PROGRESS"` +> **IN\_PROGRESS**: `"IN_PROGRESS"` #### Defined in diff --git a/docs/api/enumerations/ModelClass.md b/docs/api/enumerations/ModelClass.md index b80fc26932f..9c661ba6246 100644 --- a/docs/api/enumerations/ModelClass.md +++ b/docs/api/enumerations/ModelClass.md @@ -10,7 +10,7 @@ [packages/core/src/types.ts:75](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L75) ---- +*** ### MEDIUM @@ -20,7 +20,7 @@ [packages/core/src/types.ts:76](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L76) ---- +*** ### LARGE @@ -30,7 +30,7 @@ [packages/core/src/types.ts:77](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L77) ---- +*** ### EMBEDDING @@ -40,7 +40,7 @@ [packages/core/src/types.ts:78](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L78) ---- +*** ### IMAGE diff --git a/docs/api/enumerations/ModelProviderName.md b/docs/api/enumerations/ModelProviderName.md index 0dbef44ba51..667a808e7d7 100644 --- a/docs/api/enumerations/ModelProviderName.md +++ b/docs/api/enumerations/ModelProviderName.md @@ -8,9 +8,9 @@ #### Defined in -[packages/core/src/types.ts:119](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L119) +[packages/core/src/types.ts:120](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L120) ---- +*** ### ANTHROPIC @@ -18,9 +18,9 @@ #### Defined in -[packages/core/src/types.ts:120](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L120) +[packages/core/src/types.ts:121](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L121) ---- +*** ### GROK @@ -28,9 +28,9 @@ #### Defined in -[packages/core/src/types.ts:121](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L121) +[packages/core/src/types.ts:122](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L122) ---- +*** ### GROQ @@ -38,9 +38,9 @@ #### Defined in -[packages/core/src/types.ts:122](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L122) +[packages/core/src/types.ts:123](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L123) ---- +*** ### LLAMACLOUD @@ -48,9 +48,9 @@ #### Defined in -[packages/core/src/types.ts:123](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L123) +[packages/core/src/types.ts:124](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L124) ---- +*** ### LLAMALOCAL @@ -58,9 +58,9 @@ #### Defined in -[packages/core/src/types.ts:124](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L124) +[packages/core/src/types.ts:125](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L125) ---- +*** ### GOOGLE @@ -68,19 +68,19 @@ #### Defined in -[packages/core/src/types.ts:125](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L125) +[packages/core/src/types.ts:126](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L126) ---- +*** -### CLAUDE_VERTEX +### CLAUDE\_VERTEX -> **CLAUDE_VERTEX**: `"claude_vertex"` +> **CLAUDE\_VERTEX**: `"claude_vertex"` #### Defined in -[packages/core/src/types.ts:126](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L126) +[packages/core/src/types.ts:127](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L127) ---- +*** ### REDPILL @@ -88,9 +88,19 @@ #### Defined in -[packages/core/src/types.ts:127](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L127) +[packages/core/src/types.ts:128](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L128) + +*** ---- +### OPENROUTER + +> **OPENROUTER**: `"openrouter"` + +#### Defined in + +[packages/core/src/types.ts:129](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L129) + +*** ### OLLAMA @@ -98,4 +108,4 @@ #### Defined in -[packages/core/src/types.ts:128](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L128) +[packages/core/src/types.ts:130](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L130) diff --git a/docs/api/enumerations/ServiceType.md b/docs/api/enumerations/ServiceType.md index 4be1a88cf08..6bc3668bee1 100644 --- a/docs/api/enumerations/ServiceType.md +++ b/docs/api/enumerations/ServiceType.md @@ -2,15 +2,15 @@ ## Enumeration Members -### IMAGE_DESCRIPTION +### IMAGE\_DESCRIPTION -> **IMAGE_DESCRIPTION**: `"image_description"` +> **IMAGE\_DESCRIPTION**: `"image_description"` #### Defined in -[packages/core/src/types.ts:638](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L638) +[packages/core/src/types.ts:646](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L646) ---- +*** ### TRANSCRIPTION @@ -18,9 +18,9 @@ #### Defined in -[packages/core/src/types.ts:639](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L639) +[packages/core/src/types.ts:647](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L647) ---- +*** ### VIDEO @@ -28,19 +28,19 @@ #### Defined in -[packages/core/src/types.ts:640](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L640) +[packages/core/src/types.ts:648](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L648) ---- +*** -### TEXT_GENERATION +### TEXT\_GENERATION -> **TEXT_GENERATION**: `"text_generation"` +> **TEXT\_GENERATION**: `"text_generation"` #### Defined in -[packages/core/src/types.ts:641](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L641) +[packages/core/src/types.ts:649](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L649) ---- +*** ### BROWSER @@ -48,19 +48,19 @@ #### Defined in -[packages/core/src/types.ts:642](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L642) +[packages/core/src/types.ts:650](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L650) ---- +*** -### SPEECH_GENERATION +### SPEECH\_GENERATION -> **SPEECH_GENERATION**: `"speech_generation"` +> **SPEECH\_GENERATION**: `"speech_generation"` #### Defined in -[packages/core/src/types.ts:643](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L643) +[packages/core/src/types.ts:651](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L651) ---- +*** ### PDF @@ -68,4 +68,4 @@ #### Defined in -[packages/core/src/types.ts:644](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L644) +[packages/core/src/types.ts:652](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L652) diff --git a/docs/api/functions/embed.md b/docs/api/functions/embed.md index 437c7e00488..d198cecfc0f 100644 --- a/docs/api/functions/embed.md +++ b/docs/api/functions/embed.md @@ -20,4 +20,4 @@ The embedding of the input. ## Defined in -[packages/core/src/embedding.ts:14](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L14) +[packages/core/src/embedding.ts:30](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L30) diff --git a/docs/api/functions/findNearestEnvFile.md b/docs/api/functions/findNearestEnvFile.md new file mode 100644 index 00000000000..4eea3887986 --- /dev/null +++ b/docs/api/functions/findNearestEnvFile.md @@ -0,0 +1,22 @@ +# Function: findNearestEnvFile() + +> **findNearestEnvFile**(`startDir`?): `any` + +Recursively searches for a .env file starting from the current directory +and moving up through parent directories + +## Parameters + +• **startDir?**: `string` = `...` + +Starting directory for the search + +## Returns + +`any` + +Path to the nearest .env file or null if not found + +## Defined in + +[packages/core/src/settings.ts:11](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L11) diff --git a/docs/api/functions/generateCaption.md b/docs/api/functions/generateCaption.md index da65f279938..366a0cc5e53 100644 --- a/docs/api/functions/generateCaption.md +++ b/docs/api/functions/generateCaption.md @@ -24,4 +24,4 @@ ## Defined in -[packages/core/src/generation.ts:687](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L687) +[packages/core/src/generation.ts:734](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L734) diff --git a/docs/api/functions/generateImage.md b/docs/api/functions/generateImage.md index a9c1e1a1777..46e5cd1eb94 100644 --- a/docs/api/functions/generateImage.md +++ b/docs/api/functions/generateImage.md @@ -34,4 +34,4 @@ ## Defined in -[packages/core/src/generation.ts:603](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L603) +[packages/core/src/generation.ts:650](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L650) diff --git a/docs/api/functions/generateMessageResponse.md b/docs/api/functions/generateMessageResponse.md index 85b0928fa72..9dd4cce26d0 100644 --- a/docs/api/functions/generateMessageResponse.md +++ b/docs/api/functions/generateMessageResponse.md @@ -26,4 +26,4 @@ The completed message. ## Defined in -[packages/core/src/generation.ts:565](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L565) +[packages/core/src/generation.ts:612](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L612) diff --git a/docs/api/functions/generateObject.md b/docs/api/functions/generateObject.md index e9b3a2c465e..b40e7691d8d 100644 --- a/docs/api/functions/generateObject.md +++ b/docs/api/functions/generateObject.md @@ -18,4 +18,4 @@ ## Defined in -[packages/core/src/generation.ts:481](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L481) +[packages/core/src/generation.ts:528](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L528) diff --git a/docs/api/functions/generateObjectArray.md b/docs/api/functions/generateObjectArray.md index c44e775c0e6..3ae3637470a 100644 --- a/docs/api/functions/generateObjectArray.md +++ b/docs/api/functions/generateObjectArray.md @@ -18,4 +18,4 @@ ## Defined in -[packages/core/src/generation.ts:517](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L517) +[packages/core/src/generation.ts:564](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L564) diff --git a/docs/api/functions/generateShouldRespond.md b/docs/api/functions/generateShouldRespond.md index ec91ac062bd..ebff3faf730 100644 --- a/docs/api/functions/generateShouldRespond.md +++ b/docs/api/functions/generateShouldRespond.md @@ -26,4 +26,4 @@ Promise resolving to "RESPOND", "IGNORE", "STOP" or null ## Defined in -[packages/core/src/generation.ts:289](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L289) +[packages/core/src/generation.ts:332](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L332) diff --git a/docs/api/functions/generateText.md b/docs/api/functions/generateText.md index 18c3f1d4caf..0200c4ff4b1 100644 --- a/docs/api/functions/generateText.md +++ b/docs/api/functions/generateText.md @@ -30,4 +30,4 @@ The completed message. ## Defined in -[packages/core/src/generation.ts:42](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L42) +[packages/core/src/generation.ts:43](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L43) diff --git a/docs/api/functions/generateTextArray.md b/docs/api/functions/generateTextArray.md index af9d3ce8461..18ff01cf378 100644 --- a/docs/api/functions/generateTextArray.md +++ b/docs/api/functions/generateTextArray.md @@ -26,4 +26,4 @@ Promise resolving to an array of strings parsed from the model's response ## Defined in -[packages/core/src/generation.ts:445](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L445) +[packages/core/src/generation.ts:492](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L492) diff --git a/docs/api/functions/generateTrueOrFalse.md b/docs/api/functions/generateTrueOrFalse.md index 47b0deeaf24..81931582a67 100644 --- a/docs/api/functions/generateTrueOrFalse.md +++ b/docs/api/functions/generateTrueOrFalse.md @@ -26,4 +26,4 @@ Promise resolving to a boolean value parsed from the model's response ## Defined in -[packages/core/src/generation.ts:393](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L393) +[packages/core/src/generation.ts:436](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L436) diff --git a/docs/api/functions/getEndpoint.md b/docs/api/functions/getEndpoint.md index f1289e1d35e..35d795fac68 100644 --- a/docs/api/functions/getEndpoint.md +++ b/docs/api/functions/getEndpoint.md @@ -12,4 +12,4 @@ ## Defined in -[packages/core/src/models.ts:198](https://github.com/ai16z/eliza/blob/main/packages/core/src/models.ts#L198) +[packages/core/src/models.ts:226](https://github.com/ai16z/eliza/blob/main/packages/core/src/models.ts#L226) diff --git a/docs/api/functions/getModel.md b/docs/api/functions/getModel.md index 5a6ddf3aad3..25dde72783b 100644 --- a/docs/api/functions/getModel.md +++ b/docs/api/functions/getModel.md @@ -14,4 +14,4 @@ ## Defined in -[packages/core/src/models.ts:194](https://github.com/ai16z/eliza/blob/main/packages/core/src/models.ts#L194) +[packages/core/src/models.ts:222](https://github.com/ai16z/eliza/blob/main/packages/core/src/models.ts#L222) diff --git a/docs/api/functions/loadEnvConfig.md b/docs/api/functions/loadEnvConfig.md new file mode 100644 index 00000000000..4270ac0abf7 --- /dev/null +++ b/docs/api/functions/loadEnvConfig.md @@ -0,0 +1,19 @@ +# Function: loadEnvConfig() + +> **loadEnvConfig**(): `ProcessEnv` + +Loads environment variables from the nearest .env file + +## Returns + +`ProcessEnv` + +Environment variables object + +## Throws + +If no .env file is found + +## Defined in + +[packages/core/src/settings.ts:36](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L36) diff --git a/docs/api/functions/retrieveCachedEmbedding.md b/docs/api/functions/retrieveCachedEmbedding.md index daedbc6e05a..0ed3f0994d6 100644 --- a/docs/api/functions/retrieveCachedEmbedding.md +++ b/docs/api/functions/retrieveCachedEmbedding.md @@ -14,4 +14,4 @@ ## Defined in -[packages/core/src/embedding.ts:80](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L80) +[packages/core/src/embedding.ts:124](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L124) diff --git a/docs/api/functions/splitChunks.md b/docs/api/functions/splitChunks.md index d2d7dfd536b..49014523e77 100644 --- a/docs/api/functions/splitChunks.md +++ b/docs/api/functions/splitChunks.md @@ -30,4 +30,4 @@ Promise resolving to array of text chunks with bleed sections ## Defined in -[packages/core/src/generation.ts:345](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L345) +[packages/core/src/generation.ts:388](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L388) diff --git a/docs/api/functions/trimTokens.md b/docs/api/functions/trimTokens.md index bdcd11550a8..6c77789d949 100644 --- a/docs/api/functions/trimTokens.md +++ b/docs/api/functions/trimTokens.md @@ -22,4 +22,4 @@ The model to use for generateText. ## Defined in -[packages/core/src/generation.ts:263](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L263) +[packages/core/src/generation.ts:306](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L306) diff --git a/docs/api/index.md b/docs/api/index.md index 3457fad7e5f..3d3b90ecee6 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -107,3 +107,5 @@ - [getRelationship](functions/getRelationship.md) - [getRelationships](functions/getRelationships.md) - [formatRelationships](functions/formatRelationships.md) +- [findNearestEnvFile](functions/findNearestEnvFile.md) +- [loadEnvConfig](functions/loadEnvConfig.md) diff --git a/docs/api/interfaces/Account.md b/docs/api/interfaces/Account.md index 7ba7b865832..374fd8691a0 100644 --- a/docs/api/interfaces/Account.md +++ b/docs/api/interfaces/Account.md @@ -10,9 +10,9 @@ Represents a user, including their name, details, and a unique identifier. #### Defined in -[packages/core/src/types.ts:270](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L270) +[packages/core/src/types.ts:273](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L273) ---- +*** ### name @@ -20,9 +20,9 @@ Represents a user, including their name, details, and a unique identifier. #### Defined in -[packages/core/src/types.ts:271](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L271) +[packages/core/src/types.ts:274](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L274) ---- +*** ### username @@ -30,9 +30,9 @@ Represents a user, including their name, details, and a unique identifier. #### Defined in -[packages/core/src/types.ts:272](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L272) +[packages/core/src/types.ts:275](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L275) ---- +*** ### details? @@ -40,13 +40,13 @@ Represents a user, including their name, details, and a unique identifier. #### Index Signature -\[`key`: `string`\]: `any` + \[`key`: `string`\]: `any` #### Defined in -[packages/core/src/types.ts:273](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L273) +[packages/core/src/types.ts:276](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L276) ---- +*** ### email? @@ -54,9 +54,9 @@ Represents a user, including their name, details, and a unique identifier. #### Defined in -[packages/core/src/types.ts:274](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L274) +[packages/core/src/types.ts:277](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L277) ---- +*** ### avatarUrl? @@ -64,4 +64,4 @@ Represents a user, including their name, details, and a unique identifier. #### Defined in -[packages/core/src/types.ts:275](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L275) +[packages/core/src/types.ts:278](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L278) diff --git a/docs/api/interfaces/Action.md b/docs/api/interfaces/Action.md index b1582ead136..a85ddb640e3 100644 --- a/docs/api/interfaces/Action.md +++ b/docs/api/interfaces/Action.md @@ -10,9 +10,9 @@ Represents an action that the agent can perform, including conditions for its us #### Defined in -[packages/core/src/types.ts:213](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L213) +[packages/core/src/types.ts:215](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L215) ---- +*** ### description @@ -20,9 +20,9 @@ Represents an action that the agent can perform, including conditions for its us #### Defined in -[packages/core/src/types.ts:214](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L214) +[packages/core/src/types.ts:216](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L216) ---- +*** ### examples @@ -30,9 +30,9 @@ Represents an action that the agent can perform, including conditions for its us #### Defined in -[packages/core/src/types.ts:215](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L215) +[packages/core/src/types.ts:217](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L217) ---- +*** ### handler @@ -40,9 +40,9 @@ Represents an action that the agent can perform, including conditions for its us #### Defined in -[packages/core/src/types.ts:216](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L216) +[packages/core/src/types.ts:218](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L218) ---- +*** ### name @@ -50,9 +50,9 @@ Represents an action that the agent can perform, including conditions for its us #### Defined in -[packages/core/src/types.ts:217](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L217) +[packages/core/src/types.ts:219](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L219) ---- +*** ### validate @@ -60,4 +60,4 @@ Represents an action that the agent can perform, including conditions for its us #### Defined in -[packages/core/src/types.ts:218](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L218) +[packages/core/src/types.ts:220](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L220) diff --git a/docs/api/interfaces/ActionExample.md b/docs/api/interfaces/ActionExample.md index d40b09037d9..f440b1b6e0a 100644 --- a/docs/api/interfaces/ActionExample.md +++ b/docs/api/interfaces/ActionExample.md @@ -12,7 +12,7 @@ Represents an example of content, typically used for demonstrating or testing pu [packages/core/src/types.ts:25](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L25) ---- +*** ### content diff --git a/docs/api/interfaces/Actor.md b/docs/api/interfaces/Actor.md index 03de7ecc58b..7ee1752893b 100644 --- a/docs/api/interfaces/Actor.md +++ b/docs/api/interfaces/Actor.md @@ -12,7 +12,7 @@ Represents an actor in the conversation, which could be a user or the agent itse [packages/core/src/types.ts:41](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L41) ---- +*** ### username @@ -22,7 +22,7 @@ Represents an actor in the conversation, which could be a user or the agent itse [packages/core/src/types.ts:42](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L42) ---- +*** ### details @@ -44,7 +44,7 @@ Represents an actor in the conversation, which could be a user or the agent itse [packages/core/src/types.ts:43](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L43) ---- +*** ### id diff --git a/docs/api/interfaces/Content.md b/docs/api/interfaces/Content.md index 72c031b7621..aabeddbc9fb 100644 --- a/docs/api/interfaces/Content.md +++ b/docs/api/interfaces/Content.md @@ -4,7 +4,7 @@ Represents the content of a message, including its main text (`content`), any as ## Indexable -\[`key`: `string`\]: `unknown` + \[`key`: `string`\]: `unknown` ## Properties @@ -16,7 +16,7 @@ Represents the content of a message, including its main text (`content`), any as [packages/core/src/types.ts:12](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L12) ---- +*** ### action? @@ -26,7 +26,7 @@ Represents the content of a message, including its main text (`content`), any as [packages/core/src/types.ts:13](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L13) ---- +*** ### source? @@ -36,7 +36,7 @@ Represents the content of a message, including its main text (`content`), any as [packages/core/src/types.ts:14](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L14) ---- +*** ### url? @@ -46,7 +46,7 @@ Represents the content of a message, including its main text (`content`), any as [packages/core/src/types.ts:15](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L15) ---- +*** ### inReplyTo? @@ -56,7 +56,7 @@ Represents the content of a message, including its main text (`content`), any as [packages/core/src/types.ts:16](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L16) ---- +*** ### attachments? diff --git a/docs/api/interfaces/ConversationExample.md b/docs/api/interfaces/ConversationExample.md index 8b3c751349b..60269208e8a 100644 --- a/docs/api/interfaces/ConversationExample.md +++ b/docs/api/interfaces/ConversationExample.md @@ -12,7 +12,7 @@ Represents an example of content, typically used for demonstrating or testing pu [packages/core/src/types.ts:33](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L33) ---- +*** ### content diff --git a/docs/api/interfaces/EvaluationExample.md b/docs/api/interfaces/EvaluationExample.md index 66fa32f81bb..3df1b7c9af2 100644 --- a/docs/api/interfaces/EvaluationExample.md +++ b/docs/api/interfaces/EvaluationExample.md @@ -10,9 +10,9 @@ Represents an example for evaluation, including the context, an array of message #### Defined in -[packages/core/src/types.ts:225](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L225) +[packages/core/src/types.ts:227](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L227) ---- +*** ### messages @@ -20,9 +20,9 @@ Represents an example for evaluation, including the context, an array of message #### Defined in -[packages/core/src/types.ts:226](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L226) +[packages/core/src/types.ts:228](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L228) ---- +*** ### outcome @@ -30,4 +30,4 @@ Represents an example for evaluation, including the context, an array of message #### Defined in -[packages/core/src/types.ts:227](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L227) +[packages/core/src/types.ts:229](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L229) diff --git a/docs/api/interfaces/Evaluator.md b/docs/api/interfaces/Evaluator.md index 8f116317be3..1fa25b62c1b 100644 --- a/docs/api/interfaces/Evaluator.md +++ b/docs/api/interfaces/Evaluator.md @@ -4,15 +4,25 @@ Represents an evaluator, which is used to assess and guide the agent's responses ## Properties +### alwaysRun? + +> `optional` **alwaysRun**: `boolean` + +#### Defined in + +[packages/core/src/types.ts:236](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L236) + +*** + ### description > **description**: `string` #### Defined in -[packages/core/src/types.ts:234](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L234) +[packages/core/src/types.ts:237](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L237) ---- +*** ### similes @@ -20,9 +30,9 @@ Represents an evaluator, which is used to assess and guide the agent's responses #### Defined in -[packages/core/src/types.ts:235](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L235) +[packages/core/src/types.ts:238](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L238) ---- +*** ### examples @@ -30,9 +40,9 @@ Represents an evaluator, which is used to assess and guide the agent's responses #### Defined in -[packages/core/src/types.ts:236](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L236) +[packages/core/src/types.ts:239](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L239) ---- +*** ### handler @@ -40,9 +50,9 @@ Represents an evaluator, which is used to assess and guide the agent's responses #### Defined in -[packages/core/src/types.ts:237](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L237) +[packages/core/src/types.ts:240](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L240) ---- +*** ### name @@ -50,9 +60,9 @@ Represents an evaluator, which is used to assess and guide the agent's responses #### Defined in -[packages/core/src/types.ts:238](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L238) +[packages/core/src/types.ts:241](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L241) ---- +*** ### validate @@ -60,4 +70,4 @@ Represents an evaluator, which is used to assess and guide the agent's responses #### Defined in -[packages/core/src/types.ts:239](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L239) +[packages/core/src/types.ts:242](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L242) diff --git a/docs/api/interfaces/Goal.md b/docs/api/interfaces/Goal.md index f1a01466980..922f05ac81c 100644 --- a/docs/api/interfaces/Goal.md +++ b/docs/api/interfaces/Goal.md @@ -12,7 +12,7 @@ Represents a goal, which is a higher-level aim composed of one or more objective [packages/core/src/types.ts:66](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L66) ---- +*** ### roomId @@ -22,7 +22,7 @@ Represents a goal, which is a higher-level aim composed of one or more objective [packages/core/src/types.ts:67](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L67) ---- +*** ### userId @@ -32,7 +32,7 @@ Represents a goal, which is a higher-level aim composed of one or more objective [packages/core/src/types.ts:68](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L68) ---- +*** ### name @@ -42,7 +42,7 @@ Represents a goal, which is a higher-level aim composed of one or more objective [packages/core/src/types.ts:69](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L69) ---- +*** ### status @@ -52,7 +52,7 @@ Represents a goal, which is a higher-level aim composed of one or more objective [packages/core/src/types.ts:70](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L70) ---- +*** ### objectives diff --git a/docs/api/interfaces/IAgentRuntime.md b/docs/api/interfaces/IAgentRuntime.md index 03941a9bc1c..dbe4136d58e 100644 --- a/docs/api/interfaces/IAgentRuntime.md +++ b/docs/api/interfaces/IAgentRuntime.md @@ -8,9 +8,9 @@ #### Defined in -[packages/core/src/types.ts:517](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L517) +[packages/core/src/types.ts:520](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L520) ---- +*** ### serverUrl @@ -18,9 +18,9 @@ #### Defined in -[packages/core/src/types.ts:518](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L518) +[packages/core/src/types.ts:521](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L521) ---- +*** ### databaseAdapter @@ -28,9 +28,9 @@ #### Defined in -[packages/core/src/types.ts:519](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L519) +[packages/core/src/types.ts:522](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L522) ---- +*** ### token @@ -38,9 +38,9 @@ #### Defined in -[packages/core/src/types.ts:520](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L520) +[packages/core/src/types.ts:523](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L523) ---- +*** ### modelProvider @@ -48,9 +48,9 @@ #### Defined in -[packages/core/src/types.ts:521](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L521) +[packages/core/src/types.ts:524](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L524) ---- +*** ### character @@ -58,9 +58,9 @@ #### Defined in -[packages/core/src/types.ts:522](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L522) +[packages/core/src/types.ts:525](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L525) ---- +*** ### providers @@ -68,9 +68,9 @@ #### Defined in -[packages/core/src/types.ts:523](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L523) +[packages/core/src/types.ts:526](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L526) ---- +*** ### actions @@ -78,9 +78,9 @@ #### Defined in -[packages/core/src/types.ts:524](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L524) +[packages/core/src/types.ts:527](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L527) ---- +*** ### evaluators @@ -88,9 +88,9 @@ #### Defined in -[packages/core/src/types.ts:525](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L525) +[packages/core/src/types.ts:528](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L528) ---- +*** ### messageManager @@ -98,9 +98,9 @@ #### Defined in -[packages/core/src/types.ts:527](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L527) +[packages/core/src/types.ts:530](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L530) ---- +*** ### descriptionManager @@ -108,9 +108,9 @@ #### Defined in -[packages/core/src/types.ts:528](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L528) +[packages/core/src/types.ts:531](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L531) ---- +*** ### loreManager @@ -118,9 +118,9 @@ #### Defined in -[packages/core/src/types.ts:529](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L529) +[packages/core/src/types.ts:532](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L532) ---- +*** ### services @@ -128,7 +128,7 @@ #### Defined in -[packages/core/src/types.ts:531](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L531) +[packages/core/src/types.ts:534](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L534) ## Methods @@ -146,9 +146,9 @@ #### Defined in -[packages/core/src/types.ts:532](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L532) +[packages/core/src/types.ts:535](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L535) ---- +*** ### getMemoryManager() @@ -164,9 +164,9 @@ #### Defined in -[packages/core/src/types.ts:534](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L534) +[packages/core/src/types.ts:537](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L537) ---- +*** ### getService() @@ -186,9 +186,9 @@ #### Defined in -[packages/core/src/types.ts:536](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L536) +[packages/core/src/types.ts:539](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L539) ---- +*** ### registerService() @@ -204,9 +204,9 @@ #### Defined in -[packages/core/src/types.ts:538](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L538) +[packages/core/src/types.ts:541](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L541) ---- +*** ### getSetting() @@ -222,9 +222,9 @@ #### Defined in -[packages/core/src/types.ts:540](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L540) +[packages/core/src/types.ts:543](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L543) ---- +*** ### getConversationLength() @@ -236,9 +236,9 @@ #### Defined in -[packages/core/src/types.ts:543](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L543) +[packages/core/src/types.ts:546](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L546) ---- +*** ### processActions() @@ -260,13 +260,13 @@ #### Defined in -[packages/core/src/types.ts:544](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L544) +[packages/core/src/types.ts:547](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L547) ---- +*** ### evaluate() -> **evaluate**(`message`, `state`?): `Promise`\<`string`[]\> +> **evaluate**(`message`, `state`?, `didRespond`?): `Promise`\<`string`[]\> #### Parameters @@ -274,15 +274,17 @@ • **state?**: [`State`](State.md) +• **didRespond?**: `boolean` + #### Returns `Promise`\<`string`[]\> #### Defined in -[packages/core/src/types.ts:550](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L550) +[packages/core/src/types.ts:553](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L553) ---- +*** ### ensureParticipantExists() @@ -300,9 +302,9 @@ #### Defined in -[packages/core/src/types.ts:551](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L551) +[packages/core/src/types.ts:558](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L558) ---- +*** ### ensureUserExists() @@ -324,9 +326,9 @@ #### Defined in -[packages/core/src/types.ts:552](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L552) +[packages/core/src/types.ts:559](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L559) ---- +*** ### registerAction() @@ -342,9 +344,9 @@ #### Defined in -[packages/core/src/types.ts:558](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L558) +[packages/core/src/types.ts:565](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L565) ---- +*** ### ensureConnection() @@ -368,9 +370,9 @@ #### Defined in -[packages/core/src/types.ts:559](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L559) +[packages/core/src/types.ts:566](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L566) ---- +*** ### ensureParticipantInRoom() @@ -388,9 +390,9 @@ #### Defined in -[packages/core/src/types.ts:566](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L566) +[packages/core/src/types.ts:573](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L573) ---- +*** ### ensureRoomExists() @@ -406,9 +408,9 @@ #### Defined in -[packages/core/src/types.ts:567](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L567) +[packages/core/src/types.ts:574](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L574) ---- +*** ### composeState() @@ -426,9 +428,9 @@ #### Defined in -[packages/core/src/types.ts:568](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L568) +[packages/core/src/types.ts:575](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L575) ---- +*** ### updateRecentMessageState() @@ -444,4 +446,4 @@ #### Defined in -[packages/core/src/types.ts:572](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L572) +[packages/core/src/types.ts:579](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L579) diff --git a/docs/api/interfaces/IBrowserService.md b/docs/api/interfaces/IBrowserService.md index 8cc7f524a02..0fe168d1861 100644 --- a/docs/api/interfaces/IBrowserService.md +++ b/docs/api/interfaces/IBrowserService.md @@ -16,9 +16,9 @@ #### Defined in -[packages/core/src/types.ts:621](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L621) +[packages/core/src/types.ts:629](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L629) ---- +*** ### closeBrowser() @@ -30,9 +30,9 @@ #### Defined in -[packages/core/src/types.ts:622](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L622) +[packages/core/src/types.ts:630](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L630) ---- +*** ### getPageContent() @@ -62,4 +62,4 @@ #### Defined in -[packages/core/src/types.ts:623](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L623) +[packages/core/src/types.ts:631](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L631) diff --git a/docs/api/interfaces/IDatabaseAdapter.md b/docs/api/interfaces/IDatabaseAdapter.md index 63af51a63c7..52dd92ab7b1 100644 --- a/docs/api/interfaces/IDatabaseAdapter.md +++ b/docs/api/interfaces/IDatabaseAdapter.md @@ -8,7 +8,7 @@ #### Defined in -[packages/core/src/types.ts:360](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L360) +[packages/core/src/types.ts:363](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L363) ## Methods @@ -26,9 +26,9 @@ #### Defined in -[packages/core/src/types.ts:361](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L361) +[packages/core/src/types.ts:364](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L364) ---- +*** ### createAccount() @@ -44,9 +44,9 @@ #### Defined in -[packages/core/src/types.ts:362](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L362) +[packages/core/src/types.ts:365](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L365) ---- +*** ### getMemories() @@ -76,9 +76,9 @@ #### Defined in -[packages/core/src/types.ts:363](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L363) +[packages/core/src/types.ts:366](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L366) ---- +*** ### getMemoryById() @@ -94,9 +94,9 @@ #### Defined in -[packages/core/src/types.ts:372](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L372) +[packages/core/src/types.ts:375](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L375) ---- +*** ### getMemoriesByRoomIds() @@ -116,9 +116,9 @@ #### Defined in -[packages/core/src/types.ts:373](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L373) +[packages/core/src/types.ts:376](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L376) ---- +*** ### getCachedEmbeddings() @@ -128,17 +128,17 @@ • **params** -• **params.query_table_name**: `string` +• **params.query\_table\_name**: `string` -• **params.query_threshold**: `number` +• **params.query\_threshold**: `number` -• **params.query_input**: `string` +• **params.query\_input**: `string` -• **params.query_field_name**: `string` +• **params.query\_field\_name**: `string` -• **params.query_field_sub_name**: `string` +• **params.query\_field\_sub\_name**: `string` -• **params.query_match_count**: `number` +• **params.query\_match\_count**: `number` #### Returns @@ -146,9 +146,9 @@ #### Defined in -[packages/core/src/types.ts:377](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L377) +[packages/core/src/types.ts:380](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L380) ---- +*** ### log() @@ -172,9 +172,9 @@ #### Defined in -[packages/core/src/types.ts:385](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L385) +[packages/core/src/types.ts:388](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L388) ---- +*** ### getActorDetails() @@ -192,9 +192,9 @@ #### Defined in -[packages/core/src/types.ts:391](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L391) +[packages/core/src/types.ts:394](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L394) ---- +*** ### searchMemories() @@ -210,9 +210,9 @@ • **params.embedding**: `number`[] -• **params.match_threshold**: `number` +• **params.match\_threshold**: `number` -• **params.match_count**: `number` +• **params.match\_count**: `number` • **params.unique**: `boolean` @@ -222,9 +222,9 @@ #### Defined in -[packages/core/src/types.ts:392](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L392) +[packages/core/src/types.ts:395](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L395) ---- +*** ### updateGoalStatus() @@ -244,9 +244,9 @@ #### Defined in -[packages/core/src/types.ts:400](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L400) +[packages/core/src/types.ts:403](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L403) ---- +*** ### searchMemoriesByEmbedding() @@ -258,7 +258,7 @@ • **params** -• **params.match_threshold?**: `number` +• **params.match\_threshold?**: `number` • **params.count?**: `number` @@ -276,9 +276,9 @@ #### Defined in -[packages/core/src/types.ts:404](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L404) +[packages/core/src/types.ts:407](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L407) ---- +*** ### createMemory() @@ -298,9 +298,9 @@ #### Defined in -[packages/core/src/types.ts:415](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L415) +[packages/core/src/types.ts:418](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L418) ---- +*** ### removeMemory() @@ -318,9 +318,9 @@ #### Defined in -[packages/core/src/types.ts:420](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L420) +[packages/core/src/types.ts:423](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L423) ---- +*** ### removeAllMemories() @@ -338,9 +338,9 @@ #### Defined in -[packages/core/src/types.ts:421](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L421) +[packages/core/src/types.ts:424](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L424) ---- +*** ### countMemories() @@ -360,9 +360,9 @@ #### Defined in -[packages/core/src/types.ts:422](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L422) +[packages/core/src/types.ts:425](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L425) ---- +*** ### getGoals() @@ -386,9 +386,9 @@ #### Defined in -[packages/core/src/types.ts:427](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L427) +[packages/core/src/types.ts:430](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L430) ---- +*** ### updateGoal() @@ -404,9 +404,9 @@ #### Defined in -[packages/core/src/types.ts:433](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L433) +[packages/core/src/types.ts:436](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L436) ---- +*** ### createGoal() @@ -422,9 +422,9 @@ #### Defined in -[packages/core/src/types.ts:434](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L434) +[packages/core/src/types.ts:437](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L437) ---- +*** ### removeGoal() @@ -440,9 +440,9 @@ #### Defined in -[packages/core/src/types.ts:435](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L435) +[packages/core/src/types.ts:438](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L438) ---- +*** ### removeAllGoals() @@ -458,9 +458,9 @@ #### Defined in -[packages/core/src/types.ts:436](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L436) +[packages/core/src/types.ts:439](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L439) ---- +*** ### getRoom() @@ -476,9 +476,9 @@ #### Defined in -[packages/core/src/types.ts:437](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L437) +[packages/core/src/types.ts:440](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L440) ---- +*** ### createRoom() @@ -494,9 +494,9 @@ #### Defined in -[packages/core/src/types.ts:438](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L438) +[packages/core/src/types.ts:441](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L441) ---- +*** ### removeRoom() @@ -512,9 +512,9 @@ #### Defined in -[packages/core/src/types.ts:439](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L439) +[packages/core/src/types.ts:442](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L442) ---- +*** ### getRoomsForParticipant() @@ -530,9 +530,9 @@ #### Defined in -[packages/core/src/types.ts:440](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L440) +[packages/core/src/types.ts:443](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L443) ---- +*** ### getRoomsForParticipants() @@ -548,9 +548,9 @@ #### Defined in -[packages/core/src/types.ts:441](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L441) +[packages/core/src/types.ts:444](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L444) ---- +*** ### addParticipant() @@ -568,9 +568,9 @@ #### Defined in -[packages/core/src/types.ts:442](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L442) +[packages/core/src/types.ts:445](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L445) ---- +*** ### removeParticipant() @@ -588,9 +588,9 @@ #### Defined in -[packages/core/src/types.ts:443](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L443) +[packages/core/src/types.ts:446](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L446) ---- +*** ### getParticipantsForAccount() @@ -606,9 +606,9 @@ #### Defined in -[packages/core/src/types.ts:444](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L444) +[packages/core/src/types.ts:447](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L447) ---- +*** ### getParticipantsForRoom() @@ -624,9 +624,9 @@ #### Defined in -[packages/core/src/types.ts:445](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L445) +[packages/core/src/types.ts:448](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L448) ---- +*** ### getParticipantUserState() @@ -644,9 +644,9 @@ #### Defined in -[packages/core/src/types.ts:446](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L446) +[packages/core/src/types.ts:449](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L449) ---- +*** ### setParticipantUserState() @@ -666,9 +666,9 @@ #### Defined in -[packages/core/src/types.ts:450](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L450) +[packages/core/src/types.ts:453](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L453) ---- +*** ### createRelationship() @@ -688,9 +688,9 @@ #### Defined in -[packages/core/src/types.ts:455](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L455) +[packages/core/src/types.ts:458](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L458) ---- +*** ### getRelationship() @@ -710,9 +710,9 @@ #### Defined in -[packages/core/src/types.ts:456](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L456) +[packages/core/src/types.ts:459](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L459) ---- +*** ### getRelationships() @@ -730,4 +730,4 @@ #### Defined in -[packages/core/src/types.ts:460](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L460) +[packages/core/src/types.ts:463](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L463) diff --git a/docs/api/interfaces/IImageDescriptionService.md b/docs/api/interfaces/IImageDescriptionService.md index 1d5ada4972a..6db14deaa55 100644 --- a/docs/api/interfaces/IImageDescriptionService.md +++ b/docs/api/interfaces/IImageDescriptionService.md @@ -6,6 +6,20 @@ ## Methods +### getInstance() + +> **getInstance**(): [`IImageDescriptionService`](IImageDescriptionService.md) + +#### Returns + +[`IImageDescriptionService`](IImageDescriptionService.md) + +#### Defined in + +[packages/core/src/types.ts:583](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L583) + +*** + ### initialize() > **initialize**(`modelId`?, `device`?): `Promise`\<`void`\> @@ -22,9 +36,9 @@ #### Defined in -[packages/core/src/types.ts:576](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L576) +[packages/core/src/types.ts:584](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L584) ---- +*** ### describeImage() @@ -48,4 +62,4 @@ #### Defined in -[packages/core/src/types.ts:577](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L577) +[packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) diff --git a/docs/api/interfaces/IMemoryManager.md b/docs/api/interfaces/IMemoryManager.md index b162e6d08b0..a9396a7ceca 100644 --- a/docs/api/interfaces/IMemoryManager.md +++ b/docs/api/interfaces/IMemoryManager.md @@ -8,9 +8,9 @@ #### Defined in -[packages/core/src/types.ts:464](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L464) +[packages/core/src/types.ts:467](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L467) ---- +*** ### tableName @@ -18,9 +18,9 @@ #### Defined in -[packages/core/src/types.ts:465](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L465) +[packages/core/src/types.ts:468](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L468) ---- +*** ### constructor @@ -28,7 +28,7 @@ #### Defined in -[packages/core/src/types.ts:467](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L467) +[packages/core/src/types.ts:470](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L470) ## Methods @@ -46,9 +46,9 @@ #### Defined in -[packages/core/src/types.ts:469](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L469) +[packages/core/src/types.ts:472](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L472) ---- +*** ### getMemories() @@ -76,9 +76,9 @@ #### Defined in -[packages/core/src/types.ts:470](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L470) +[packages/core/src/types.ts:473](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L473) ---- +*** ### getCachedEmbeddings() @@ -94,9 +94,9 @@ #### Defined in -[packages/core/src/types.ts:478](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L478) +[packages/core/src/types.ts:481](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L481) ---- +*** ### getMemoryById() @@ -112,9 +112,9 @@ #### Defined in -[packages/core/src/types.ts:481](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L481) +[packages/core/src/types.ts:484](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L484) ---- +*** ### getMemoriesByRoomIds() @@ -134,9 +134,9 @@ #### Defined in -[packages/core/src/types.ts:482](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L482) +[packages/core/src/types.ts:485](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L485) ---- +*** ### searchMemoriesByEmbedding() @@ -148,7 +148,7 @@ • **opts** -• **opts.match_threshold?**: `number` +• **opts.match\_threshold?**: `number` • **opts.count?**: `number` @@ -164,9 +164,9 @@ #### Defined in -[packages/core/src/types.ts:486](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L486) +[packages/core/src/types.ts:489](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L489) ---- +*** ### createMemory() @@ -184,9 +184,9 @@ #### Defined in -[packages/core/src/types.ts:496](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L496) +[packages/core/src/types.ts:499](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L499) ---- +*** ### removeMemory() @@ -202,9 +202,9 @@ #### Defined in -[packages/core/src/types.ts:497](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L497) +[packages/core/src/types.ts:500](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L500) ---- +*** ### removeAllMemories() @@ -220,9 +220,9 @@ #### Defined in -[packages/core/src/types.ts:498](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L498) +[packages/core/src/types.ts:501](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L501) ---- +*** ### countMemories() @@ -240,4 +240,4 @@ #### Defined in -[packages/core/src/types.ts:499](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L499) +[packages/core/src/types.ts:502](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L502) diff --git a/docs/api/interfaces/IPdfService.md b/docs/api/interfaces/IPdfService.md index 754a6670515..f102ed2c988 100644 --- a/docs/api/interfaces/IPdfService.md +++ b/docs/api/interfaces/IPdfService.md @@ -20,4 +20,4 @@ #### Defined in -[packages/core/src/types.ts:634](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L634) +[packages/core/src/types.ts:642](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L642) diff --git a/docs/api/interfaces/ISpeechService.md b/docs/api/interfaces/ISpeechService.md index 4b5493fdf18..44d836625c1 100644 --- a/docs/api/interfaces/ISpeechService.md +++ b/docs/api/interfaces/ISpeechService.md @@ -22,4 +22,4 @@ #### Defined in -[packages/core/src/types.ts:630](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L630) +[packages/core/src/types.ts:638](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L638) diff --git a/docs/api/interfaces/ITextGenerationService.md b/docs/api/interfaces/ITextGenerationService.md index 2044dbcc975..e764a1b6dfd 100644 --- a/docs/api/interfaces/ITextGenerationService.md +++ b/docs/api/interfaces/ITextGenerationService.md @@ -16,9 +16,9 @@ #### Defined in -[packages/core/src/types.ts:599](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L599) +[packages/core/src/types.ts:607](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L607) ---- +*** ### initializeModel() @@ -30,9 +30,9 @@ #### Defined in -[packages/core/src/types.ts:600](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L600) +[packages/core/src/types.ts:608](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L608) ---- +*** ### queueMessageCompletion() @@ -46,11 +46,11 @@ • **stop**: `string`[] -• **frequency_penalty**: `number` +• **frequency\_penalty**: `number` -• **presence_penalty**: `number` +• **presence\_penalty**: `number` -• **max_tokens**: `number` +• **max\_tokens**: `number` #### Returns @@ -58,9 +58,9 @@ #### Defined in -[packages/core/src/types.ts:601](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L601) +[packages/core/src/types.ts:609](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L609) ---- +*** ### queueTextCompletion() @@ -74,11 +74,11 @@ • **stop**: `string`[] -• **frequency_penalty**: `number` +• **frequency\_penalty**: `number` -• **presence_penalty**: `number` +• **presence\_penalty**: `number` -• **max_tokens**: `number` +• **max\_tokens**: `number` #### Returns @@ -86,9 +86,9 @@ #### Defined in -[packages/core/src/types.ts:609](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L609) +[packages/core/src/types.ts:617](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L617) ---- +*** ### getEmbeddingResponse() @@ -104,4 +104,4 @@ #### Defined in -[packages/core/src/types.ts:617](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L617) +[packages/core/src/types.ts:625](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L625) diff --git a/docs/api/interfaces/ITranscriptionService.md b/docs/api/interfaces/ITranscriptionService.md index b677e43a37a..f3387456f17 100644 --- a/docs/api/interfaces/ITranscriptionService.md +++ b/docs/api/interfaces/ITranscriptionService.md @@ -20,9 +20,9 @@ #### Defined in -[packages/core/src/types.ts:583](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L583) +[packages/core/src/types.ts:591](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L591) ---- +*** ### transcribeAttachmentLocally() @@ -38,9 +38,9 @@ #### Defined in -[packages/core/src/types.ts:584](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L584) +[packages/core/src/types.ts:592](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L592) ---- +*** ### transcribe() @@ -56,9 +56,9 @@ #### Defined in -[packages/core/src/types.ts:587](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L587) +[packages/core/src/types.ts:595](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L595) ---- +*** ### transcribeLocally() @@ -74,4 +74,4 @@ #### Defined in -[packages/core/src/types.ts:588](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L588) +[packages/core/src/types.ts:596](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L596) diff --git a/docs/api/interfaces/IVideoService.md b/docs/api/interfaces/IVideoService.md index bf89a9730a2..3e02c68920f 100644 --- a/docs/api/interfaces/IVideoService.md +++ b/docs/api/interfaces/IVideoService.md @@ -20,9 +20,9 @@ #### Defined in -[packages/core/src/types.ts:592](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L592) +[packages/core/src/types.ts:600](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L600) ---- +*** ### processVideo() @@ -38,9 +38,9 @@ #### Defined in -[packages/core/src/types.ts:593](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L593) +[packages/core/src/types.ts:601](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L601) ---- +*** ### fetchVideoInfo() @@ -56,9 +56,9 @@ #### Defined in -[packages/core/src/types.ts:594](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L594) +[packages/core/src/types.ts:602](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L602) ---- +*** ### downloadVideo() @@ -74,4 +74,4 @@ #### Defined in -[packages/core/src/types.ts:595](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L595) +[packages/core/src/types.ts:603](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L603) diff --git a/docs/api/interfaces/Memory.md b/docs/api/interfaces/Memory.md index bd158bd5bbc..a073a7f4c2e 100644 --- a/docs/api/interfaces/Memory.md +++ b/docs/api/interfaces/Memory.md @@ -10,9 +10,9 @@ Represents a memory record, which could be a message or any other piece of infor #### Defined in -[packages/core/src/types.ts:165](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L165) +[packages/core/src/types.ts:167](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L167) ---- +*** ### userId @@ -20,9 +20,9 @@ Represents a memory record, which could be a message or any other piece of infor #### Defined in -[packages/core/src/types.ts:166](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L166) +[packages/core/src/types.ts:168](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L168) ---- +*** ### agentId @@ -30,9 +30,9 @@ Represents a memory record, which could be a message or any other piece of infor #### Defined in -[packages/core/src/types.ts:167](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L167) +[packages/core/src/types.ts:169](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L169) ---- +*** ### createdAt? @@ -40,9 +40,9 @@ Represents a memory record, which could be a message or any other piece of infor #### Defined in -[packages/core/src/types.ts:168](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L168) +[packages/core/src/types.ts:170](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L170) ---- +*** ### content @@ -50,9 +50,9 @@ Represents a memory record, which could be a message or any other piece of infor #### Defined in -[packages/core/src/types.ts:169](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L169) +[packages/core/src/types.ts:171](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L171) ---- +*** ### embedding? @@ -60,9 +60,9 @@ Represents a memory record, which could be a message or any other piece of infor #### Defined in -[packages/core/src/types.ts:170](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L170) +[packages/core/src/types.ts:172](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L172) ---- +*** ### roomId @@ -70,9 +70,9 @@ Represents a memory record, which could be a message or any other piece of infor #### Defined in -[packages/core/src/types.ts:171](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L171) +[packages/core/src/types.ts:173](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L173) ---- +*** ### unique? @@ -80,4 +80,4 @@ Represents a memory record, which could be a message or any other piece of infor #### Defined in -[packages/core/src/types.ts:172](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L172) +[packages/core/src/types.ts:174](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L174) diff --git a/docs/api/interfaces/MessageExample.md b/docs/api/interfaces/MessageExample.md index 38c188b229b..fe853bb1299 100644 --- a/docs/api/interfaces/MessageExample.md +++ b/docs/api/interfaces/MessageExample.md @@ -10,9 +10,9 @@ Represents an example of a message, typically used for demonstrating or testing #### Defined in -[packages/core/src/types.ts:179](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L179) +[packages/core/src/types.ts:181](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L181) ---- +*** ### content @@ -20,4 +20,4 @@ Represents an example of a message, typically used for demonstrating or testing #### Defined in -[packages/core/src/types.ts:180](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L180) +[packages/core/src/types.ts:182](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L182) diff --git a/docs/api/interfaces/Objective.md b/docs/api/interfaces/Objective.md index d0e01458a99..f69c8f2d3bf 100644 --- a/docs/api/interfaces/Objective.md +++ b/docs/api/interfaces/Objective.md @@ -12,7 +12,7 @@ Represents an objective within a goal, detailing what needs to be achieved and w [packages/core/src/types.ts:51](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L51) ---- +*** ### description @@ -22,7 +22,7 @@ Represents an objective within a goal, detailing what needs to be achieved and w [packages/core/src/types.ts:52](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L52) ---- +*** ### completed diff --git a/docs/api/interfaces/Participant.md b/docs/api/interfaces/Participant.md index 65fbec541e4..2f87415e518 100644 --- a/docs/api/interfaces/Participant.md +++ b/docs/api/interfaces/Participant.md @@ -10,9 +10,9 @@ Represents a participant in a room, including their ID and account details. #### Defined in -[packages/core/src/types.ts:282](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L282) +[packages/core/src/types.ts:285](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L285) ---- +*** ### account @@ -20,4 +20,4 @@ Represents a participant in a room, including their ID and account details. #### Defined in -[packages/core/src/types.ts:283](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L283) +[packages/core/src/types.ts:286](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L286) diff --git a/docs/api/interfaces/Provider.md b/docs/api/interfaces/Provider.md index bb22296c8cd..ad298a7f57c 100644 --- a/docs/api/interfaces/Provider.md +++ b/docs/api/interfaces/Provider.md @@ -22,4 +22,4 @@ Represents a provider, which is used to retrieve information or perform actions #### Defined in -[packages/core/src/types.ts:246](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L246) +[packages/core/src/types.ts:249](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L249) diff --git a/docs/api/interfaces/Relationship.md b/docs/api/interfaces/Relationship.md index 75950259b28..06b4968c70c 100644 --- a/docs/api/interfaces/Relationship.md +++ b/docs/api/interfaces/Relationship.md @@ -10,9 +10,9 @@ Represents a relationship between two users, including their IDs, the status of #### Defined in -[packages/core/src/types.ts:257](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L257) +[packages/core/src/types.ts:260](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L260) ---- +*** ### userA @@ -20,9 +20,9 @@ Represents a relationship between two users, including their IDs, the status of #### Defined in -[packages/core/src/types.ts:258](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L258) +[packages/core/src/types.ts:261](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L261) ---- +*** ### userB @@ -30,9 +30,9 @@ Represents a relationship between two users, including their IDs, the status of #### Defined in -[packages/core/src/types.ts:259](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L259) +[packages/core/src/types.ts:262](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L262) ---- +*** ### userId @@ -40,9 +40,9 @@ Represents a relationship between two users, including their IDs, the status of #### Defined in -[packages/core/src/types.ts:260](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L260) +[packages/core/src/types.ts:263](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L263) ---- +*** ### roomId @@ -50,9 +50,9 @@ Represents a relationship between two users, including their IDs, the status of #### Defined in -[packages/core/src/types.ts:261](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L261) +[packages/core/src/types.ts:264](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L264) ---- +*** ### status @@ -60,9 +60,9 @@ Represents a relationship between two users, including their IDs, the status of #### Defined in -[packages/core/src/types.ts:262](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L262) +[packages/core/src/types.ts:265](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L265) ---- +*** ### createdAt? @@ -70,4 +70,4 @@ Represents a relationship between two users, including their IDs, the status of #### Defined in -[packages/core/src/types.ts:263](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L263) +[packages/core/src/types.ts:266](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L266) diff --git a/docs/api/interfaces/Room.md b/docs/api/interfaces/Room.md index 2f0a5d1399f..7ffc0b8ab77 100644 --- a/docs/api/interfaces/Room.md +++ b/docs/api/interfaces/Room.md @@ -10,9 +10,9 @@ Represents a room or conversation context, including its ID and a list of partic #### Defined in -[packages/core/src/types.ts:290](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L290) +[packages/core/src/types.ts:293](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L293) ---- +*** ### participants @@ -20,4 +20,4 @@ Represents a room or conversation context, including its ID and a list of partic #### Defined in -[packages/core/src/types.ts:291](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L291) +[packages/core/src/types.ts:294](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L294) diff --git a/docs/api/interfaces/State.md b/docs/api/interfaces/State.md index 7929878ebfd..e221656aea6 100644 --- a/docs/api/interfaces/State.md +++ b/docs/api/interfaces/State.md @@ -4,7 +4,7 @@ Represents the state of the conversation or context in which the agent is operat ## Indexable -\[`key`: `string`\]: `unknown` + \[`key`: `string`\]: `unknown` ## Properties @@ -14,9 +14,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:135](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L135) +[packages/core/src/types.ts:137](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L137) ---- +*** ### agentId? @@ -24,9 +24,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:136](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L136) +[packages/core/src/types.ts:138](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L138) ---- +*** ### bio @@ -34,9 +34,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:137](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L137) +[packages/core/src/types.ts:139](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L139) ---- +*** ### lore @@ -44,9 +44,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:138](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L138) +[packages/core/src/types.ts:140](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L140) ---- +*** ### messageDirections @@ -54,9 +54,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:139](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L139) +[packages/core/src/types.ts:141](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L141) ---- +*** ### postDirections @@ -64,9 +64,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:140](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L140) +[packages/core/src/types.ts:142](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L142) ---- +*** ### roomId @@ -74,9 +74,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:141](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L141) +[packages/core/src/types.ts:143](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L143) ---- +*** ### agentName? @@ -84,9 +84,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:142](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L142) +[packages/core/src/types.ts:144](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L144) ---- +*** ### senderName? @@ -94,9 +94,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:143](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L143) +[packages/core/src/types.ts:145](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L145) ---- +*** ### actors @@ -104,9 +104,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:144](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L144) +[packages/core/src/types.ts:146](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L146) ---- +*** ### actorsData? @@ -114,9 +114,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:145](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L145) +[packages/core/src/types.ts:147](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L147) ---- +*** ### goals? @@ -124,9 +124,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:146](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L146) +[packages/core/src/types.ts:148](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L148) ---- +*** ### goalsData? @@ -134,9 +134,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:147](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L147) +[packages/core/src/types.ts:149](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L149) ---- +*** ### recentMessages @@ -144,9 +144,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:148](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L148) +[packages/core/src/types.ts:150](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L150) ---- +*** ### recentMessagesData @@ -154,9 +154,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:149](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L149) +[packages/core/src/types.ts:151](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L151) ---- +*** ### actionNames? @@ -164,9 +164,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:150](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L150) +[packages/core/src/types.ts:152](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L152) ---- +*** ### actions? @@ -174,9 +174,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:151](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L151) +[packages/core/src/types.ts:153](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L153) ---- +*** ### actionsData? @@ -184,9 +184,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:152](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L152) +[packages/core/src/types.ts:154](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L154) ---- +*** ### actionExamples? @@ -194,9 +194,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:153](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L153) +[packages/core/src/types.ts:155](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L155) ---- +*** ### providers? @@ -204,9 +204,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:154](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L154) +[packages/core/src/types.ts:156](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L156) ---- +*** ### responseData? @@ -214,9 +214,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:155](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L155) +[packages/core/src/types.ts:157](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L157) ---- +*** ### recentInteractionsData? @@ -224,9 +224,9 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:156](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L156) +[packages/core/src/types.ts:158](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L158) ---- +*** ### recentInteractions? @@ -234,4 +234,4 @@ Represents the state of the conversation or context in which the agent is operat #### Defined in -[packages/core/src/types.ts:157](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L157) +[packages/core/src/types.ts:159](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L159) diff --git a/docs/api/type-aliases/Character.md b/docs/api/type-aliases/Character.md index 4f4528741cb..4750a9e2867 100644 --- a/docs/api/type-aliases/Character.md +++ b/docs/api/type-aliases/Character.md @@ -30,7 +30,7 @@ #### Index Signature -\[`key`: `string`\]: `string` + \[`key`: `string`\]: `string` ### bio @@ -82,7 +82,7 @@ #### Index Signature -\[`key`: `string`\]: `string` + \[`key`: `string`\]: `string` ### settings.voice? @@ -122,4 +122,4 @@ ## Defined in -[packages/core/src/types.ts:324](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L324) +[packages/core/src/types.ts:327](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L327) diff --git a/docs/api/type-aliases/Client.md b/docs/api/type-aliases/Client.md index d3320f4251d..481b73efa0e 100644 --- a/docs/api/type-aliases/Client.md +++ b/docs/api/type-aliases/Client.md @@ -30,4 +30,4 @@ ## Defined in -[packages/core/src/types.ts:303](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L303) +[packages/core/src/types.ts:306](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L306) diff --git a/docs/api/type-aliases/Handler.md b/docs/api/type-aliases/Handler.md index 134574a4e4f..1d4a539be47 100644 --- a/docs/api/type-aliases/Handler.md +++ b/docs/api/type-aliases/Handler.md @@ -22,4 +22,4 @@ Represents the type of a handler function, which takes a runtime instance, a mes ## Defined in -[packages/core/src/types.ts:186](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L186) +[packages/core/src/types.ts:188](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L188) diff --git a/docs/api/type-aliases/HandlerCallback.md b/docs/api/type-aliases/HandlerCallback.md index b05f9a04961..49f2f42589c 100644 --- a/docs/api/type-aliases/HandlerCallback.md +++ b/docs/api/type-aliases/HandlerCallback.md @@ -14,4 +14,4 @@ ## Defined in -[packages/core/src/types.ts:195](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L195) +[packages/core/src/types.ts:197](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L197) diff --git a/docs/api/type-aliases/Media.md b/docs/api/type-aliases/Media.md index 11adc4ca1d6..d76b75486ac 100644 --- a/docs/api/type-aliases/Media.md +++ b/docs/api/type-aliases/Media.md @@ -30,4 +30,4 @@ ## Defined in -[packages/core/src/types.ts:294](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L294) +[packages/core/src/types.ts:297](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L297) diff --git a/docs/api/type-aliases/Model.md b/docs/api/type-aliases/Model.md index 0968fa10cef..2e79fd2acb6 100644 --- a/docs/api/type-aliases/Model.md +++ b/docs/api/type-aliases/Model.md @@ -20,17 +20,17 @@ > **maxOutputTokens**: `number` -### settings.frequency_penalty? +### settings.frequency\_penalty? -> `optional` **frequency_penalty**: `number` +> `optional` **frequency\_penalty**: `number` -### settings.presence_penalty? +### settings.presence\_penalty? -> `optional` **presence_penalty**: `number` +> `optional` **presence\_penalty**: `number` -### settings.repetition_penalty? +### settings.repetition\_penalty? -> `optional` **repetition_penalty**: `number` +> `optional` **repetition\_penalty**: `number` ### settings.stop diff --git a/docs/api/type-aliases/Models.md b/docs/api/type-aliases/Models.md index 04bc6e19dce..db8711b5452 100644 --- a/docs/api/type-aliases/Models.md +++ b/docs/api/type-aliases/Models.md @@ -20,26 +20,30 @@ > **groq**: [`Model`](Model.md) -### llama_cloud +### llama\_cloud -> **llama_cloud**: [`Model`](Model.md) +> **llama\_cloud**: [`Model`](Model.md) -### llama_local +### llama\_local -> **llama_local**: [`Model`](Model.md) +> **llama\_local**: [`Model`](Model.md) ### google > **google**: [`Model`](Model.md) -### claude_vertex +### claude\_vertex -> **claude_vertex**: [`Model`](Model.md) +> **claude\_vertex**: [`Model`](Model.md) ### redpill > **redpill**: [`Model`](Model.md) +### openrouter + +> **openrouter**: [`Model`](Model.md) + ### ollama > **ollama**: [`Model`](Model.md) diff --git a/docs/api/type-aliases/Plugin.md b/docs/api/type-aliases/Plugin.md index 3095a90fdec..062aefdf270 100644 --- a/docs/api/type-aliases/Plugin.md +++ b/docs/api/type-aliases/Plugin.md @@ -30,4 +30,4 @@ ## Defined in -[packages/core/src/types.ts:308](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L308) +[packages/core/src/types.ts:311](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L311) diff --git a/docs/api/type-aliases/Validator.md b/docs/api/type-aliases/Validator.md index bfbba8cea45..0e80b9f6679 100644 --- a/docs/api/type-aliases/Validator.md +++ b/docs/api/type-aliases/Validator.md @@ -18,4 +18,4 @@ Represents the type of a validator function, which takes a runtime instance, a m ## Defined in -[packages/core/src/types.ts:203](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L203) +[packages/core/src/types.ts:205](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L205) diff --git a/docs/api/typedoc-sidebar.cjs b/docs/api/typedoc-sidebar.cjs index 3b429c8dbb2..0e9b1029c7c 100644 --- a/docs/api/typedoc-sidebar.cjs +++ b/docs/api/typedoc-sidebar.cjs @@ -1,293 +1,4 @@ // @ts-check /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { - items: [ - { - type: "category", - label: "Enumerations", - items: [ - { type: "doc", id: "enumerations/GoalStatus", label: "GoalStatus" }, - { type: "doc", id: "enumerations/ModelClass", label: "ModelClass" }, - { - type: "doc", - id: "enumerations/ModelProviderName", - label: "ModelProviderName", - }, - { type: "doc", id: "enumerations/Clients", label: "Clients" }, - { type: "doc", id: "enumerations/ServiceType", label: "ServiceType" }, - ], - }, - { - type: "category", - label: "Classes", - items: [ - { - type: "doc", - id: "classes/DatabaseAdapter", - label: "DatabaseAdapter", - }, - { type: "doc", id: "classes/MemoryManager", label: "MemoryManager" }, - { type: "doc", id: "classes/AgentRuntime", label: "AgentRuntime" }, - { type: "doc", id: "classes/Service", label: "Service" }, - ], - }, - { - type: "category", - label: "Interfaces", - items: [ - { type: "doc", id: "interfaces/Content", label: "Content" }, - { type: "doc", id: "interfaces/ActionExample", label: "ActionExample" }, - { - type: "doc", - id: "interfaces/ConversationExample", - label: "ConversationExample", - }, - { type: "doc", id: "interfaces/Actor", label: "Actor" }, - { type: "doc", id: "interfaces/Objective", label: "Objective" }, - { type: "doc", id: "interfaces/Goal", label: "Goal" }, - { type: "doc", id: "interfaces/State", label: "State" }, - { type: "doc", id: "interfaces/Memory", label: "Memory" }, - { - type: "doc", - id: "interfaces/MessageExample", - label: "MessageExample", - }, - { type: "doc", id: "interfaces/Action", label: "Action" }, - { - type: "doc", - id: "interfaces/EvaluationExample", - label: "EvaluationExample", - }, - { type: "doc", id: "interfaces/Evaluator", label: "Evaluator" }, - { type: "doc", id: "interfaces/Provider", label: "Provider" }, - { type: "doc", id: "interfaces/Relationship", label: "Relationship" }, - { type: "doc", id: "interfaces/Account", label: "Account" }, - { type: "doc", id: "interfaces/Participant", label: "Participant" }, - { type: "doc", id: "interfaces/Room", label: "Room" }, - { - type: "doc", - id: "interfaces/IDatabaseAdapter", - label: "IDatabaseAdapter", - }, - { - type: "doc", - id: "interfaces/IMemoryManager", - label: "IMemoryManager", - }, - { type: "doc", id: "interfaces/IAgentRuntime", label: "IAgentRuntime" }, - { - type: "doc", - id: "interfaces/IImageDescriptionService", - label: "IImageDescriptionService", - }, - { - type: "doc", - id: "interfaces/ITranscriptionService", - label: "ITranscriptionService", - }, - { type: "doc", id: "interfaces/IVideoService", label: "IVideoService" }, - { - type: "doc", - id: "interfaces/ITextGenerationService", - label: "ITextGenerationService", - }, - { - type: "doc", - id: "interfaces/IBrowserService", - label: "IBrowserService", - }, - { - type: "doc", - id: "interfaces/ISpeechService", - label: "ISpeechService", - }, - { type: "doc", id: "interfaces/IPdfService", label: "IPdfService" }, - ], - }, - { - type: "category", - label: "Type Aliases", - items: [ - { type: "doc", id: "type-aliases/UUID", label: "UUID" }, - { type: "doc", id: "type-aliases/Model", label: "Model" }, - { type: "doc", id: "type-aliases/Models", label: "Models" }, - { type: "doc", id: "type-aliases/Handler", label: "Handler" }, - { - type: "doc", - id: "type-aliases/HandlerCallback", - label: "HandlerCallback", - }, - { type: "doc", id: "type-aliases/Validator", label: "Validator" }, - { type: "doc", id: "type-aliases/Media", label: "Media" }, - { type: "doc", id: "type-aliases/Client", label: "Client" }, - { type: "doc", id: "type-aliases/Plugin", label: "Plugin" }, - { type: "doc", id: "type-aliases/Character", label: "Character" }, - ], - }, - { - type: "category", - label: "Variables", - items: [ - { - type: "doc", - id: "variables/defaultCharacter", - label: "defaultCharacter", - }, - { - type: "doc", - id: "variables/evaluationTemplate", - label: "evaluationTemplate", - }, - { type: "doc", id: "variables/elizaLogger", label: "elizaLogger" }, - { - type: "doc", - id: "variables/embeddingDimension", - label: "embeddingDimension", - }, - { - type: "doc", - id: "variables/embeddingZeroVector", - label: "embeddingZeroVector", - }, - { type: "doc", id: "variables/settings", label: "settings" }, - ], - }, - { - type: "category", - label: "Functions", - items: [ - { - type: "doc", - id: "functions/composeActionExamples", - label: "composeActionExamples", - }, - { - type: "doc", - id: "functions/formatActionNames", - label: "formatActionNames", - }, - { type: "doc", id: "functions/formatActions", label: "formatActions" }, - { - type: "doc", - id: "functions/composeContext", - label: "composeContext", - }, - { type: "doc", id: "functions/addHeader", label: "addHeader" }, - { type: "doc", id: "functions/embed", label: "embed" }, - { - type: "doc", - id: "functions/retrieveCachedEmbedding", - label: "retrieveCachedEmbedding", - }, - { - type: "doc", - id: "functions/formatEvaluatorNames", - label: "formatEvaluatorNames", - }, - { - type: "doc", - id: "functions/formatEvaluators", - label: "formatEvaluators", - }, - { - type: "doc", - id: "functions/formatEvaluatorExamples", - label: "formatEvaluatorExamples", - }, - { - type: "doc", - id: "functions/formatEvaluatorExampleDescriptions", - label: "formatEvaluatorExampleDescriptions", - }, - { type: "doc", id: "functions/generateText", label: "generateText" }, - { type: "doc", id: "functions/trimTokens", label: "trimTokens" }, - { - type: "doc", - id: "functions/generateShouldRespond", - label: "generateShouldRespond", - }, - { type: "doc", id: "functions/splitChunks", label: "splitChunks" }, - { - type: "doc", - id: "functions/generateTrueOrFalse", - label: "generateTrueOrFalse", - }, - { - type: "doc", - id: "functions/generateTextArray", - label: "generateTextArray", - }, - { - type: "doc", - id: "functions/generateObject", - label: "generateObject", - }, - { - type: "doc", - id: "functions/generateObjectArray", - label: "generateObjectArray", - }, - { - type: "doc", - id: "functions/generateMessageResponse", - label: "generateMessageResponse", - }, - { type: "doc", id: "functions/generateImage", label: "generateImage" }, - { - type: "doc", - id: "functions/generateCaption", - label: "generateCaption", - }, - { type: "doc", id: "functions/getGoals", label: "getGoals" }, - { - type: "doc", - id: "functions/formatGoalsAsString", - label: "formatGoalsAsString", - }, - { type: "doc", id: "functions/updateGoal", label: "updateGoal" }, - { type: "doc", id: "functions/createGoal", label: "createGoal" }, - { - type: "doc", - id: "functions/getActorDetails", - label: "getActorDetails", - }, - { type: "doc", id: "functions/formatActors", label: "formatActors" }, - { - type: "doc", - id: "functions/formatMessages", - label: "formatMessages", - }, - { - type: "doc", - id: "functions/formatTimestamp", - label: "formatTimestamp", - }, - { type: "doc", id: "functions/getModel", label: "getModel" }, - { type: "doc", id: "functions/getEndpoint", label: "getEndpoint" }, - { type: "doc", id: "functions/formatPosts", label: "formatPosts" }, - { type: "doc", id: "functions/getProviders", label: "getProviders" }, - { - type: "doc", - id: "functions/createRelationship", - label: "createRelationship", - }, - { - type: "doc", - id: "functions/getRelationship", - label: "getRelationship", - }, - { - type: "doc", - id: "functions/getRelationships", - label: "getRelationships", - }, - { - type: "doc", - id: "functions/formatRelationships", - label: "formatRelationships", - }, - ], - }, - ], -}; -module.exports = typedocSidebar.items; +const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"enumerations/GoalStatus","label":"GoalStatus"},{"type":"doc","id":"enumerations/ModelClass","label":"ModelClass"},{"type":"doc","id":"enumerations/ModelProviderName","label":"ModelProviderName"},{"type":"doc","id":"enumerations/Clients","label":"Clients"},{"type":"doc","id":"enumerations/ServiceType","label":"ServiceType"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"classes/DatabaseAdapter","label":"DatabaseAdapter"},{"type":"doc","id":"classes/MemoryManager","label":"MemoryManager"},{"type":"doc","id":"classes/AgentRuntime","label":"AgentRuntime"},{"type":"doc","id":"classes/Service","label":"Service"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"interfaces/Content","label":"Content"},{"type":"doc","id":"interfaces/ActionExample","label":"ActionExample"},{"type":"doc","id":"interfaces/ConversationExample","label":"ConversationExample"},{"type":"doc","id":"interfaces/Actor","label":"Actor"},{"type":"doc","id":"interfaces/Objective","label":"Objective"},{"type":"doc","id":"interfaces/Goal","label":"Goal"},{"type":"doc","id":"interfaces/State","label":"State"},{"type":"doc","id":"interfaces/Memory","label":"Memory"},{"type":"doc","id":"interfaces/MessageExample","label":"MessageExample"},{"type":"doc","id":"interfaces/Action","label":"Action"},{"type":"doc","id":"interfaces/EvaluationExample","label":"EvaluationExample"},{"type":"doc","id":"interfaces/Evaluator","label":"Evaluator"},{"type":"doc","id":"interfaces/Provider","label":"Provider"},{"type":"doc","id":"interfaces/Relationship","label":"Relationship"},{"type":"doc","id":"interfaces/Account","label":"Account"},{"type":"doc","id":"interfaces/Participant","label":"Participant"},{"type":"doc","id":"interfaces/Room","label":"Room"},{"type":"doc","id":"interfaces/IDatabaseAdapter","label":"IDatabaseAdapter"},{"type":"doc","id":"interfaces/IMemoryManager","label":"IMemoryManager"},{"type":"doc","id":"interfaces/IAgentRuntime","label":"IAgentRuntime"},{"type":"doc","id":"interfaces/IImageDescriptionService","label":"IImageDescriptionService"},{"type":"doc","id":"interfaces/ITranscriptionService","label":"ITranscriptionService"},{"type":"doc","id":"interfaces/IVideoService","label":"IVideoService"},{"type":"doc","id":"interfaces/ITextGenerationService","label":"ITextGenerationService"},{"type":"doc","id":"interfaces/IBrowserService","label":"IBrowserService"},{"type":"doc","id":"interfaces/ISpeechService","label":"ISpeechService"},{"type":"doc","id":"interfaces/IPdfService","label":"IPdfService"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"type-aliases/UUID","label":"UUID"},{"type":"doc","id":"type-aliases/Model","label":"Model"},{"type":"doc","id":"type-aliases/Models","label":"Models"},{"type":"doc","id":"type-aliases/Handler","label":"Handler"},{"type":"doc","id":"type-aliases/HandlerCallback","label":"HandlerCallback"},{"type":"doc","id":"type-aliases/Validator","label":"Validator"},{"type":"doc","id":"type-aliases/Media","label":"Media"},{"type":"doc","id":"type-aliases/Client","label":"Client"},{"type":"doc","id":"type-aliases/Plugin","label":"Plugin"},{"type":"doc","id":"type-aliases/Character","label":"Character"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"variables/defaultCharacter","label":"defaultCharacter"},{"type":"doc","id":"variables/evaluationTemplate","label":"evaluationTemplate"},{"type":"doc","id":"variables/elizaLogger","label":"elizaLogger"},{"type":"doc","id":"variables/embeddingDimension","label":"embeddingDimension"},{"type":"doc","id":"variables/embeddingZeroVector","label":"embeddingZeroVector"},{"type":"doc","id":"variables/settings","label":"settings"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"functions/composeActionExamples","label":"composeActionExamples"},{"type":"doc","id":"functions/formatActionNames","label":"formatActionNames"},{"type":"doc","id":"functions/formatActions","label":"formatActions"},{"type":"doc","id":"functions/composeContext","label":"composeContext"},{"type":"doc","id":"functions/addHeader","label":"addHeader"},{"type":"doc","id":"functions/embed","label":"embed"},{"type":"doc","id":"functions/retrieveCachedEmbedding","label":"retrieveCachedEmbedding"},{"type":"doc","id":"functions/formatEvaluatorNames","label":"formatEvaluatorNames"},{"type":"doc","id":"functions/formatEvaluators","label":"formatEvaluators"},{"type":"doc","id":"functions/formatEvaluatorExamples","label":"formatEvaluatorExamples"},{"type":"doc","id":"functions/formatEvaluatorExampleDescriptions","label":"formatEvaluatorExampleDescriptions"},{"type":"doc","id":"functions/generateText","label":"generateText"},{"type":"doc","id":"functions/trimTokens","label":"trimTokens"},{"type":"doc","id":"functions/generateShouldRespond","label":"generateShouldRespond"},{"type":"doc","id":"functions/splitChunks","label":"splitChunks"},{"type":"doc","id":"functions/generateTrueOrFalse","label":"generateTrueOrFalse"},{"type":"doc","id":"functions/generateTextArray","label":"generateTextArray"},{"type":"doc","id":"functions/generateObject","label":"generateObject"},{"type":"doc","id":"functions/generateObjectArray","label":"generateObjectArray"},{"type":"doc","id":"functions/generateMessageResponse","label":"generateMessageResponse"},{"type":"doc","id":"functions/generateImage","label":"generateImage"},{"type":"doc","id":"functions/generateCaption","label":"generateCaption"},{"type":"doc","id":"functions/getGoals","label":"getGoals"},{"type":"doc","id":"functions/formatGoalsAsString","label":"formatGoalsAsString"},{"type":"doc","id":"functions/updateGoal","label":"updateGoal"},{"type":"doc","id":"functions/createGoal","label":"createGoal"},{"type":"doc","id":"functions/getActorDetails","label":"getActorDetails"},{"type":"doc","id":"functions/formatActors","label":"formatActors"},{"type":"doc","id":"functions/formatMessages","label":"formatMessages"},{"type":"doc","id":"functions/formatTimestamp","label":"formatTimestamp"},{"type":"doc","id":"functions/getModel","label":"getModel"},{"type":"doc","id":"functions/getEndpoint","label":"getEndpoint"},{"type":"doc","id":"functions/formatPosts","label":"formatPosts"},{"type":"doc","id":"functions/getProviders","label":"getProviders"},{"type":"doc","id":"functions/createRelationship","label":"createRelationship"},{"type":"doc","id":"functions/getRelationship","label":"getRelationship"},{"type":"doc","id":"functions/getRelationships","label":"getRelationships"},{"type":"doc","id":"functions/formatRelationships","label":"formatRelationships"},{"type":"doc","id":"functions/findNearestEnvFile","label":"findNearestEnvFile"},{"type":"doc","id":"functions/loadEnvConfig","label":"loadEnvConfig"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/docs/community/contributing.md b/docs/docs/community/contributing.md index 5fd9ef1ea2a..c8a6e04b7cb 100644 --- a/docs/docs/community/contributing.md +++ b/docs/docs/community/contributing.md @@ -90,8 +90,8 @@ Note: we're still finalizing details on the creator/dev fund that seeks to retro ## Getting Started -1. Join the [Eliza Discord](https://discord.gg/P4uxZJFAdP) and make a short introduction. -2. Explore the [documentation](/docs/intro) to understand the project's architecture and capabilities. +1. Join the [Eliza Discord](https://discord.gg/ai16z) and make a short introduction. +2. Explore the [documentation](/docs/intro) to understand the project's architecture and capabilities. 3. Check out the [open issues](https://github.com/ai16z/eliza/issues) on GitHub to find ways to contribute. 4. Share your ideas and initiatives with the community - we're excited to see what you'll build! diff --git a/docs/docs/community/notes.md b/docs/docs/community/stream-notes.md similarity index 60% rename from docs/docs/community/notes.md rename to docs/docs/community/stream-notes.md index 409b5e91fc7..23b9b000ac7 100644 --- a/docs/docs/community/notes.md +++ b/docs/docs/community/stream-notes.md @@ -1,9 +1,228 @@ --- sidebar_position: 1 -title: Notes +title: Stream Notes --- -# Notes +# Stream Notes + +## Memes, AI Agents, DAOs 11-8-24 + +Space: https://x.com/ai16zdao/status/1854969196142379403 + +## Overview + +1. Introductions & Community Building (00:00:00 - 00:45:00) +- Multiple AI/crypto developers introduce themselves and their projects +- Discussion of open source collaboration and community building +- Emphasis on PPP (Player Pumps Player) vs PVP mentality + +2. Trust Systems & AI Agents (00:45:00 - 01:15:00) +- Discussion of trust mechanisms in AI systems +- Marketplace of trust concept +- Human-in-the-loop vs autonomous systems +- Role of transparency in AI agent systems + +3. Memes, Narrative & Reality (01:15:00 - 01:45:00) +- Relationship between memes and financial incentives +- Discussion of hyperstition and narrative creation +- Role of AI in shaping reality and perception +- Integration of Nick Land's philosophy + +4. Technical Implementation & Future Vision (01:45:00 - 02:10:00) +- Discussion of multi-agent systems and swarms +- Technical challenges in implementation +- Integration with existing platforms +- Future vision for AI agent ecosystems + +--- + +Detailed Breakdown of Topic 1: Introductions & Community Building (00:00:00 - 00:45:00) + +Key Points: + +1. Notable Introductions: +- Shaw: AI agent developer for 4-5 years, focusing on metaverse/AI/blockchain integration +- Tim: Former game industry dev (Ultima Online), working on Autonomous Virtual Beings (AVB) +- Glue/Sam: Duck AI developer, focusing on collective intelligence for crypto +- Parzival: 89 project lead, working on alternate reality game integration with AI +- Michelle: Former PayPal lawyer, worked on Loving AI project and various educational bots + +2. Core Community Values: +- Strong emphasis on open source development +- "Player Pumps Player" (PPP) philosophy vs competitive PVP +- Focus on building public, getting feedback, and rapid iteration +- Recognition that code is "cheap" - ideas and community are valuable + +3. Collaborative Framework: +- Shared recognition that small projects need to work together +- Discussion of market cap being less important than technological progress +- Agreement that they're competing with big tech, not each other +- Emphasis on sharing knowledge and avoiding "wheel reinvention" + +4. Current State of AI Agents: +- Recognition of "magical moment" where AI agents are getting serious attention +- Discussion of shift from academic papers to practical implementation +- Focus on building in public and rapid feedback loops +- Emphasis on moving beyond purely academic approach to practical applications + +Key Quotes: +"Code is cheap... there's no sense in proprietary software anymore" (00:59:10) +"We're competing against Microsoft and Facebook, we're not competing against each other" (00:44:33) + +Summary: +This segment establishes the foundational ethos of the AI agent development community, emphasizing collaboration over competition. The introductions reveal a diverse group of developers from various backgrounds (gaming, finance, law) united by a vision of open source AI development. There's a strong focus on building public infrastructure rather than competing proprietary systems, with multiple participants emphasizing the importance of community building and knowledge sharing. The segment reveals a shift from theoretical academic work to practical implementation, with a clear understanding that success requires collaborative effort rather than isolated development. + +Notable Timestamp Ranges: +00:03:37 - 00:07:15: Shaw's introduction and community vision +00:13:30 - 00:16:45: Tim's gaming background and AVB concept +00:17:30 - 00:20:15: Glue's introduction of Duck AI +00:23:00 - 00:27:45: Parzival's background and ARG connection +00:30:15 - 00:35:20: Michelle's extensive AI background and projects + +--- + +Detailed Breakdown of Topic 2: Trust Systems & AI Agents (00:45:00 - 01:15:00) + +Key Points: + +1. Trust Marketplace Concept: +- Development of a trust scoring system for AI agents and humans +- Similar to "block explorer plus Apple Health" for tracking trust metrics +- Focus on measuring actual performance rather than token holdings +- Discussion of perverse incentives in traditional DAO structures +- Timestamp: 00:47:30 - 00:52:15 + +2. Human-AI Integration: +- Debate over necessity of human oversight in AI systems +- Sally (trader advisor) raises washing machine analogy: humans should input but AI handles processing +- Discussion of transparency in AI decision-making +- Question of whether to label bots as automated vs. appearing human +- Timestamp: 00:54:20 - 01:00:45 + +3. Trust Verification Mechanisms: +- Development of automated due diligence systems +- Discussion of using AI to prevent scams and verify contract addresses +- Integration of narrative understanding with quantitative data +- Focus on building trust through transparent operation +- Timestamp: 01:01:30 - 01:08:15 + +4. Market Intelligence: +- Discussion of how AI agents can aggregate and verify market information +- Comparison to traditional hedge fund intelligence gathering +- Debate over centralized vs. decentralized information sharing +- Evolution beyond traditional KOL (Key Opinion Leader) model +- Timestamp: 01:08:45 - 01:15:00 + +Key Quotes: +"Trust like you should not trust me because I'm a good guy, you should trust me because the incentives that I am going to do this are aligned" (01:02:45) +"We need trust to be something more about giving people points in the games that they're playing" (01:04:30) + +Summary: +This segment focuses on the complex challenge of establishing trust in AI systems and between AI agents. The discussion reveals a sophisticated understanding of the need to move beyond traditional reputation systems to quantifiable, performance-based trust metrics. There's significant emphasis on the importance of transparency and proper incentive alignment, with the group working to develop systems that can verify and validate both human and AI actors in the ecosystem. The segment also touches on the delicate balance between human oversight and AI autonomy, with various perspectives on how to achieve optimal integration. + +Notable Technical Elements: +- Development of trust marketplace infrastructure +- Integration of narrative analysis with quantitative metrics +- Focus on automated verification systems +- Creation of transparent scoring mechanisms + +--- + +Detailed Breakdown of Topic 3: Memes, Narrative & Reality (01:15:00 - 01:45:00) + +Key Points: + +1. Meme Evolution & Financial Incentives: +- Discussion of memes as self-propagating units of information +- Analysis of how financial incentives accelerate meme spread +- Creation of "AI crypto memetic flywheel" +- Exploration of how memes gain autonomous life through financial backing +- Timestamp: 01:15:30 - 01:23:45 + +2. Nick Land & Hyperstition: +- Integration of Nick Land's accelerationist philosophy +- Discussion of hyperstition (fictions that make themselves real) +- Genon project's attempt to merge accelerationism with decentralization +- Exploration of how AI can manifest hyperstition concepts +- Timestamp: 01:24:15 - 01:31:30 + +3. Language & Reality Construction: +- Discussion of language as fundamental to reality construction +- Exploration of how AI agents can develop their own communication systems +- Analysis of "Language 2.0" concept +- Discussion of how memes function as basic units of meaning +- Timestamp: 01:32:00 - 01:38:45 + +4. Narrative Control & AI Agents: +- Discussion of how AI agents can influence and shape narratives +- Comparison to traditional media and narrative control +- Analysis of decentralized narrative creation +- Role of AI in creating self-fulfilling prophecies +- Timestamp: 01:39:00 - 01:45:00 + +Key Quotes: +"Memes want to spread... it's a unit of information that wants to spread itself between humans" (01:17:30) +"You're never not looking at a meme, it's just that your brain has entrained itself to recognize certain memes as something stable" (01:35:15) + +Summary: +This segment explores the deep philosophical implications of memes, narrative creation, and reality construction in the context of AI agents. The discussion weaves together practical considerations about meme propagation with complex philosophical concepts from accelerationism and hyperstition. There's a sophisticated understanding of how financial incentives can be used to accelerate the spread of ideas, and how AI agents might participate in and influence this process. The segment also delves into fundamental questions about language, meaning, and reality construction, suggesting that AI agents might develop their own forms of communication and meaning-making. + +Notable Philosophical Concepts: +- Hyperstition as self-fulfilling prophecy +- Memes as basic units of reality construction +- Role of financial incentives in idea propagation +- AI agents as autonomous narrative creators + +--- + +Detailed Breakdown of Topic 4: Technical Implementation & Future Vision (01:45:00 - 02:10:00) + +Key Points: + +1. Multi-Agent Systems & Swarms: +- Discussion of scaling to 10,000+ agent simulations +- Exploration of communication pathways between agents +- Analysis of entity component systems for large-scale agent deployment +- Solutions for quadratic communication path problems +- Timestamp: 01:45:30 - 01:52:45 + +2. Technical Architecture: +- New plugin system implementation for modularity +- Movement of core functionalities to packages +- Integration with platforms like Twitter without API dependencies +- Discussion of lightweight, flexible architecture +- Timestamp: 01:53:00 - 01:58:30 + +3. Cross-Project Integration: +- Arena system for agent interaction +- Discussion of bot-to-bot communication protocols +- Integration between different teams' agents +- Shared backrooms/environments for agent interaction +- Timestamp: 01:59:00 - 02:04:15 + +4. Future Development Plans: +- Weekly community updates and progress sharing +- Development of trust marketplace +- Integration of autonomous trading capabilities +- Focus on building shared infrastructure +- Timestamp: 02:04:30 - 02:10:00 + +Key Quotes: +"I'm thinking about multi-agent swarms like mycelia, where each agent is like a fungus of a global intelligence body" (01:47:30) +"We're making an open source agent where we're almost done with the first marketplace to trust mechanic element" (02:05:15) + +Summary: +This final segment focuses on the technical challenges and solutions for implementing large-scale AI agent systems. The discussion reveals sophisticated understanding of scaling issues and innovative solutions for agent communication and coordination. There's significant emphasis on modular architecture and cross-project integration, with multiple teams working to create interoperable systems. The segment concludes with concrete plans for future development and community coordination, emphasizing the practical steps needed to realize the ambitious visions discussed throughout the space. + +Technical Highlights: +- Entity component systems for agent management +- Plugin architecture for modularity +- Solutions for large-scale agent communication +- Cross-platform integration strategies + +This segment effectively bridges the philosophical discussions from earlier with practical implementation details, providing a roadmap for how these systems might actually be built and scaled. + +--- ## Discord Stream 11-6-24 diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md index 8b18f618dd8..58381de05d0 100644 --- a/docs/docs/quickstart.md +++ b/docs/docs/quickstart.md @@ -2,112 +2,151 @@ sidebar_position: 2 --- -# Quickstart +# Quickstart Guide -## Install Node.js +## Prerequisites -https://docs.npmjs.com/downloading-and-installing-node-js-and-npm +Before getting started with Eliza, ensure you have: -## Using pnpm +- [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) +- [pnpm](https://pnpm.io/installation) +- Git for version control +- A code editor (VS Code recommended) +- CUDA Toolkit (optional, for GPU acceleration) -We use pnpm to manage our dependencies. It is faster and more efficient than npm, and it supports workspaces. -https://pnpm.io/installation +## Installation -## Edit the .env file +1. **Clone and Install** +```bash +# Clone the repository +git clone https://github.com/ai16z/eliza.git +cd eliza -- Copy .env.example to .env and fill in the appropriate values -- Edit the TWITTER environment variables to add your bot's username and password - -## Edit the character file +# Install dependencies +pnpm install -- Check out the file `src/core/defaultCharacter.ts` - you can modify this -- You can also load characters with the `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json"` and run multiple bots at the same time. +# Install optional Sharp package if needed +pnpm install --include=optional sharp +``` -### Run with Llama +2. **Configure Environment** +```bash +# Copy example environment file +cp .env.example .env +``` -You can run Llama 70B or 405B models by setting the `XAI_MODEL` environment variable to `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` or `meta-llama/Meta-Llama-3.1-405B-Instruct` +Edit `.env` and add your values: +```bash +# Required environment variables +DISCORD_APPLICATION_ID= # For Discord integration +DISCORD_API_TOKEN= # Bot token +OPENAI_API_KEY= # OpenAI API key (starting with sk-*) +ELEVENLABS_XI_API_KEY= # API key from elevenlabs (for voice) +``` -### Run with Grok +## Choose Your Model -You can run Grok models by setting the `XAI_MODEL` environment variable to `grok-beta` +Eliza supports multiple AI models: -### Run with OpenAI +- **Llama**: Set `XAI_MODEL=meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` +- **Grok**: Set `XAI_MODEL=grok-beta` +- **OpenAI**: Set `XAI_MODEL=gpt-4o-mini` or `gpt-4o` -You can run OpenAI models by setting the `XAI_MODEL` environment variable to `gpt-4o-mini` or `gpt-4o` +For local inference: +1. Set `XAI_MODEL` to your chosen model +2. Leave `X_SERVER_URL` and `XAI_API_KEY` blank +3. The system will automatically download the model from Hugging Face -# Requires Node 20+ +## Create Your First Agent -If you are getting strange issues when starting up, make sure you're using Node 20+. Some APIs are not compatible with previous versions. You can check your node version with `node -v`. If you need to install a new version of node, we recommend using [nvm](https://github.com/nvm-sh/nvm). +1. **Edit the Character File** +Check out `src/core/defaultCharacter.ts` to customize your agent's personality and behavior. -## Additional Requirements +You can also load custom characters: +```bash +pnpm start --characters="path/to/your/character.json" +``` -You may need to install Sharp. If you see an error when starting up, try installing it with the following command: +2. **Start the Agent** +```bash +pnpm start +``` +## Platform Integration + +### Discord Bot Setup +1. Create a new application at [Discord Developer Portal](https://discord.com/developers/applications) +2. Create a bot and get your token +3. Add bot to your server using OAuth2 URL generator +4. Set `DISCORD_API_TOKEN` and `DISCORD_APPLICATION_ID` in your `.env` + +### Twitter Integration +Add to your `.env`: +```bash +TWITTER_USERNAME= # Account username +TWITTER_PASSWORD= # Account password +TWITTER_EMAIL= # Account email +TWITTER_COOKIES= # Account cookies ``` -pnpm install --include=optional sharp + +### Telegram Bot +1. Create a bot through [@BotFather](https://t.me/botfather) +2. Add your bot token to `.env`: +```bash +TELEGRAM_BOT_TOKEN=your_token_here ``` -# Environment Setup +## Optional: GPU Acceleration -You will need to add environment variables to your .env file to connect to various platforms: +If you have an NVIDIA GPU: -``` -# Required environment variables -# Start Discord -DISCORD_APPLICATION_ID= -DISCORD_API_TOKEN= # Bot token - -# Start Twitter -TWITTER_USERNAME= # Account username -TWITTER_PASSWORD= # Account password -TWITTER_EMAIL= # Account email -TWITTER_COOKIES= # Account cookies -``` - -# Local Setup +```bash +# Install CUDA support +npx --no node-llama-cpp source download --gpu cuda -## CUDA Setup +# Ensure CUDA Toolkit, cuDNN, and cuBLAS are installed +``` -If you have an NVIDIA GPU, you can install CUDA to speed up local inference dramatically. +## Basic Usage Examples +### Chat with Your Agent +```bash +# Start chat interface +pnpm run shell ``` -pnpm install -npx --no node-llama-cpp source download --gpu cuda + +### Run Multiple Agents +```bash +pnpm start --characters="agent1.json,agent2.json" ``` -Make sure that you've installed the CUDA Toolkit, including cuDNN and cuBLAS. +## Common Issues & Solutions -## Running locally +1. **Node.js Version** + - Ensure Node.js 22+ is installed + - Use `node -v` to check version + - Consider using [nvm](https://github.com/nvm-sh/nvm) to manage Node versions -Add XAI_MODEL and set it to one of the above options from [Run with -Llama](#run-with-llama) - you can leave X_SERVER_URL and XAI_API_KEY blank, it -downloads the model from huggingface and queries it locally +2. **Sharp Installation** + If you see Sharp-related errors: + ```bash + pnpm install --include=optional sharp + ``` -# Cloud Setup (with OpenAI) +3. **CUDA Setup** + - Verify CUDA Toolkit installation + - Check GPU compatibility + - Ensure proper environment variables are set -In addition to the environment variables above, you will need to add the following: +## Next Steps -``` -# OpenAI handles the bulk of the work with chat, TTS, image recognition, etc. -OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk- - -# The agent can also ask Claude for help if you have an API key -ANTHROPIC_API_KEY= - -# For Elevenlabs voice generation on Discord voice -ELEVENLABS_XI_API_KEY= # API key from elevenlabs - -# ELEVENLABS SETTINGS -ELEVENLABS_MODEL_ID=eleven_multilingual_v2 -ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM -ELEVENLABS_VOICE_STABILITY=0.5 -ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9 -ELEVENLABS_VOICE_STYLE=0.66 -ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false -ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4 -ELEVENLABS_OUTPUT_FORMAT=pcm_16000 -``` +Once you have your agent running, explore: + +1. 🤖 [Understand Agents](./core/agents.md) +2. 📝 [Create Custom Characters](./core/characterfile.md) +3. ⚡ [Add Custom Actions](./core/actions.md) +4. 🔧 [Advanced Configuration](./guides/configuration.md) -# Discord Bot +For detailed API documentation, troubleshooting, and advanced features, check out our [full documentation](https://ai16z.github.io/eliza/). -For help with setting up your Discord Bot, check out here: https://discordjs.guide/preparations/setting-up-a-bot-application.html +Join our [Discord community](https://discord.gg/ai16z) for support and updates! diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index b63bf98d831..66e4f950a5b 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -172,14 +172,14 @@ const config = { title: "Community", items: [ { - label: "Discord", - href: "https://discord.gg/NQHKW7US", + label: 'Discord', + href: 'https://discord.gg/ai16z' }, { - label: "Twitter", - href: "https://twitter.com/pmairca", - }, - ], + label: 'Twitter', + href: 'https://twitter.com/ai16zdao' + } + ] }, { title: "More", diff --git a/docs/sidebars.js b/docs/sidebars.js index 62c64f15dfc..dee0eed86ac 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -4,59 +4,130 @@ const sidebars = { { type: "doc", id: "intro", - label: "Introduction", + label: "🚀 Introduction", }, { type: "category", - label: "Getting Started", - items: ["quickstart", "installation"], + label: "🏁 Getting Started", + items: ["quickstart"], // Consolidated installation into quickstart collapsed: false, }, { type: "category", - label: "Core Concepts", + label: "🧠 Core Concepts", collapsed: false, items: [ - "core/characterfile", - "core/agents", - "core/providers", - "core/actions", - "core/evaluators", + { + type: "doc", + id: "core/characterfile", + label: "📝 Character Files" + }, + { + type: "doc", + id: "core/agents", + label: "🤖 Agents" + }, + { + type: "doc", + id: "core/providers", + label: "🔌 Providers" + }, + { + type: "doc", + id: "core/actions", + label: "⚡ Actions" + }, + { + type: "doc", + id: "core/evaluators", + label: "📊 Evaluators" + }, ], }, { type: "category", - label: "Guides", + label: "📘 Guides", collapsed: false, items: [ - "guides/basic-usage", - "guides/configuration", - "guides/advanced", - "guides/secrets-management", - "guides/local-development", + { + type: "doc", + id: "guides/configuration", + label: "⚙️ Configuration" + }, + { + type: "doc", + id: "guides/advanced", + label: "🔧 Advanced Usage" + }, + { + type: "doc", + id: "guides/secrets-management", + label: "🔐 Secrets Management" + }, + { + type: "doc", + id: "guides/local-development", + label: "💻 Local Development" + }, ], }, { type: "category", - label: "Advanced Topics", + label: "🎓 Advanced Topics", collapsed: false, items: [ - "advanced/fine-tuning", - "advanced/infrastructure", - "advanced/trust-engine", - "advanced/autonomous-trading", + { + type: "doc", + id: "advanced/fine-tuning", + label: "🎯 Fine-tuning" + }, + { + type: "doc", + id: "advanced/infrastructure", + label: "🏗️ Infrastructure" + }, + { + type: "doc", + id: "advanced/trust-engine", + label: "🤝 Trust Engine" + }, + { + type: "doc", + id: "advanced/autonomous-trading", + label: "📈 Autonomous Trading" + }, ], }, { type: "category", - label: "Community", + label: "👥 Community", collapsed: false, items: [ - "community/creator-fund", - "community/notes", - "community/changelog", - "community/faq", - "community/contributing", + { + type: "doc", + id: "community/creator-fund", + label: "💰 Creator Fund" + }, + { + type: "doc", + id: "community/stream-notes", + label: "📺 Stream Notes" + }, + { + type: "doc", + id: "community/changelog", + label: "📝 Changelog" + }, + { + type: "doc", + id: "community/faq", + label: "❓ FAQ" + }, + { + type: "doc", + id: "community/contributing", + label: "🤝 Contributing" + }, ], }, ], diff --git a/docs/src/components/HomepageFeatures/index.js b/docs/src/components/HomepageFeatures/index.js index e5b4508f526..1ec1cdc2a86 100644 --- a/docs/src/components/HomepageFeatures/index.js +++ b/docs/src/components/HomepageFeatures/index.js @@ -4,52 +4,44 @@ import styles from "./styles.module.css"; const FeatureList = [ { - title: "Made By Users", + title: "🤖 Multi-Agent Framework", description: ( <> - eliza is open source, community developed and designed to be and easy to - use. + Build and deploy autonomous AI agents with consistent personalities across Discord, + Twitter, and Telegram. Full support for voice, text, and media interactions. ), }, { - title: "Just Works", + title: "🧠 Advanced Capabilities", description: ( <> - Simple, tested, used in production. Configurable enough, batteries - included. + Built-in RAG memory system, document processing, media analysis, and autonomous + trading capabilities. Supports multiple AI models including Llama, GPT-4, and Claude. ), }, { - title: "For a Better World", + title: "🔌 Extensible Design", description: ( <> - If you have ideas for how to make better agents for everyone,{" "} - let's do it together. + Create custom actions, add new platform integrations, and extend functionality + through a modular plugin system. Full TypeScript support. ), }, ]; -function Feature({ Svg, title, description }) { +function Feature({ title, description }) { return (
-
- {/*
- -
*/} -
+
+
{title}

{description}

diff --git a/tsconfig.json b/tsconfig.json index dd7a988669f..c027666c6eb 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,24 +1,49 @@ { - "compilerOptions": { - "target": "ESNext", - "module": "ESNext", - "lib": ["ESNext", "dom"], - "moduleResolution": "Bundler", - "outDir": "./dist", - "rootDir": ".", - "strict": false, - "esModuleInterop": true, - "skipLibCheck": true, - "forceConsistentCasingInFileNames": false, - "allowImportingTsExtensions": true, - "declaration": true, - "emitDeclarationOnly": true, - "resolveJsonModule": true, - "noImplicitAny": false, - "allowJs": true, - "checkJs": false, - "noEmitOnError": false, - "moduleDetection": "force", - "allowArbitraryExtensions": true - } + "plugins": [ + [ + "docusaurus-plugin-typedoc", + { + "entryPoints": ["../packages/core/src/index.ts"], + "tsconfig": "../tsconfig.json", + "out": "./api", + "skipErrorChecking": true, + "readme": "none", + "sidebar": { + "categoryLabel": "API Reference", + "position": 3, + "fullNames": true + }, + "includeVersion": true, + "disableSources": false, + "searchInComments": true, + "navigationLinks": { + "GitHub": "https://github.com/ai16z/eliza", + "Documentation": "/docs/intro" + }, + "categorizeByGroup": true, + "categoryOrder": [ + "Core", + "Clients", + "Services", + "Database", + "Providers", + "Utils", + "*" + ], + "includeExample": true, + "validation": { + "invalidLink": true, + "notExported": true, + "notDocumented": true + }, + "cleanOutputDir": true, + "hideGenerator": true, + "frontmatter": { + "pagination_prev": null, + "pagination_next": null + }, + "watch": "process.env.TYPEDOC_WATCH" + } + ] + ] }