diff --git a/docs/api/classes/AgentRuntime.md b/docs/api/classes/AgentRuntime.md index 7e6f818d795..9064c3bf03c 100644 --- a/docs/api/classes/AgentRuntime.md +++ b/docs/api/classes/AgentRuntime.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / AgentRuntime +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / AgentRuntime # Class: AgentRuntime @@ -83,7 +83,7 @@ Custom fetch function to use for making requests. #### Defined in -[packages/core/src/runtime.ts:197](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L197) +[packages/core/src/runtime.ts:202](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L202) ## Properties @@ -99,7 +99,7 @@ The ID of the agent #### Defined in -[packages/core/src/runtime.ts:61](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L61) +[packages/core/src/runtime.ts:62](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L62) *** @@ -115,7 +115,7 @@ The base URL of the server where the agent's requests are processed. #### Defined in -[packages/core/src/runtime.ts:65](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L65) +[packages/core/src/runtime.ts:66](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L66) *** @@ -131,7 +131,7 @@ The database adapter used for interacting with the database. #### Defined in -[packages/core/src/runtime.ts:70](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L70) +[packages/core/src/runtime.ts:71](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L71) *** @@ -147,7 +147,7 @@ Authentication token used for securing requests. #### Defined in -[packages/core/src/runtime.ts:75](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L75) +[packages/core/src/runtime.ts:76](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L76) *** @@ -163,7 +163,7 @@ Custom actions that the agent can perform. #### Defined in -[packages/core/src/runtime.ts:80](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L80) +[packages/core/src/runtime.ts:81](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L81) *** @@ -179,7 +179,7 @@ Evaluators used to assess and guide the agent's responses. #### Defined in -[packages/core/src/runtime.ts:85](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L85) +[packages/core/src/runtime.ts:86](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L86) *** @@ -195,7 +195,7 @@ Context providers used to provide context for message generation. #### Defined in -[packages/core/src/runtime.ts:90](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L90) +[packages/core/src/runtime.ts:91](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L91) *** @@ -209,7 +209,7 @@ Context providers used to provide context for message generation. #### Defined in -[packages/core/src/runtime.ts:92](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L92) +[packages/core/src/runtime.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L93) *** @@ -225,7 +225,7 @@ The model to use for generateText. #### Defined in -[packages/core/src/runtime.ts:97](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L97) +[packages/core/src/runtime.ts:98](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L98) *** @@ -260,7 +260,7 @@ Some environments may not have access to the global fetch function and need a cu #### Defined in -[packages/core/src/runtime.ts:103](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L103) +[packages/core/src/runtime.ts:104](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L104) *** @@ -276,7 +276,7 @@ The character to use for the agent #### Defined in -[packages/core/src/runtime.ts:108](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L108) +[packages/core/src/runtime.ts:109](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L109) *** @@ -292,7 +292,7 @@ Store messages that are sent and received by the agent. #### Defined in -[packages/core/src/runtime.ts:113](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L113) +[packages/core/src/runtime.ts:114](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L114) *** @@ -308,7 +308,7 @@ Store and recall descriptions of users based on conversations. #### Defined in -[packages/core/src/runtime.ts:118](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L118) +[packages/core/src/runtime.ts:119](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L119) *** @@ -324,7 +324,7 @@ Manage the creation and recall of static information (documents, historical game #### Defined in -[packages/core/src/runtime.ts:123](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L123) +[packages/core/src/runtime.ts:124](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L124) *** @@ -334,9 +334,13 @@ Manage the creation and recall of static information (documents, historical game Hold large documents that can be referenced +#### Implementation of + +[`IAgentRuntime`](../interfaces/IAgentRuntime.md).[`documentsManager`](../interfaces/IAgentRuntime.md#documentsManager) + #### Defined in -[packages/core/src/runtime.ts:128](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L128) +[packages/core/src/runtime.ts:129](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L129) *** @@ -346,9 +350,13 @@ Hold large documents that can be referenced Searchable document fragments +#### Implementation of + +[`IAgentRuntime`](../interfaces/IAgentRuntime.md).[`knowledgeManager`](../interfaces/IAgentRuntime.md#knowledgeManager) + #### Defined in -[packages/core/src/runtime.ts:133](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L133) +[packages/core/src/runtime.ts:134](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L134) *** @@ -362,7 +370,7 @@ Searchable document fragments #### Defined in -[packages/core/src/runtime.ts:135](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L135) +[packages/core/src/runtime.ts:136](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L136) *** @@ -372,7 +380,7 @@ Searchable document fragments #### Defined in -[packages/core/src/runtime.ts:136](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L136) +[packages/core/src/runtime.ts:137](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L137) *** @@ -386,7 +394,7 @@ Searchable document fragments #### Defined in -[packages/core/src/runtime.ts:137](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L137) +[packages/core/src/runtime.ts:138](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L138) ## Methods @@ -408,7 +416,7 @@ Searchable document fragments #### Defined in -[packages/core/src/runtime.ts:139](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L139) +[packages/core/src/runtime.ts:140](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L140) *** @@ -430,7 +438,7 @@ Searchable document fragments #### Defined in -[packages/core/src/runtime.ts:154](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L154) +[packages/core/src/runtime.ts:155](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L155) *** @@ -456,7 +464,7 @@ Searchable document fragments #### Defined in -[packages/core/src/runtime.ts:158](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L158) +[packages/core/src/runtime.ts:159](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L159) *** @@ -478,7 +486,7 @@ Searchable document fragments #### Defined in -[packages/core/src/runtime.ts:167](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L167) +[packages/core/src/runtime.ts:168](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L168) *** @@ -496,7 +504,7 @@ Searchable document fragments #### Defined in -[packages/core/src/runtime.ts:312](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L312) +[packages/core/src/runtime.ts:359](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L359) *** @@ -518,7 +526,7 @@ Searchable document fragments #### Defined in -[packages/core/src/runtime.ts:408](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L408) +[packages/core/src/runtime.ts:423](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L423) *** @@ -540,7 +548,7 @@ The number of recent messages to be kept in memory. #### Defined in -[packages/core/src/runtime.ts:430](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L430) +[packages/core/src/runtime.ts:445](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L445) *** @@ -566,7 +574,7 @@ The action to register. #### Defined in -[packages/core/src/runtime.ts:438](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L438) +[packages/core/src/runtime.ts:453](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L453) *** @@ -588,7 +596,7 @@ The evaluator to register. #### Defined in -[packages/core/src/runtime.ts:447](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L447) +[packages/core/src/runtime.ts:462](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L462) *** @@ -610,7 +618,7 @@ The context provider to register. #### Defined in -[packages/core/src/runtime.ts:455](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L455) +[packages/core/src/runtime.ts:470](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L470) *** @@ -642,7 +650,7 @@ The message to process. #### Defined in -[packages/core/src/runtime.ts:464](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L464) +[packages/core/src/runtime.ts:479](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L479) *** @@ -678,7 +686,7 @@ The results of the evaluation. #### Defined in -[packages/core/src/runtime.ts:537](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L537) +[packages/core/src/runtime.ts:556](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L556) *** @@ -710,7 +718,7 @@ An error if the participant cannot be added. #### Defined in -[packages/core/src/runtime.ts:607](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L607) +[packages/core/src/runtime.ts:626](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L626) *** @@ -746,7 +754,7 @@ The user name to ensure the existence of. #### Defined in -[packages/core/src/runtime.ts:623](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L623) +[packages/core/src/runtime.ts:642](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L642) *** @@ -770,7 +778,7 @@ The user name to ensure the existence of. #### Defined in -[packages/core/src/runtime.ts:643](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L643) +[packages/core/src/runtime.ts:662](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L662) *** @@ -800,7 +808,7 @@ The user name to ensure the existence of. #### Defined in -[packages/core/src/runtime.ts:660](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L660) +[packages/core/src/runtime.ts:679](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L679) *** @@ -831,7 +839,7 @@ An error if the room cannot be created. #### Defined in -[packages/core/src/runtime.ts:696](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L696) +[packages/core/src/runtime.ts:715](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L715) *** @@ -861,7 +869,7 @@ The state of the agent. #### Defined in -[packages/core/src/runtime.ts:709](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L709) +[packages/core/src/runtime.ts:728](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L728) *** @@ -883,4 +891,4 @@ The state of the agent. #### Defined in -[packages/core/src/runtime.ts:1181](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1181) +[packages/core/src/runtime.ts:1173](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1173) diff --git a/docs/api/classes/CacheManager.md b/docs/api/classes/CacheManager.md index f40b5390782..87e229ec358 100644 --- a/docs/api/classes/CacheManager.md +++ b/docs/api/classes/CacheManager.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / CacheManager +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / CacheManager # Class: CacheManager\ diff --git a/docs/api/classes/DatabaseAdapter.md b/docs/api/classes/DatabaseAdapter.md index 3857152e719..4bdf7c2357b 100644 --- a/docs/api/classes/DatabaseAdapter.md +++ b/docs/api/classes/DatabaseAdapter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / DatabaseAdapter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / DatabaseAdapter # Class: `abstract` DatabaseAdapter\ @@ -109,6 +109,8 @@ Retrieves memories based on the specified parameters. An object containing parameters for the memory retrieval. +• **params.agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` + • **params.roomId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` • **params.count?**: `number` @@ -141,7 +143,7 @@ A Promise that resolves to an array of Memory objects. • **params** -• **params.agentId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +• **params.agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` • **params.roomIds**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\`[] @@ -157,7 +159,7 @@ A Promise that resolves to an array of Memory objects. #### Defined in -[packages/core/src/database.ts:48](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L48) +[packages/core/src/database.ts:49](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L49) *** @@ -179,7 +181,7 @@ A Promise that resolves to an array of Memory objects. #### Defined in -[packages/core/src/database.ts:54](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L54) +[packages/core/src/database.ts:55](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L55) *** @@ -219,7 +221,7 @@ A Promise that resolves to an array of objects containing embeddings and levensh #### Defined in -[packages/core/src/database.ts:61](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L61) +[packages/core/src/database.ts:62](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L62) *** @@ -255,7 +257,7 @@ A Promise that resolves when the log entry has been saved. #### Defined in -[packages/core/src/database.ts:87](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L87) +[packages/core/src/database.ts:88](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L88) *** @@ -285,7 +287,7 @@ A Promise that resolves to an array of Actor objects. #### Defined in -[packages/core/src/database.ts:99](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L99) +[packages/core/src/database.ts:100](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L100) *** @@ -303,6 +305,8 @@ An object containing parameters for the memory search. • **params.tableName**: `string` +• **params.agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` + • **params.roomId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` • **params.embedding**: `number`[] @@ -325,7 +329,7 @@ A Promise that resolves to an array of Memory objects. #### Defined in -[packages/core/src/database.ts:106](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L106) +[packages/core/src/database.ts:107](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L107) *** @@ -357,7 +361,7 @@ A Promise that resolves when the goal status has been updated. #### Defined in -[packages/core/src/database.ts:120](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L120) +[packages/core/src/database.ts:122](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L122) *** @@ -401,7 +405,7 @@ A Promise that resolves to an array of Memory objects. #### Defined in -[packages/core/src/database.ts:131](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L131) +[packages/core/src/database.ts:133](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L133) *** @@ -437,7 +441,7 @@ A Promise that resolves when the memory has been created. #### Defined in -[packages/core/src/database.ts:150](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L150) +[packages/core/src/database.ts:152](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L152) *** @@ -469,7 +473,7 @@ A Promise that resolves when the memory has been removed. #### Defined in -[packages/core/src/database.ts:162](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L162) +[packages/core/src/database.ts:164](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L164) *** @@ -501,7 +505,7 @@ A Promise that resolves when all memories have been removed. #### Defined in -[packages/core/src/database.ts:170](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L170) +[packages/core/src/database.ts:172](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L172) *** @@ -537,7 +541,7 @@ A Promise that resolves to the number of memories. #### Defined in -[packages/core/src/database.ts:179](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L179) +[packages/core/src/database.ts:181](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L181) *** @@ -553,6 +557,8 @@ Retrieves goals based on specified parameters. An object containing parameters for goal retrieval. +• **params.agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` + • **params.roomId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` • **params.userId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` @@ -573,7 +579,7 @@ A Promise that resolves to an array of Goal objects. #### Defined in -[packages/core/src/database.ts:190](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L190) +[packages/core/src/database.ts:192](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L192) *** @@ -601,7 +607,7 @@ A Promise that resolves when the goal has been updated. #### Defined in -[packages/core/src/database.ts:202](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L202) +[packages/core/src/database.ts:205](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L205) *** @@ -629,7 +635,7 @@ A Promise that resolves when the goal has been created. #### Defined in -[packages/core/src/database.ts:209](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L209) +[packages/core/src/database.ts:212](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L212) *** @@ -657,7 +663,7 @@ A Promise that resolves when the goal has been removed. #### Defined in -[packages/core/src/database.ts:216](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L216) +[packages/core/src/database.ts:219](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L219) *** @@ -685,7 +691,7 @@ A Promise that resolves when all goals have been removed. #### Defined in -[packages/core/src/database.ts:223](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L223) +[packages/core/src/database.ts:226](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L226) *** @@ -713,7 +719,7 @@ A Promise that resolves to the room ID or null if not found. #### Defined in -[packages/core/src/database.ts:230](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L230) +[packages/core/src/database.ts:233](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L233) *** @@ -741,7 +747,7 @@ A Promise that resolves to the UUID of the created room. #### Defined in -[packages/core/src/database.ts:237](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L237) +[packages/core/src/database.ts:240](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L240) *** @@ -769,7 +775,7 @@ A Promise that resolves when the room has been removed. #### Defined in -[packages/core/src/database.ts:244](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L244) +[packages/core/src/database.ts:247](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L247) *** @@ -797,7 +803,7 @@ A Promise that resolves to an array of room IDs. #### Defined in -[packages/core/src/database.ts:251](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L251) +[packages/core/src/database.ts:254](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L254) *** @@ -825,7 +831,7 @@ A Promise that resolves to an array of room IDs. #### Defined in -[packages/core/src/database.ts:258](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L258) +[packages/core/src/database.ts:261](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L261) *** @@ -857,7 +863,7 @@ A Promise that resolves to a boolean indicating success or failure. #### Defined in -[packages/core/src/database.ts:266](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L266) +[packages/core/src/database.ts:269](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L269) *** @@ -889,7 +895,7 @@ A Promise that resolves to a boolean indicating success or failure. #### Defined in -[packages/core/src/database.ts:274](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L274) +[packages/core/src/database.ts:277](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L277) *** @@ -919,7 +925,7 @@ A Promise that resolves to an array of Participant objects. ##### Defined in -[packages/core/src/database.ts:281](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L281) +[packages/core/src/database.ts:284](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L284) #### getParticipantsForAccount(userId) @@ -945,7 +951,7 @@ A Promise that resolves to an array of Participant objects. ##### Defined in -[packages/core/src/database.ts:288](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L288) +[packages/core/src/database.ts:291](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L291) *** @@ -973,7 +979,7 @@ A Promise that resolves to an array of UUIDs representing the participants. #### Defined in -[packages/core/src/database.ts:295](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L295) +[packages/core/src/database.ts:298](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L298) *** @@ -997,7 +1003,7 @@ A Promise that resolves to an array of UUIDs representing the participants. #### Defined in -[packages/core/src/database.ts:297](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L297) +[packages/core/src/database.ts:300](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L300) *** @@ -1023,7 +1029,7 @@ A Promise that resolves to an array of UUIDs representing the participants. #### Defined in -[packages/core/src/database.ts:301](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L301) +[packages/core/src/database.ts:304](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L304) *** @@ -1055,7 +1061,7 @@ A Promise that resolves to a boolean indicating success or failure of the creati #### Defined in -[packages/core/src/database.ts:312](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L312) +[packages/core/src/database.ts:315](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L315) *** @@ -1087,7 +1093,7 @@ A Promise that resolves to the Relationship object or null if not found. #### Defined in -[packages/core/src/database.ts:322](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L322) +[packages/core/src/database.ts:325](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L325) *** @@ -1117,4 +1123,4 @@ A Promise that resolves to an array of Relationship objects. #### Defined in -[packages/core/src/database.ts:332](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L332) +[packages/core/src/database.ts:335](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L335) diff --git a/docs/api/classes/DbCacheAdapter.md b/docs/api/classes/DbCacheAdapter.md index 9741c265a3b..439bf2f0d00 100644 --- a/docs/api/classes/DbCacheAdapter.md +++ b/docs/api/classes/DbCacheAdapter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / DbCacheAdapter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / DbCacheAdapter # Class: DbCacheAdapter diff --git a/docs/api/classes/FsCacheAdapter.md b/docs/api/classes/FsCacheAdapter.md index 1c1b15c6302..f9926e4cd3e 100644 --- a/docs/api/classes/FsCacheAdapter.md +++ b/docs/api/classes/FsCacheAdapter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / FsCacheAdapter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / FsCacheAdapter # Class: FsCacheAdapter diff --git a/docs/api/classes/MemoryCacheAdapter.md b/docs/api/classes/MemoryCacheAdapter.md index dbaaac091a1..943c245e918 100644 --- a/docs/api/classes/MemoryCacheAdapter.md +++ b/docs/api/classes/MemoryCacheAdapter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / MemoryCacheAdapter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / MemoryCacheAdapter # Class: MemoryCacheAdapter diff --git a/docs/api/classes/MemoryManager.md b/docs/api/classes/MemoryManager.md index 94767f7be77..554be5e5de7 100644 --- a/docs/api/classes/MemoryManager.md +++ b/docs/api/classes/MemoryManager.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / MemoryManager +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / MemoryManager # Class: MemoryManager @@ -76,19 +76,25 @@ The name of the database table this manager operates on. > **addEmbeddingToMemory**(`memory`): `Promise`\<[`Memory`](../interfaces/Memory.md)\> -Adds an embedding vector to a memory object. If the memory already has an embedding, it is returned as is. +Adds an embedding vector to a memory object if one doesn't already exist. +The embedding is generated from the memory's text content using the runtime's +embedding model. If the memory has no text content, an error is thrown. #### Parameters • **memory**: [`Memory`](../interfaces/Memory.md) -The memory object to add an embedding to. +The memory object to add an embedding to #### Returns `Promise`\<[`Memory`](../interfaces/Memory.md)\> -A Promise resolving to the memory object, potentially updated with an embedding vector. +The memory object with an embedding vector added + +#### Throws + +Error if the memory content is empty #### Implementation of @@ -96,7 +102,7 @@ A Promise resolving to the memory object, potentially updated with an embedding #### Defined in -[packages/core/src/memory.ts:46](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L46) +[packages/core/src/memory.ts:55](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L55) *** @@ -124,8 +130,6 @@ The number of memories to retrieve. Whether to retrieve unique memories only. -• **opts.agentId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` - • **opts.start?**: `number` • **opts.end?**: `number` @@ -142,7 +146,7 @@ A Promise resolving to an array of Memory objects. #### Defined in -[packages/core/src/memory.ts:67](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L67) +[packages/core/src/memory.ts:90](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L90) *** @@ -164,7 +168,7 @@ A Promise resolving to an array of Memory objects. #### Defined in -[packages/core/src/memory.ts:94](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L94) +[packages/core/src/memory.ts:114](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L114) *** @@ -188,8 +192,6 @@ Options including match threshold, count, user IDs, and uniqueness. The similarity threshold for matching memories. -• **opts.agentId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` - • **opts.count?**: `number` The maximum number of memories to retrieve. @@ -214,7 +216,7 @@ A Promise resolving to an array of Memory objects that match the embedding. #### Defined in -[packages/core/src/memory.ts:121](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L121) +[packages/core/src/memory.ts:140](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L140) *** @@ -246,7 +248,7 @@ A Promise that resolves when the operation completes. #### Defined in -[packages/core/src/memory.ts:161](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L161) +[packages/core/src/memory.ts:175](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L175) *** @@ -258,8 +260,6 @@ A Promise that resolves when the operation completes. • **params** -• **params.agentId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` - • **params.roomIds**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\`[] #### Returns @@ -272,7 +272,7 @@ A Promise that resolves when the operation completes. #### Defined in -[packages/core/src/memory.ts:178](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L178) +[packages/core/src/memory.ts:195](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L195) *** @@ -294,7 +294,7 @@ A Promise that resolves when the operation completes. #### Defined in -[packages/core/src/memory.ts:189](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L189) +[packages/core/src/memory.ts:202](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L202) *** @@ -322,7 +322,7 @@ A Promise that resolves when the operation completes. #### Defined in -[packages/core/src/memory.ts:199](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L199) +[packages/core/src/memory.ts:213](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L213) *** @@ -350,7 +350,7 @@ A Promise that resolves when the operation completes. #### Defined in -[packages/core/src/memory.ts:211](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L211) +[packages/core/src/memory.ts:225](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L225) *** @@ -382,4 +382,4 @@ A Promise resolving to the count of memories. #### Defined in -[packages/core/src/memory.ts:224](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L224) +[packages/core/src/memory.ts:238](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L238) diff --git a/docs/api/classes/Service.md b/docs/api/classes/Service.md index bda1c2f936b..247cf5ed9b1 100644 --- a/docs/api/classes/Service.md +++ b/docs/api/classes/Service.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / Service +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Service # Class: `abstract` Service @@ -36,7 +36,7 @@ #### Defined in -[packages/core/src/types.ts:569](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L569) +[packages/core/src/types.ts:916](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L916) *** @@ -52,7 +52,7 @@ #### Defined in -[packages/core/src/types.ts:580](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L580) +[packages/core/src/types.ts:927](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L927) ## Methods @@ -70,7 +70,7 @@ #### Defined in -[packages/core/src/types.ts:573](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L573) +[packages/core/src/types.ts:920](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L920) *** @@ -90,4 +90,4 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) +[packages/core/src/types.ts:932](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L932) diff --git a/docs/api/enumerations/Clients.md b/docs/api/enumerations/Clients.md index 1b7aaaea026..24618d7be48 100644 --- a/docs/api/enumerations/Clients.md +++ b/docs/api/enumerations/Clients.md @@ -1,7 +1,9 @@ -[@ai16z/eliza v0.1.3](../index.md) / Clients +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Clients # Enumeration: Clients +Available client platforms + ## Enumeration Members ### DISCORD @@ -10,7 +12,7 @@ #### Defined in -[packages/core/src/types.ts:325](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L325) +[packages/core/src/types.ts:582](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L582) *** @@ -20,7 +22,7 @@ #### Defined in -[packages/core/src/types.ts:326](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L326) +[packages/core/src/types.ts:583](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L583) *** @@ -30,7 +32,7 @@ #### Defined in -[packages/core/src/types.ts:327](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L327) +[packages/core/src/types.ts:584](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L584) *** @@ -40,4 +42,4 @@ #### Defined in -[packages/core/src/types.ts:328](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L328) +[packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) diff --git a/docs/api/enumerations/GoalStatus.md b/docs/api/enumerations/GoalStatus.md index 541c40702c1..5d29385dddb 100644 --- a/docs/api/enumerations/GoalStatus.md +++ b/docs/api/enumerations/GoalStatus.md @@ -1,7 +1,9 @@ -[@ai16z/eliza v0.1.3](../index.md) / GoalStatus +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / GoalStatus # Enumeration: GoalStatus +Status enum for goals + ## Enumeration Members ### DONE @@ -10,7 +12,7 @@ #### Defined in -[packages/core/src/types.ts:57](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L57) +[packages/core/src/types.ts:100](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L100) *** @@ -20,7 +22,7 @@ #### Defined in -[packages/core/src/types.ts:58](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L58) +[packages/core/src/types.ts:101](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L101) *** @@ -30,4 +32,4 @@ #### Defined in -[packages/core/src/types.ts:59](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L59) +[packages/core/src/types.ts:102](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L102) diff --git a/docs/api/enumerations/LoggingLevel.md b/docs/api/enumerations/LoggingLevel.md index 08c3238bb01..d255ea3a198 100644 --- a/docs/api/enumerations/LoggingLevel.md +++ b/docs/api/enumerations/LoggingLevel.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / LoggingLevel +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / LoggingLevel # Enumeration: LoggingLevel @@ -10,7 +10,7 @@ #### Defined in -[packages/core/src/types.ts:734](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L734) +[packages/core/src/types.ts:1089](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1089) *** @@ -20,7 +20,7 @@ #### Defined in -[packages/core/src/types.ts:735](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L735) +[packages/core/src/types.ts:1090](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1090) *** @@ -30,4 +30,4 @@ #### Defined in -[packages/core/src/types.ts:736](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L736) +[packages/core/src/types.ts:1091](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1091) diff --git a/docs/api/enumerations/ModelClass.md b/docs/api/enumerations/ModelClass.md index 836c2869d78..abfb7b4ecf1 100644 --- a/docs/api/enumerations/ModelClass.md +++ b/docs/api/enumerations/ModelClass.md @@ -1,7 +1,9 @@ -[@ai16z/eliza v0.1.3](../index.md) / ModelClass +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / ModelClass # Enumeration: ModelClass +Model size/type classification + ## Enumeration Members ### SMALL @@ -10,7 +12,7 @@ #### Defined in -[packages/core/src/types.ts:75](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L75) +[packages/core/src/types.ts:132](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L132) *** @@ -20,7 +22,7 @@ #### Defined in -[packages/core/src/types.ts:76](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L76) +[packages/core/src/types.ts:133](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L133) *** @@ -30,7 +32,7 @@ #### Defined in -[packages/core/src/types.ts:77](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L77) +[packages/core/src/types.ts:134](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L134) *** @@ -40,7 +42,7 @@ #### Defined in -[packages/core/src/types.ts:78](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L78) +[packages/core/src/types.ts:135](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L135) *** @@ -50,4 +52,4 @@ #### Defined in -[packages/core/src/types.ts:79](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L79) +[packages/core/src/types.ts:136](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L136) diff --git a/docs/api/enumerations/ModelProviderName.md b/docs/api/enumerations/ModelProviderName.md index 49c6c126e82..afb8063ad30 100644 --- a/docs/api/enumerations/ModelProviderName.md +++ b/docs/api/enumerations/ModelProviderName.md @@ -1,7 +1,9 @@ -[@ai16z/eliza v0.1.3](../index.md) / ModelProviderName +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / ModelProviderName # Enumeration: ModelProviderName +Available model providers + ## Enumeration Members ### OPENAI @@ -10,7 +12,7 @@ #### 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:207](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L207) *** @@ -20,7 +22,7 @@ #### 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:208](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L208) *** @@ -30,7 +32,7 @@ #### 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:209](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L209) *** @@ -40,7 +42,7 @@ #### 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:210](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L210) *** @@ -50,7 +52,7 @@ #### 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:211](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L211) *** @@ -60,7 +62,7 @@ #### 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:212](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L212) *** @@ -70,7 +72,7 @@ #### 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:213](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L213) *** @@ -80,7 +82,7 @@ #### 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:214](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L214) *** @@ -90,7 +92,7 @@ #### Defined in -[packages/core/src/types.ts:129](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L129) +[packages/core/src/types.ts:215](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L215) *** @@ -100,7 +102,7 @@ #### Defined in -[packages/core/src/types.ts:130](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L130) +[packages/core/src/types.ts:216](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L216) *** @@ -110,7 +112,7 @@ #### Defined in -[packages/core/src/types.ts:131](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L131) +[packages/core/src/types.ts:217](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L217) *** @@ -120,4 +122,4 @@ #### Defined in -[packages/core/src/types.ts:132](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L132) +[packages/core/src/types.ts:218](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L218) diff --git a/docs/api/enumerations/ServiceType.md b/docs/api/enumerations/ServiceType.md index f48acfc3dba..bbd3c04efd4 100644 --- a/docs/api/enumerations/ServiceType.md +++ b/docs/api/enumerations/ServiceType.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / ServiceType +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / ServiceType # Enumeration: ServiceType @@ -10,7 +10,7 @@ #### Defined in -[packages/core/src/types.ts:724](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L724) +[packages/core/src/types.ts:1079](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1079) *** @@ -20,7 +20,7 @@ #### Defined in -[packages/core/src/types.ts:725](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L725) +[packages/core/src/types.ts:1080](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1080) *** @@ -30,7 +30,7 @@ #### Defined in -[packages/core/src/types.ts:726](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L726) +[packages/core/src/types.ts:1081](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1081) *** @@ -40,7 +40,7 @@ #### Defined in -[packages/core/src/types.ts:727](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L727) +[packages/core/src/types.ts:1082](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1082) *** @@ -50,7 +50,7 @@ #### Defined in -[packages/core/src/types.ts:728](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L728) +[packages/core/src/types.ts:1083](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1083) *** @@ -60,7 +60,7 @@ #### Defined in -[packages/core/src/types.ts:729](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L729) +[packages/core/src/types.ts:1084](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1084) *** @@ -70,4 +70,4 @@ #### Defined in -[packages/core/src/types.ts:730](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L730) +[packages/core/src/types.ts:1085](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1085) diff --git a/docs/api/functions/addHeader.md b/docs/api/functions/addHeader.md index bfda94553de..5a8709f6d3a 100644 --- a/docs/api/functions/addHeader.md +++ b/docs/api/functions/addHeader.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / addHeader +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / addHeader # Function: addHeader() diff --git a/docs/api/functions/composeActionExamples.md b/docs/api/functions/composeActionExamples.md index 874ac875dae..556f4e127e8 100644 --- a/docs/api/functions/composeActionExamples.md +++ b/docs/api/functions/composeActionExamples.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / composeActionExamples +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / composeActionExamples # Function: composeActionExamples() diff --git a/docs/api/functions/composeContext.md b/docs/api/functions/composeContext.md index 54a0faa40bb..f49d6702445 100644 --- a/docs/api/functions/composeContext.md +++ b/docs/api/functions/composeContext.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / composeContext +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / composeContext # Function: composeContext() diff --git a/docs/api/functions/configureSettings.md b/docs/api/functions/configureSettings.md index 11d317bcf28..9eb534d423b 100644 --- a/docs/api/functions/configureSettings.md +++ b/docs/api/functions/configureSettings.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / configureSettings +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / configureSettings # Function: configureSettings() diff --git a/docs/api/functions/createGoal.md b/docs/api/functions/createGoal.md index 1399ead1dd4..613e4c5faf4 100644 --- a/docs/api/functions/createGoal.md +++ b/docs/api/functions/createGoal.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / createGoal +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / createGoal # Function: createGoal() @@ -18,4 +18,4 @@ ## Defined in -[packages/core/src/goals.ts:54](https://github.com/ai16z/eliza/blob/main/packages/core/src/goals.ts#L54) +[packages/core/src/goals.ts:55](https://github.com/ai16z/eliza/blob/main/packages/core/src/goals.ts#L55) diff --git a/docs/api/functions/createRelationship.md b/docs/api/functions/createRelationship.md index 8e5295722d2..cca297599b3 100644 --- a/docs/api/functions/createRelationship.md +++ b/docs/api/functions/createRelationship.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / createRelationship +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / createRelationship # Function: createRelationship() diff --git a/docs/api/functions/embed.md b/docs/api/functions/embed.md index 82302647eba..48d8d162956 100644 --- a/docs/api/functions/embed.md +++ b/docs/api/functions/embed.md @@ -1,25 +1,27 @@ -[@ai16z/eliza v0.1.3](../index.md) / embed +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / embed # Function: embed() > **embed**(`runtime`, `input`): `Promise`\<`number`[]\> -Send a message to the OpenAI API for embedding. +Generate embeddings for input text using configured model provider ## Parameters • **runtime**: [`IAgentRuntime`](../interfaces/IAgentRuntime.md) +The agent runtime containing model configuration + • **input**: `string` -The input to be embedded. +The text to generate embeddings for ## Returns `Promise`\<`number`[]\> -The embedding of the input. +Array of embedding numbers ## Defined in -[packages/core/src/embedding.ts:73](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L73) +[packages/core/src/embedding.ts:79](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L79) diff --git a/docs/api/functions/findNearestEnvFile.md b/docs/api/functions/findNearestEnvFile.md index d5552beecb9..456d1f1cf00 100644 --- a/docs/api/functions/findNearestEnvFile.md +++ b/docs/api/functions/findNearestEnvFile.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / findNearestEnvFile +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / findNearestEnvFile # Function: findNearestEnvFile() diff --git a/docs/api/functions/formatActionNames.md b/docs/api/functions/formatActionNames.md index e1a21cc91eb..06a8acc87ae 100644 --- a/docs/api/functions/formatActionNames.md +++ b/docs/api/functions/formatActionNames.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatActionNames +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatActionNames # Function: formatActionNames() diff --git a/docs/api/functions/formatActions.md b/docs/api/functions/formatActions.md index 0d88e97bda1..207c94346e9 100644 --- a/docs/api/functions/formatActions.md +++ b/docs/api/functions/formatActions.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatActions +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatActions # Function: formatActions() diff --git a/docs/api/functions/formatActors.md b/docs/api/functions/formatActors.md index 2f6a1c00ffc..00d73ee560d 100644 --- a/docs/api/functions/formatActors.md +++ b/docs/api/functions/formatActors.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatActors +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatActors # Function: formatActors() diff --git a/docs/api/functions/formatEvaluatorExampleDescriptions.md b/docs/api/functions/formatEvaluatorExampleDescriptions.md index 57963220d10..fc59fb21841 100644 --- a/docs/api/functions/formatEvaluatorExampleDescriptions.md +++ b/docs/api/functions/formatEvaluatorExampleDescriptions.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatEvaluatorExampleDescriptions +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatEvaluatorExampleDescriptions # Function: formatEvaluatorExampleDescriptions() diff --git a/docs/api/functions/formatEvaluatorExamples.md b/docs/api/functions/formatEvaluatorExamples.md index 20003df3df6..7dd744e34d4 100644 --- a/docs/api/functions/formatEvaluatorExamples.md +++ b/docs/api/functions/formatEvaluatorExamples.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatEvaluatorExamples +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatEvaluatorExamples # Function: formatEvaluatorExamples() diff --git a/docs/api/functions/formatEvaluatorNames.md b/docs/api/functions/formatEvaluatorNames.md index 27314144a9f..9b7a0895a2c 100644 --- a/docs/api/functions/formatEvaluatorNames.md +++ b/docs/api/functions/formatEvaluatorNames.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatEvaluatorNames +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatEvaluatorNames # Function: formatEvaluatorNames() diff --git a/docs/api/functions/formatEvaluators.md b/docs/api/functions/formatEvaluators.md index bfc6d78cbfb..44df6f07095 100644 --- a/docs/api/functions/formatEvaluators.md +++ b/docs/api/functions/formatEvaluators.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatEvaluators +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatEvaluators # Function: formatEvaluators() diff --git a/docs/api/functions/formatGoalsAsString.md b/docs/api/functions/formatGoalsAsString.md index b285e36af75..6198cfeac6d 100644 --- a/docs/api/functions/formatGoalsAsString.md +++ b/docs/api/functions/formatGoalsAsString.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatGoalsAsString +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatGoalsAsString # Function: formatGoalsAsString() @@ -16,4 +16,4 @@ ## Defined in -[packages/core/src/goals.ts:29](https://github.com/ai16z/eliza/blob/main/packages/core/src/goals.ts#L29) +[packages/core/src/goals.ts:30](https://github.com/ai16z/eliza/blob/main/packages/core/src/goals.ts#L30) diff --git a/docs/api/functions/formatMessages.md b/docs/api/functions/formatMessages.md index aafcfb14a14..35519d0ea5d 100644 --- a/docs/api/functions/formatMessages.md +++ b/docs/api/functions/formatMessages.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatMessages +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatMessages # Function: formatMessages() diff --git a/docs/api/functions/formatPosts.md b/docs/api/functions/formatPosts.md index 02685ef272b..6e99854957c 100644 --- a/docs/api/functions/formatPosts.md +++ b/docs/api/functions/formatPosts.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatPosts +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatPosts # Function: formatPosts() diff --git a/docs/api/functions/formatRelationships.md b/docs/api/functions/formatRelationships.md index 290c550fec8..b31a00409fd 100644 --- a/docs/api/functions/formatRelationships.md +++ b/docs/api/functions/formatRelationships.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatRelationships +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatRelationships # Function: formatRelationships() diff --git a/docs/api/functions/formatTimestamp.md b/docs/api/functions/formatTimestamp.md index 7d3b761c1ac..e44e99777ff 100644 --- a/docs/api/functions/formatTimestamp.md +++ b/docs/api/functions/formatTimestamp.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / formatTimestamp +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / formatTimestamp # Function: formatTimestamp() diff --git a/docs/api/functions/generateCaption.md b/docs/api/functions/generateCaption.md index 38e8ad7aa8b..98546b71f05 100644 --- a/docs/api/functions/generateCaption.md +++ b/docs/api/functions/generateCaption.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / generateCaption +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / generateCaption # Function: generateCaption() @@ -26,4 +26,4 @@ ## Defined in -[packages/core/src/generation.ts:858](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L858) +[packages/core/src/generation.ts:874](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L874) diff --git a/docs/api/functions/generateImage.md b/docs/api/functions/generateImage.md index 5ca6b31fc0a..003aa1805cb 100644 --- a/docs/api/functions/generateImage.md +++ b/docs/api/functions/generateImage.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / generateImage +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / generateImage # Function: generateImage() @@ -48,4 +48,4 @@ ## Defined in -[packages/core/src/generation.ts:730](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L730) +[packages/core/src/generation.ts:746](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L746) diff --git a/docs/api/functions/generateMessageResponse.md b/docs/api/functions/generateMessageResponse.md index 68604ca21c8..c66e2368eba 100644 --- a/docs/api/functions/generateMessageResponse.md +++ b/docs/api/functions/generateMessageResponse.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / generateMessageResponse +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / generateMessageResponse # Function: generateMessageResponse() @@ -28,4 +28,4 @@ The completed message. ## Defined in -[packages/core/src/generation.ts:690](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L690) +[packages/core/src/generation.ts:706](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L706) diff --git a/docs/api/functions/generateObject.md b/docs/api/functions/generateObject.md index d5f14247dc8..bb78a86d9f6 100644 --- a/docs/api/functions/generateObject.md +++ b/docs/api/functions/generateObject.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / generateObject +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / generateObject # Function: generateObject() @@ -20,4 +20,4 @@ ## Defined in -[packages/core/src/generation.ts:606](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L606) +[packages/core/src/generation.ts:622](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L622) diff --git a/docs/api/functions/generateObjectArray.md b/docs/api/functions/generateObjectArray.md index dc6e0b5858b..e69fdb87bda 100644 --- a/docs/api/functions/generateObjectArray.md +++ b/docs/api/functions/generateObjectArray.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / generateObjectArray +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / generateObjectArray # Function: generateObjectArray() @@ -20,4 +20,4 @@ ## Defined in -[packages/core/src/generation.ts:642](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L642) +[packages/core/src/generation.ts:658](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L658) diff --git a/docs/api/functions/generateObjectV2.md b/docs/api/functions/generateObjectV2.md index b44fca3a881..297529a2d2c 100644 --- a/docs/api/functions/generateObjectV2.md +++ b/docs/api/functions/generateObjectV2.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / generateObjectV2 +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / generateObjectV2 # Function: generateObjectV2() @@ -24,4 +24,4 @@ Configuration options for generating objects. ## Defined in -[packages/core/src/generation.ts:914](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L914) +[packages/core/src/generation.ts:931](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L931) diff --git a/docs/api/functions/generateShouldRespond.md b/docs/api/functions/generateShouldRespond.md index 35e8cdb7632..2c9adb73455 100644 --- a/docs/api/functions/generateShouldRespond.md +++ b/docs/api/functions/generateShouldRespond.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / generateShouldRespond +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / generateShouldRespond # Function: generateShouldRespond() @@ -28,4 +28,4 @@ Promise resolving to "RESPOND", "IGNORE", "STOP" or null ## Defined in -[packages/core/src/generation.ts:414](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L414) +[packages/core/src/generation.ts:447](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L447) diff --git a/docs/api/functions/generateText.md b/docs/api/functions/generateText.md index 63db35836da..1fcc720611f 100644 --- a/docs/api/functions/generateText.md +++ b/docs/api/functions/generateText.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / generateText +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / generateText # Function: generateText() @@ -32,4 +32,4 @@ The completed message. ## Defined in -[packages/core/src/generation.ts:48](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L48) +[packages/core/src/generation.ts:49](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L49) diff --git a/docs/api/functions/generateTextArray.md b/docs/api/functions/generateTextArray.md index f3f0ac4349b..da52a818825 100644 --- a/docs/api/functions/generateTextArray.md +++ b/docs/api/functions/generateTextArray.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / generateTextArray +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / generateTextArray # Function: generateTextArray() @@ -28,4 +28,4 @@ Promise resolving to an array of strings parsed from the model's response ## Defined in -[packages/core/src/generation.ts:570](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L570) +[packages/core/src/generation.ts:586](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L586) diff --git a/docs/api/functions/generateTrueOrFalse.md b/docs/api/functions/generateTrueOrFalse.md index fe69303c038..f60239caf9d 100644 --- a/docs/api/functions/generateTrueOrFalse.md +++ b/docs/api/functions/generateTrueOrFalse.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / generateTrueOrFalse +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / generateTrueOrFalse # Function: generateTrueOrFalse() @@ -28,4 +28,4 @@ Promise resolving to a boolean value parsed from the model's response ## Defined in -[packages/core/src/generation.ts:514](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L514) +[packages/core/src/generation.ts:530](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L530) diff --git a/docs/api/functions/getActorDetails.md b/docs/api/functions/getActorDetails.md index 2d8482acdaa..ea912f70b80 100644 --- a/docs/api/functions/getActorDetails.md +++ b/docs/api/functions/getActorDetails.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / getActorDetails +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / getActorDetails # Function: getActorDetails() diff --git a/docs/api/functions/getEndpoint.md b/docs/api/functions/getEndpoint.md index 0286d8bf989..bb9661c5f2d 100644 --- a/docs/api/functions/getEndpoint.md +++ b/docs/api/functions/getEndpoint.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / getEndpoint +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / getEndpoint # Function: getEndpoint() diff --git a/docs/api/functions/getEnvVariable.md b/docs/api/functions/getEnvVariable.md index ad234562432..10d98a4f21d 100644 --- a/docs/api/functions/getEnvVariable.md +++ b/docs/api/functions/getEnvVariable.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / getEnvVariable +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / getEnvVariable # Function: getEnvVariable() diff --git a/docs/api/functions/getGoals.md b/docs/api/functions/getGoals.md index ac534f38b60..d7e4fe60af5 100644 --- a/docs/api/functions/getGoals.md +++ b/docs/api/functions/getGoals.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / getGoals +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / getGoals # Function: getGoals() diff --git a/docs/api/functions/getModel.md b/docs/api/functions/getModel.md index 518fd227bcb..02a11ba0cb9 100644 --- a/docs/api/functions/getModel.md +++ b/docs/api/functions/getModel.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / getModel +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / getModel # Function: getModel() diff --git a/docs/api/functions/getProviders.md b/docs/api/functions/getProviders.md index 601e51726ae..95e34e0d208 100644 --- a/docs/api/functions/getProviders.md +++ b/docs/api/functions/getProviders.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / getProviders +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / getProviders # Function: getProviders() diff --git a/docs/api/functions/getRelationship.md b/docs/api/functions/getRelationship.md index 95c5c61e861..d7b4c6bbeaf 100644 --- a/docs/api/functions/getRelationship.md +++ b/docs/api/functions/getRelationship.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / getRelationship +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / getRelationship # Function: getRelationship() diff --git a/docs/api/functions/getRelationships.md b/docs/api/functions/getRelationships.md index 78e623081ee..765c23e9dd2 100644 --- a/docs/api/functions/getRelationships.md +++ b/docs/api/functions/getRelationships.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / getRelationships +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / getRelationships # Function: getRelationships() diff --git a/docs/api/functions/handleProvider.md b/docs/api/functions/handleProvider.md index a818b7cc940..6a56c7f5668 100644 --- a/docs/api/functions/handleProvider.md +++ b/docs/api/functions/handleProvider.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / handleProvider +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / handleProvider # Function: handleProvider() @@ -20,4 +20,4 @@ Configuration options specific to the provider. ## Defined in -[packages/core/src/generation.ts:996](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L996) +[packages/core/src/generation.ts:1016](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L1016) diff --git a/docs/api/functions/hasEnvVariable.md b/docs/api/functions/hasEnvVariable.md index 4880d787076..af523d3e0e5 100644 --- a/docs/api/functions/hasEnvVariable.md +++ b/docs/api/functions/hasEnvVariable.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / hasEnvVariable +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / hasEnvVariable # Function: hasEnvVariable() diff --git a/docs/api/functions/loadEnvConfig.md b/docs/api/functions/loadEnvConfig.md index a65e3136df9..5c88953a078 100644 --- a/docs/api/functions/loadEnvConfig.md +++ b/docs/api/functions/loadEnvConfig.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / loadEnvConfig +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / loadEnvConfig # Function: loadEnvConfig() diff --git a/docs/api/functions/parseBooleanFromText.md b/docs/api/functions/parseBooleanFromText.md index f7782c40f0b..d334980b23e 100644 --- a/docs/api/functions/parseBooleanFromText.md +++ b/docs/api/functions/parseBooleanFromText.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / parseBooleanFromText +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / parseBooleanFromText # Function: parseBooleanFromText() diff --git a/docs/api/functions/parseJSONObjectFromText.md b/docs/api/functions/parseJSONObjectFromText.md index 8c7a7120229..5014b37ad63 100644 --- a/docs/api/functions/parseJSONObjectFromText.md +++ b/docs/api/functions/parseJSONObjectFromText.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / parseJSONObjectFromText +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / parseJSONObjectFromText # Function: parseJSONObjectFromText() diff --git a/docs/api/functions/parseJsonArrayFromText.md b/docs/api/functions/parseJsonArrayFromText.md index 2c786ff9b3b..077971eac0c 100644 --- a/docs/api/functions/parseJsonArrayFromText.md +++ b/docs/api/functions/parseJsonArrayFromText.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / parseJsonArrayFromText +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / parseJsonArrayFromText # Function: parseJsonArrayFromText() diff --git a/docs/api/functions/parseShouldRespondFromText.md b/docs/api/functions/parseShouldRespondFromText.md index 9d726595fb4..c77cb3ee291 100644 --- a/docs/api/functions/parseShouldRespondFromText.md +++ b/docs/api/functions/parseShouldRespondFromText.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / parseShouldRespondFromText +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / parseShouldRespondFromText # Function: parseShouldRespondFromText() diff --git a/docs/api/functions/retrieveCachedEmbedding.md b/docs/api/functions/retrieveCachedEmbedding.md index 285441bbd1f..92c4d067ccd 100644 --- a/docs/api/functions/retrieveCachedEmbedding.md +++ b/docs/api/functions/retrieveCachedEmbedding.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / retrieveCachedEmbedding +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / retrieveCachedEmbedding # Function: retrieveCachedEmbedding() @@ -16,4 +16,4 @@ ## Defined in -[packages/core/src/embedding.ts:168](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L168) +[packages/core/src/embedding.ts:210](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L210) diff --git a/docs/api/functions/splitChunks.md b/docs/api/functions/splitChunks.md index e10512dae2a..6379d967dce 100644 --- a/docs/api/functions/splitChunks.md +++ b/docs/api/functions/splitChunks.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / splitChunks +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / splitChunks # Function: splitChunks() @@ -12,11 +12,11 @@ Splits content into chunks of specified size with optional overlapping bleed sec The text content to split into chunks -• **chunkSize**: `number` +• **chunkSize**: `number` = `512` The maximum size of each chunk in tokens -• **bleed**: `number` = `100` +• **bleed**: `number` = `20` Number of characters to overlap between chunks (default: 100) @@ -28,4 +28,4 @@ Promise resolving to array of text chunks with bleed sections ## Defined in -[packages/core/src/generation.ts:470](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L470) +[packages/core/src/generation.ts:502](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L502) diff --git a/docs/api/functions/stringToUuid.md b/docs/api/functions/stringToUuid.md index 0e4a063a2ec..bbe7e3998a5 100644 --- a/docs/api/functions/stringToUuid.md +++ b/docs/api/functions/stringToUuid.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / stringToUuid +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / stringToUuid # Function: stringToUuid() diff --git a/docs/api/functions/trimTokens.md b/docs/api/functions/trimTokens.md index 9c4461df19e..d295b60ed86 100644 --- a/docs/api/functions/trimTokens.md +++ b/docs/api/functions/trimTokens.md @@ -1,27 +1,31 @@ -[@ai16z/eliza v0.1.3](../index.md) / trimTokens +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / trimTokens # Function: trimTokens() -> **trimTokens**(`context`, `maxTokens`, `model`): `any` +> **trimTokens**(`context`, `maxTokens`, `model`): `string` Truncate the context to the maximum length allowed by the model. ## Parameters -• **context**: `any` +• **context**: `string` -The context of the message to be completed. +The text to truncate -• **maxTokens**: `any` +• **maxTokens**: `number` -• **model**: `any` +Maximum number of tokens to keep -The model to use for generateText. +• **model**: `TiktokenModel` + +The tokenizer model to use ## Returns -`any` +`string` + +The truncated text ## Defined in -[packages/core/src/generation.ts:388](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L388) +[packages/core/src/generation.ts:397](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L397) diff --git a/docs/api/functions/updateGoal.md b/docs/api/functions/updateGoal.md index 4c8555bfe4f..1d40ed9c990 100644 --- a/docs/api/functions/updateGoal.md +++ b/docs/api/functions/updateGoal.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / updateGoal +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / updateGoal # Function: updateGoal() @@ -18,4 +18,4 @@ ## Defined in -[packages/core/src/goals.ts:44](https://github.com/ai16z/eliza/blob/main/packages/core/src/goals.ts#L44) +[packages/core/src/goals.ts:45](https://github.com/ai16z/eliza/blob/main/packages/core/src/goals.ts#L45) diff --git a/docs/api/functions/validateCharacterConfig.md b/docs/api/functions/validateCharacterConfig.md index 8a6cdfd1c39..c4add5baaed 100644 --- a/docs/api/functions/validateCharacterConfig.md +++ b/docs/api/functions/validateCharacterConfig.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / validateCharacterConfig +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / validateCharacterConfig # Function: validateCharacterConfig() diff --git a/docs/api/functions/validateEnv.md b/docs/api/functions/validateEnv.md index 7e8850cf098..781767d1a54 100644 --- a/docs/api/functions/validateEnv.md +++ b/docs/api/functions/validateEnv.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / validateEnv +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / validateEnv # Function: validateEnv() diff --git a/docs/api/index.md b/docs/api/index.md index e508615c91e..8140fb611a5 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,4 +1,4 @@ -# @ai16z/eliza v0.1.3 +# @ai16z/eliza v0.1.4-alpha.3 ## Enumerations @@ -69,6 +69,7 @@ - [Plugin](type-aliases/Plugin.md) - [Character](type-aliases/Character.md) - [CacheOptions](type-aliases/CacheOptions.md) +- [KnowledgeItem](type-aliases/KnowledgeItem.md) ## Variables @@ -76,6 +77,7 @@ - [envSchema](variables/envSchema.md) - [CharacterSchema](variables/CharacterSchema.md) - [evaluationTemplate](variables/evaluationTemplate.md) +- [knowledge](variables/knowledge.md) - [elizaLogger](variables/elizaLogger.md) - [embeddingDimension](variables/embeddingDimension.md) - [embeddingZeroVector](variables/embeddingZeroVector.md) diff --git a/docs/api/interfaces/Account.md b/docs/api/interfaces/Account.md index 5676c398b36..c7366448e49 100644 --- a/docs/api/interfaces/Account.md +++ b/docs/api/interfaces/Account.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Account +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Account # Interface: Account -Represents a user, including their name, details, and a unique identifier. +Represents a user account ## Properties @@ -10,9 +10,11 @@ Represents a user, including their name, details, and a unique identifier. > **id**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Unique identifier + #### Defined in -[packages/core/src/types.ts:276](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L276) +[packages/core/src/types.ts:478](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L478) *** @@ -20,9 +22,11 @@ Represents a user, including their name, details, and a unique identifier. > **name**: `string` +Display name + #### Defined in -[packages/core/src/types.ts:277](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L277) +[packages/core/src/types.ts:481](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L481) *** @@ -30,9 +34,11 @@ Represents a user, including their name, details, and a unique identifier. > **username**: `string` +Username + #### Defined in -[packages/core/src/types.ts:278](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L278) +[packages/core/src/types.ts:484](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L484) *** @@ -40,13 +46,15 @@ Represents a user, including their name, details, and a unique identifier. > `optional` **details**: `object` +Optional additional details + #### Index Signature \[`key`: `string`\]: `any` #### Defined in -[packages/core/src/types.ts:279](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L279) +[packages/core/src/types.ts:487](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L487) *** @@ -54,9 +62,11 @@ Represents a user, including their name, details, and a unique identifier. > `optional` **email**: `string` +Optional email + #### Defined in -[packages/core/src/types.ts:280](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L280) +[packages/core/src/types.ts:490](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L490) *** @@ -64,6 +74,8 @@ Represents a user, including their name, details, and a unique identifier. > `optional` **avatarUrl**: `string` +Optional avatar URL + #### Defined in -[packages/core/src/types.ts:281](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L281) +[packages/core/src/types.ts:493](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L493) diff --git a/docs/api/interfaces/Action.md b/docs/api/interfaces/Action.md index 9c04395703b..5f7bbb3b380 100644 --- a/docs/api/interfaces/Action.md +++ b/docs/api/interfaces/Action.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Action +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Action # Interface: Action -Represents an action that the agent can perform, including conditions for its use, a description, examples, a handler function, and a validation function. +Represents an action the agent can perform ## Properties @@ -10,9 +10,11 @@ Represents an action that the agent can perform, including conditions for its us > **similes**: `string`[] +Similar action descriptions + #### 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:377](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L377) *** @@ -20,9 +22,11 @@ Represents an action that the agent can perform, including conditions for its us > **description**: `string` +Detailed description + #### Defined in -[packages/core/src/types.ts:219](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L219) +[packages/core/src/types.ts:380](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L380) *** @@ -30,9 +34,11 @@ Represents an action that the agent can perform, including conditions for its us > **examples**: [`ActionExample`](ActionExample.md)[][] +Example usages + #### Defined in -[packages/core/src/types.ts:220](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L220) +[packages/core/src/types.ts:383](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L383) *** @@ -40,9 +46,11 @@ Represents an action that the agent can perform, including conditions for its us > **handler**: [`Handler`](../type-aliases/Handler.md) +Handler function + #### Defined in -[packages/core/src/types.ts:221](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L221) +[packages/core/src/types.ts:386](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L386) *** @@ -50,9 +58,11 @@ Represents an action that the agent can perform, including conditions for its us > **name**: `string` +Action name + #### Defined in -[packages/core/src/types.ts:222](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L222) +[packages/core/src/types.ts:389](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L389) *** @@ -60,6 +70,8 @@ Represents an action that the agent can perform, including conditions for its us > **validate**: [`Validator`](../type-aliases/Validator.md) +Validation function + #### Defined in -[packages/core/src/types.ts:223](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L223) +[packages/core/src/types.ts:392](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L392) diff --git a/docs/api/interfaces/ActionExample.md b/docs/api/interfaces/ActionExample.md index efe9fc8b069..7241d58fde5 100644 --- a/docs/api/interfaces/ActionExample.md +++ b/docs/api/interfaces/ActionExample.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / ActionExample +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / ActionExample # Interface: ActionExample -Represents an example of content, typically used for demonstrating or testing purposes. Includes user, content, optional action, and optional source. +Example content with associated user for demonstration purposes ## Properties @@ -10,9 +10,11 @@ Represents an example of content, typically used for demonstrating or testing pu > **user**: `string` +User associated with the example + #### Defined in -[packages/core/src/types.ts:25](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L25) +[packages/core/src/types.ts:39](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L39) *** @@ -20,6 +22,8 @@ Represents an example of content, typically used for demonstrating or testing pu > **content**: [`Content`](Content.md) +Content of the example + #### Defined in -[packages/core/src/types.ts:26](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L26) +[packages/core/src/types.ts:42](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L42) diff --git a/docs/api/interfaces/Actor.md b/docs/api/interfaces/Actor.md index fd721ef74bf..cd0e8d79d5d 100644 --- a/docs/api/interfaces/Actor.md +++ b/docs/api/interfaces/Actor.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Actor +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Actor # Interface: Actor -Represents an actor in the conversation, which could be a user or the agent itself, including their name, details (such as tagline, summary, and quote), and a unique identifier. +Represents an actor/participant in a conversation ## Properties @@ -10,9 +10,11 @@ Represents an actor in the conversation, which could be a user or the agent itse > **name**: `string` +Display name + #### Defined in -[packages/core/src/types.ts:41](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L41) +[packages/core/src/types.ts:61](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L61) *** @@ -20,9 +22,11 @@ Represents an actor in the conversation, which could be a user or the agent itse > **username**: `string` +Username/handle + #### Defined in -[packages/core/src/types.ts:42](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L42) +[packages/core/src/types.ts:64](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L64) *** @@ -30,21 +34,29 @@ Represents an actor in the conversation, which could be a user or the agent itse > **details**: `object` +Additional profile details + #### tagline > **tagline**: `string` +Short profile tagline + #### summary > **summary**: `string` +Longer profile summary + #### quote > **quote**: `string` +Favorite quote + #### Defined in -[packages/core/src/types.ts:43](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L43) +[packages/core/src/types.ts:67](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L67) *** @@ -52,6 +64,8 @@ Represents an actor in the conversation, which could be a user or the agent itse > **id**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Unique identifier + #### Defined in -[packages/core/src/types.ts:44](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L44) +[packages/core/src/types.ts:79](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L79) diff --git a/docs/api/interfaces/Content.md b/docs/api/interfaces/Content.md index ebfe580e37e..f34afcbd288 100644 --- a/docs/api/interfaces/Content.md +++ b/docs/api/interfaces/Content.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Content +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Content # Interface: Content -Represents the content of a message, including its main text (`content`), any associated action (`action`), and the source of the content (`source`), if applicable. +Represents the content of a message or communication ## Indexable @@ -14,9 +14,11 @@ Represents the content of a message, including its main text (`content`), any as > **text**: `string` +The main text content + #### Defined in -[packages/core/src/types.ts:12](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L12) +[packages/core/src/types.ts:13](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L13) *** @@ -24,9 +26,11 @@ Represents the content of a message, including its main text (`content`), any as > `optional` **action**: `string` +Optional action associated with the message + #### Defined in -[packages/core/src/types.ts:13](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L13) +[packages/core/src/types.ts:16](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L16) *** @@ -34,9 +38,11 @@ Represents the content of a message, including its main text (`content`), any as > `optional` **source**: `string` +Optional source/origin of the content + #### Defined in -[packages/core/src/types.ts:14](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L14) +[packages/core/src/types.ts:19](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L19) *** @@ -44,9 +50,11 @@ Represents the content of a message, including its main text (`content`), any as > `optional` **url**: `string` +URL of the original message/post (e.g. tweet URL, Discord message link) + #### Defined in -[packages/core/src/types.ts:15](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L15) +[packages/core/src/types.ts:22](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L22) *** @@ -54,9 +62,11 @@ Represents the content of a message, including its main text (`content`), any as > `optional` **inReplyTo**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +UUID of parent message if this is a reply/thread + #### Defined in -[packages/core/src/types.ts:16](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L16) +[packages/core/src/types.ts:25](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L25) *** @@ -64,6 +74,8 @@ Represents the content of a message, including its main text (`content`), any as > `optional` **attachments**: [`Media`](../type-aliases/Media.md)[] +Array of media attachments + #### Defined in -[packages/core/src/types.ts:17](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L17) +[packages/core/src/types.ts:28](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L28) diff --git a/docs/api/interfaces/ConversationExample.md b/docs/api/interfaces/ConversationExample.md index ce6a071f566..c89183e2cee 100644 --- a/docs/api/interfaces/ConversationExample.md +++ b/docs/api/interfaces/ConversationExample.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / ConversationExample +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / ConversationExample # Interface: ConversationExample -Represents an example of content, typically used for demonstrating or testing purposes. Includes user, content, optional action, and optional source. +Example conversation content with user ID ## Properties @@ -10,9 +10,11 @@ Represents an example of content, typically used for demonstrating or testing pu > **userId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +UUID of user in conversation + #### Defined in -[packages/core/src/types.ts:33](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L33) +[packages/core/src/types.ts:50](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L50) *** @@ -20,6 +22,8 @@ Represents an example of content, typically used for demonstrating or testing pu > **content**: [`Content`](Content.md) +Content of the conversation + #### Defined in -[packages/core/src/types.ts:34](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L34) +[packages/core/src/types.ts:53](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L53) diff --git a/docs/api/interfaces/EvaluationExample.md b/docs/api/interfaces/EvaluationExample.md index 55b58550e4a..986975ca97d 100644 --- a/docs/api/interfaces/EvaluationExample.md +++ b/docs/api/interfaces/EvaluationExample.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / EvaluationExample +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / EvaluationExample # Interface: EvaluationExample -Represents an example for evaluation, including the context, an array of message examples, and the expected outcome. +Example for evaluating agent behavior ## Properties @@ -10,9 +10,11 @@ Represents an example for evaluation, including the context, an array of message > **context**: `string` +Evaluation context + #### Defined in -[packages/core/src/types.ts:230](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L230) +[packages/core/src/types.ts:400](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L400) *** @@ -20,9 +22,11 @@ Represents an example for evaluation, including the context, an array of message > **messages**: [`ActionExample`](ActionExample.md)[] +Example messages + #### Defined in -[packages/core/src/types.ts:231](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L231) +[packages/core/src/types.ts:403](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L403) *** @@ -30,6 +34,8 @@ Represents an example for evaluation, including the context, an array of message > **outcome**: `string` +Expected outcome + #### Defined in -[packages/core/src/types.ts:232](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L232) +[packages/core/src/types.ts:406](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L406) diff --git a/docs/api/interfaces/Evaluator.md b/docs/api/interfaces/Evaluator.md index bf4d081f402..da2bc71eea3 100644 --- a/docs/api/interfaces/Evaluator.md +++ b/docs/api/interfaces/Evaluator.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Evaluator +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Evaluator # Interface: Evaluator -Represents an evaluator, which is used to assess and guide the agent's responses based on the current context and state. +Evaluator for assessing agent responses ## Properties @@ -10,9 +10,11 @@ Represents an evaluator, which is used to assess and guide the agent's responses > `optional` **alwaysRun**: `boolean` +Whether to always run + #### 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:414](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L414) *** @@ -20,9 +22,11 @@ Represents an evaluator, which is used to assess and guide the agent's responses > **description**: `string` +Detailed description + #### Defined in -[packages/core/src/types.ts:240](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L240) +[packages/core/src/types.ts:417](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L417) *** @@ -30,9 +34,11 @@ Represents an evaluator, which is used to assess and guide the agent's responses > **similes**: `string`[] +Similar evaluator descriptions + #### Defined in -[packages/core/src/types.ts:241](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L241) +[packages/core/src/types.ts:420](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L420) *** @@ -40,9 +46,11 @@ Represents an evaluator, which is used to assess and guide the agent's responses > **examples**: [`EvaluationExample`](EvaluationExample.md)[] +Example evaluations + #### Defined in -[packages/core/src/types.ts:242](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L242) +[packages/core/src/types.ts:423](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L423) *** @@ -50,9 +58,11 @@ Represents an evaluator, which is used to assess and guide the agent's responses > **handler**: [`Handler`](../type-aliases/Handler.md) +Handler function + #### Defined in -[packages/core/src/types.ts:243](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L243) +[packages/core/src/types.ts:426](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L426) *** @@ -60,9 +70,11 @@ Represents an evaluator, which is used to assess and guide the agent's responses > **name**: `string` +Evaluator name + #### Defined in -[packages/core/src/types.ts:244](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L244) +[packages/core/src/types.ts:429](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L429) *** @@ -70,6 +82,8 @@ Represents an evaluator, which is used to assess and guide the agent's responses > **validate**: [`Validator`](../type-aliases/Validator.md) +Validation function + #### Defined in -[packages/core/src/types.ts:245](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L245) +[packages/core/src/types.ts:432](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L432) diff --git a/docs/api/interfaces/GenerationOptions.md b/docs/api/interfaces/GenerationOptions.md index b4eccbbb55d..59923790c3d 100644 --- a/docs/api/interfaces/GenerationOptions.md +++ b/docs/api/interfaces/GenerationOptions.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / GenerationOptions +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / GenerationOptions # Interface: GenerationOptions @@ -12,7 +12,7 @@ Configuration options for generating objects with a model. #### Defined in -[packages/core/src/generation.ts:884](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L884) +[packages/core/src/generation.ts:901](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L901) *** @@ -22,17 +22,17 @@ Configuration options for generating objects with a model. #### Defined in -[packages/core/src/generation.ts:885](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L885) +[packages/core/src/generation.ts:902](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L902) *** ### modelClass -> **modelClass**: [`ModelClass`](../enumerations/ModelClass.md) +> **modelClass**: `TiktokenModel` #### Defined in -[packages/core/src/generation.ts:886](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L886) +[packages/core/src/generation.ts:903](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L903) *** @@ -42,7 +42,7 @@ Configuration options for generating objects with a model. #### Defined in -[packages/core/src/generation.ts:887](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L887) +[packages/core/src/generation.ts:904](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L904) *** @@ -52,7 +52,7 @@ Configuration options for generating objects with a model. #### Defined in -[packages/core/src/generation.ts:888](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L888) +[packages/core/src/generation.ts:905](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L905) *** @@ -62,7 +62,7 @@ Configuration options for generating objects with a model. #### Defined in -[packages/core/src/generation.ts:889](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L889) +[packages/core/src/generation.ts:906](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L906) *** @@ -72,7 +72,7 @@ Configuration options for generating objects with a model. #### Defined in -[packages/core/src/generation.ts:890](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L890) +[packages/core/src/generation.ts:907](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L907) *** @@ -82,7 +82,7 @@ Configuration options for generating objects with a model. #### Defined in -[packages/core/src/generation.ts:891](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L891) +[packages/core/src/generation.ts:908](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L908) *** @@ -92,4 +92,4 @@ Configuration options for generating objects with a model. #### Defined in -[packages/core/src/generation.ts:892](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L892) +[packages/core/src/generation.ts:909](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L909) diff --git a/docs/api/interfaces/Goal.md b/docs/api/interfaces/Goal.md index b2cbb25ac11..7da451e6144 100644 --- a/docs/api/interfaces/Goal.md +++ b/docs/api/interfaces/Goal.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Goal +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Goal # Interface: Goal -Represents a goal, which is a higher-level aim composed of one or more objectives. Goals are tracked to measure progress or achievements within the conversation or system. +Represents a high-level goal composed of objectives ## Properties @@ -10,9 +10,11 @@ Represents a goal, which is a higher-level aim composed of one or more objective > `optional` **id**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Optional unique identifier + #### Defined in -[packages/core/src/types.ts:66](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L66) +[packages/core/src/types.ts:110](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L110) *** @@ -20,9 +22,11 @@ Represents a goal, which is a higher-level aim composed of one or more objective > **roomId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Room ID where goal exists + #### Defined in -[packages/core/src/types.ts:67](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L67) +[packages/core/src/types.ts:113](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L113) *** @@ -30,9 +34,11 @@ Represents a goal, which is a higher-level aim composed of one or more objective > **userId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +User ID of goal owner + #### Defined in -[packages/core/src/types.ts:68](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L68) +[packages/core/src/types.ts:116](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L116) *** @@ -40,9 +46,11 @@ Represents a goal, which is a higher-level aim composed of one or more objective > **name**: `string` +Name/title of the goal + #### Defined in -[packages/core/src/types.ts:69](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L69) +[packages/core/src/types.ts:119](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L119) *** @@ -50,9 +58,11 @@ Represents a goal, which is a higher-level aim composed of one or more objective > **status**: [`GoalStatus`](../enumerations/GoalStatus.md) +Current status + #### Defined in -[packages/core/src/types.ts:70](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L70) +[packages/core/src/types.ts:122](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L122) *** @@ -60,6 +70,8 @@ Represents a goal, which is a higher-level aim composed of one or more objective > **objectives**: [`Objective`](Objective.md)[] +Component objectives + #### Defined in -[packages/core/src/types.ts:71](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L71) +[packages/core/src/types.ts:125](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L125) diff --git a/docs/api/interfaces/IAgentRuntime.md b/docs/api/interfaces/IAgentRuntime.md index 1abd4f28fc3..843bf0e1537 100644 --- a/docs/api/interfaces/IAgentRuntime.md +++ b/docs/api/interfaces/IAgentRuntime.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / IAgentRuntime +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / IAgentRuntime # Interface: IAgentRuntime @@ -12,7 +12,7 @@ Properties #### Defined in -[packages/core/src/types.ts:590](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L590) +[packages/core/src/types.ts:937](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L937) *** @@ -22,7 +22,7 @@ Properties #### Defined in -[packages/core/src/types.ts:591](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L591) +[packages/core/src/types.ts:938](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L938) *** @@ -32,7 +32,7 @@ Properties #### 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:939](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L939) *** @@ -42,7 +42,7 @@ Properties #### 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:940](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L940) *** @@ -52,7 +52,7 @@ Properties #### 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:941](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L941) *** @@ -62,7 +62,7 @@ Properties #### 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:942](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L942) *** @@ -72,7 +72,7 @@ Properties #### Defined in -[packages/core/src/types.ts:596](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L596) +[packages/core/src/types.ts:943](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L943) *** @@ -82,7 +82,7 @@ Properties #### Defined in -[packages/core/src/types.ts:597](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L597) +[packages/core/src/types.ts:944](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L944) *** @@ -92,7 +92,7 @@ Properties #### Defined in -[packages/core/src/types.ts:598](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L598) +[packages/core/src/types.ts:945](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L945) *** @@ -102,7 +102,7 @@ Properties #### 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:946](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L946) *** @@ -112,7 +112,7 @@ Properties #### 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:948](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L948) *** @@ -122,7 +122,27 @@ Properties #### Defined in -[packages/core/src/types.ts:602](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L602) +[packages/core/src/types.ts:949](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L949) + +*** + +### documentsManager + +> **documentsManager**: [`IMemoryManager`](IMemoryManager.md) + +#### Defined in + +[packages/core/src/types.ts:950](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L950) + +*** + +### knowledgeManager + +> **knowledgeManager**: [`IMemoryManager`](IMemoryManager.md) + +#### Defined in + +[packages/core/src/types.ts:951](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L951) *** @@ -132,7 +152,7 @@ Properties #### Defined in -[packages/core/src/types.ts:603](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L603) +[packages/core/src/types.ts:952](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L952) *** @@ -142,7 +162,7 @@ Properties #### Defined in -[packages/core/src/types.ts:604](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L604) +[packages/core/src/types.ts:954](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L954) *** @@ -152,7 +172,7 @@ Properties #### Defined in -[packages/core/src/types.ts:606](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L606) +[packages/core/src/types.ts:956](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L956) ## Methods @@ -166,7 +186,7 @@ Properties #### Defined in -[packages/core/src/types.ts:608](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L608) +[packages/core/src/types.ts:958](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L958) *** @@ -184,7 +204,7 @@ Properties #### Defined in -[packages/core/src/types.ts:610](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L610) +[packages/core/src/types.ts:960](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L960) *** @@ -202,7 +222,7 @@ Properties #### Defined in -[packages/core/src/types.ts:612](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L612) +[packages/core/src/types.ts:962](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L962) *** @@ -224,7 +244,7 @@ Properties #### Defined in -[packages/core/src/types.ts:614](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L614) +[packages/core/src/types.ts:964](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L964) *** @@ -242,7 +262,7 @@ Properties #### Defined in -[packages/core/src/types.ts:616](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L616) +[packages/core/src/types.ts:966](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L966) *** @@ -260,7 +280,7 @@ Properties #### Defined in -[packages/core/src/types.ts:618](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L618) +[packages/core/src/types.ts:968](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L968) *** @@ -276,7 +296,7 @@ Methods #### 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:971](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L971) *** @@ -300,7 +320,7 @@ Methods #### 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:973](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L973) *** @@ -322,7 +342,7 @@ Methods #### Defined in -[packages/core/src/types.ts:628](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L628) +[packages/core/src/types.ts:980](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L980) *** @@ -342,7 +362,7 @@ Methods #### Defined in -[packages/core/src/types.ts:633](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L633) +[packages/core/src/types.ts:986](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L986) *** @@ -366,7 +386,7 @@ Methods #### 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:988](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L988) *** @@ -384,7 +404,7 @@ Methods #### 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:995](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L995) *** @@ -410,7 +430,7 @@ Methods #### 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:997](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L997) *** @@ -430,7 +450,7 @@ Methods #### Defined in -[packages/core/src/types.ts:648](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L648) +[packages/core/src/types.ts:1005](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1005) *** @@ -448,7 +468,7 @@ Methods #### Defined in -[packages/core/src/types.ts:649](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L649) +[packages/core/src/types.ts:1007](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1007) *** @@ -468,7 +488,7 @@ Methods #### Defined in -[packages/core/src/types.ts:650](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L650) +[packages/core/src/types.ts:1009](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1009) *** @@ -486,4 +506,4 @@ Methods #### Defined in -[packages/core/src/types.ts:654](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L654) +[packages/core/src/types.ts:1014](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1014) diff --git a/docs/api/interfaces/IBrowserService.md b/docs/api/interfaces/IBrowserService.md index f7525a4fd9f..d4f72136da2 100644 --- a/docs/api/interfaces/IBrowserService.md +++ b/docs/api/interfaces/IBrowserService.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / IBrowserService +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / IBrowserService # Interface: IBrowserService @@ -24,7 +24,7 @@ #### Defined in -[packages/core/src/types.ts:580](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L580) +[packages/core/src/types.ts:927](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L927) ## Methods @@ -48,21 +48,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) - -*** - -### getInstance() - -> **getInstance**(): [`IBrowserService`](IBrowserService.md) - -#### Returns - -[`IBrowserService`](IBrowserService.md) - -#### Defined in - -[packages/core/src/types.ts:705](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L705) +[packages/core/src/types.ts:932](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L932) *** @@ -76,7 +62,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:706](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L706) +[packages/core/src/types.ts:1061](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1061) *** @@ -108,4 +94,4 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:707](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L707) +[packages/core/src/types.ts:1062](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1062) diff --git a/docs/api/interfaces/ICacheAdapter.md b/docs/api/interfaces/ICacheAdapter.md index d38ca721b45..55ec1ab3a87 100644 --- a/docs/api/interfaces/ICacheAdapter.md +++ b/docs/api/interfaces/ICacheAdapter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / ICacheAdapter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / ICacheAdapter # Interface: ICacheAdapter diff --git a/docs/api/interfaces/ICacheManager.md b/docs/api/interfaces/ICacheManager.md index f1ea1917f1d..f6f943afed6 100644 --- a/docs/api/interfaces/ICacheManager.md +++ b/docs/api/interfaces/ICacheManager.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / ICacheManager +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / ICacheManager # Interface: ICacheManager @@ -22,7 +22,7 @@ #### Defined in -[packages/core/src/types.ts:561](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L561) +[packages/core/src/types.ts:908](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L908) *** @@ -48,7 +48,7 @@ #### Defined in -[packages/core/src/types.ts:562](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L562) +[packages/core/src/types.ts:909](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L909) *** @@ -66,4 +66,4 @@ #### Defined in -[packages/core/src/types.ts:563](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L563) +[packages/core/src/types.ts:910](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L910) diff --git a/docs/api/interfaces/IDatabaseAdapter.md b/docs/api/interfaces/IDatabaseAdapter.md index 73e92b65a8e..c12e205f2f6 100644 --- a/docs/api/interfaces/IDatabaseAdapter.md +++ b/docs/api/interfaces/IDatabaseAdapter.md @@ -1,16 +1,20 @@ -[@ai16z/eliza v0.1.3](../index.md) / IDatabaseAdapter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / IDatabaseAdapter # Interface: IDatabaseAdapter +Interface for database operations + ## Properties ### db > **db**: `any` +Database instance + #### Defined in -[packages/core/src/types.ts:399](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L399) +[packages/core/src/types.ts:703](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L703) ## Methods @@ -18,13 +22,15 @@ > `optional` **init**(): `Promise`\<`void`\> +Optional initialization + #### Returns `Promise`\<`void`\> #### 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:706](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L706) *** @@ -32,6 +38,8 @@ > **getAccountById**(`userId`): `Promise`\<[`Account`](Account.md)\> +Get account by ID + #### Parameters • **userId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` @@ -42,7 +50,7 @@ #### Defined in -[packages/core/src/types.ts:401](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L401) +[packages/core/src/types.ts:709](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L709) *** @@ -50,6 +58,8 @@ > **createAccount**(`account`): `Promise`\<`boolean`\> +Create new account + #### Parameters • **account**: [`Account`](Account.md) @@ -60,7 +70,7 @@ #### Defined in -[packages/core/src/types.ts:402](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L402) +[packages/core/src/types.ts:712](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L712) *** @@ -68,6 +78,8 @@ > **getMemories**(`params`): `Promise`\<[`Memory`](Memory.md)[]\> +Get memories matching criteria + #### Parameters • **params** @@ -80,7 +92,7 @@ • **params.tableName**: `string` -• **params.agentId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +• **params.agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` • **params.start?**: `number` @@ -92,7 +104,7 @@ #### Defined in -[packages/core/src/types.ts:403](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L403) +[packages/core/src/types.ts:715](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L715) *** @@ -110,7 +122,7 @@ #### Defined in -[packages/core/src/types.ts:412](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L412) +[packages/core/src/types.ts:725](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L725) *** @@ -122,7 +134,7 @@ • **params** -• **params.agentId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +• **params.agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` • **params.roomIds**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\`[] @@ -132,7 +144,7 @@ #### Defined in -[packages/core/src/types.ts:413](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L413) +[packages/core/src/types.ts:727](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L727) *** @@ -162,7 +174,7 @@ #### Defined in -[packages/core/src/types.ts:417](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L417) +[packages/core/src/types.ts:732](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L732) *** @@ -188,7 +200,7 @@ #### Defined in -[packages/core/src/types.ts:425](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L425) +[packages/core/src/types.ts:741](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L741) *** @@ -208,7 +220,7 @@ #### Defined in -[packages/core/src/types.ts:431](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L431) +[packages/core/src/types.ts:748](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L748) *** @@ -222,6 +234,8 @@ • **params.tableName**: `string` +• **params.agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` + • **params.roomId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` • **params.embedding**: `number`[] @@ -238,7 +252,7 @@ #### Defined in -[packages/core/src/types.ts:432](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L432) +[packages/core/src/types.ts:750](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L750) *** @@ -260,7 +274,7 @@ #### 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:760](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L760) *** @@ -292,7 +306,7 @@ #### 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:765](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L765) *** @@ -314,7 +328,7 @@ #### 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:777](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L777) *** @@ -334,7 +348,7 @@ #### 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:783](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L783) *** @@ -354,7 +368,7 @@ #### Defined in -[packages/core/src/types.ts:461](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L461) +[packages/core/src/types.ts:785](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L785) *** @@ -376,7 +390,7 @@ #### Defined in -[packages/core/src/types.ts:462](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L462) +[packages/core/src/types.ts:787](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L787) *** @@ -388,6 +402,8 @@ • **params** +• **params.agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` + • **params.roomId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` • **params.userId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` @@ -402,7 +418,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:793](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L793) *** @@ -420,7 +436,7 @@ #### Defined in -[packages/core/src/types.ts:473](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L473) +[packages/core/src/types.ts:801](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L801) *** @@ -438,7 +454,7 @@ #### Defined in -[packages/core/src/types.ts:474](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L474) +[packages/core/src/types.ts:803](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L803) *** @@ -456,7 +472,7 @@ #### Defined in -[packages/core/src/types.ts:475](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L475) +[packages/core/src/types.ts:805](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L805) *** @@ -474,7 +490,7 @@ #### Defined in -[packages/core/src/types.ts:476](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L476) +[packages/core/src/types.ts:807](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L807) *** @@ -492,7 +508,7 @@ #### Defined in -[packages/core/src/types.ts:477](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L477) +[packages/core/src/types.ts:809](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L809) *** @@ -510,7 +526,7 @@ #### 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:811](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L811) *** @@ -528,7 +544,7 @@ #### Defined in -[packages/core/src/types.ts:479](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L479) +[packages/core/src/types.ts:813](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L813) *** @@ -546,7 +562,7 @@ #### Defined in -[packages/core/src/types.ts:480](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L480) +[packages/core/src/types.ts:815](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L815) *** @@ -564,7 +580,7 @@ #### 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:817](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L817) *** @@ -584,7 +600,7 @@ #### 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:819](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L819) *** @@ -604,7 +620,7 @@ #### Defined in -[packages/core/src/types.ts:483](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L483) +[packages/core/src/types.ts:821](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L821) *** @@ -622,7 +638,7 @@ #### Defined in -[packages/core/src/types.ts:484](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L484) +[packages/core/src/types.ts:823](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L823) *** @@ -640,7 +656,7 @@ #### Defined in -[packages/core/src/types.ts:485](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L485) +[packages/core/src/types.ts:825](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L825) *** @@ -660,7 +676,7 @@ #### 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:827](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L827) *** @@ -682,7 +698,7 @@ #### Defined in -[packages/core/src/types.ts:490](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L490) +[packages/core/src/types.ts:832](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L832) *** @@ -704,7 +720,7 @@ #### Defined in -[packages/core/src/types.ts:495](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L495) +[packages/core/src/types.ts:838](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L838) *** @@ -726,7 +742,7 @@ #### 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:840](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L840) *** @@ -746,4 +762,4 @@ #### Defined in -[packages/core/src/types.ts:500](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L500) +[packages/core/src/types.ts:845](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L845) diff --git a/docs/api/interfaces/IDatabaseCacheAdapter.md b/docs/api/interfaces/IDatabaseCacheAdapter.md index 6b2daaf4e04..fb4c89eb2b1 100644 --- a/docs/api/interfaces/IDatabaseCacheAdapter.md +++ b/docs/api/interfaces/IDatabaseCacheAdapter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / IDatabaseCacheAdapter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / IDatabaseCacheAdapter # Interface: IDatabaseCacheAdapter @@ -22,7 +22,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:849](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L849) *** @@ -46,7 +46,7 @@ #### Defined in -[packages/core/src/types.ts:508](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L508) +[packages/core/src/types.ts:854](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L854) *** @@ -68,4 +68,4 @@ #### Defined in -[packages/core/src/types.ts:514](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L514) +[packages/core/src/types.ts:860](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L860) diff --git a/docs/api/interfaces/IImageDescriptionService.md b/docs/api/interfaces/IImageDescriptionService.md index 51e88bb89ad..254b977918e 100644 --- a/docs/api/interfaces/IImageDescriptionService.md +++ b/docs/api/interfaces/IImageDescriptionService.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / IImageDescriptionService +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / IImageDescriptionService # Interface: IImageDescriptionService @@ -24,7 +24,7 @@ #### Defined in -[packages/core/src/types.ts:580](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L580) +[packages/core/src/types.ts:927](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L927) ## Methods @@ -48,21 +48,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) - -*** - -### getInstance() - -> **getInstance**(): [`IImageDescriptionService`](IImageDescriptionService.md) - -#### Returns - -[`IImageDescriptionService`](IImageDescriptionService.md) - -#### Defined in - -[packages/core/src/types.ts:658](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L658) +[packages/core/src/types.ts:932](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L932) *** @@ -88,4 +74,4 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:659](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L659) +[packages/core/src/types.ts:1018](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1018) diff --git a/docs/api/interfaces/IMemoryManager.md b/docs/api/interfaces/IMemoryManager.md index bc55eb3187b..a1b638d2fe6 100644 --- a/docs/api/interfaces/IMemoryManager.md +++ b/docs/api/interfaces/IMemoryManager.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / IMemoryManager +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / IMemoryManager # Interface: IMemoryManager @@ -10,7 +10,7 @@ #### 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:864](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L864) *** @@ -20,7 +20,7 @@ #### 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:865](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L865) *** @@ -30,7 +30,7 @@ #### 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:866](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L866) ## Methods @@ -48,7 +48,7 @@ #### 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:868](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L868) *** @@ -66,8 +66,6 @@ • **opts.unique?**: `boolean` -• **opts.agentId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` - • **opts.start?**: `number` • **opts.end?**: `number` @@ -78,7 +76,7 @@ #### 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:870](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L870) *** @@ -96,7 +94,7 @@ #### 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:878](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L878) *** @@ -114,7 +112,7 @@ #### Defined in -[packages/core/src/types.ts:535](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L535) +[packages/core/src/types.ts:882](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L882) *** @@ -128,15 +126,13 @@ • **params.roomIds**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\`[] -• **params.agentId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` - #### Returns `Promise`\<[`Memory`](Memory.md)[]\> #### 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:883](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L883) *** @@ -158,15 +154,13 @@ • **opts.unique?**: `boolean` -• **opts.agentId?**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` - #### Returns `Promise`\<[`Memory`](Memory.md)[]\> #### 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:884](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L884) *** @@ -186,7 +180,7 @@ #### 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:894](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L894) *** @@ -204,7 +198,7 @@ #### 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:896](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L896) *** @@ -222,7 +216,7 @@ #### 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:898](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L898) *** @@ -242,4 +236,4 @@ #### Defined in -[packages/core/src/types.ts:553](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L553) +[packages/core/src/types.ts:900](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L900) diff --git a/docs/api/interfaces/IPdfService.md b/docs/api/interfaces/IPdfService.md index e4a4e998c2f..b99cab8f174 100644 --- a/docs/api/interfaces/IPdfService.md +++ b/docs/api/interfaces/IPdfService.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / IPdfService +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / IPdfService # Interface: IPdfService @@ -24,7 +24,7 @@ #### Defined in -[packages/core/src/types.ts:580](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L580) +[packages/core/src/types.ts:927](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L927) ## Methods @@ -48,7 +48,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) +[packages/core/src/types.ts:932](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L932) *** @@ -62,7 +62,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:719](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L719) +[packages/core/src/types.ts:1074](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1074) *** @@ -80,4 +80,4 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:720](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L720) +[packages/core/src/types.ts:1075](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1075) diff --git a/docs/api/interfaces/ISpeechService.md b/docs/api/interfaces/ISpeechService.md index c02c87c1682..52b4589ebcd 100644 --- a/docs/api/interfaces/ISpeechService.md +++ b/docs/api/interfaces/ISpeechService.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / ISpeechService +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / ISpeechService # Interface: ISpeechService @@ -24,7 +24,7 @@ #### Defined in -[packages/core/src/types.ts:580](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L580) +[packages/core/src/types.ts:927](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L927) ## Methods @@ -48,7 +48,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) +[packages/core/src/types.ts:932](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L932) *** @@ -62,7 +62,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:714](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L714) +[packages/core/src/types.ts:1069](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1069) *** @@ -82,4 +82,4 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:715](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L715) +[packages/core/src/types.ts:1070](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1070) diff --git a/docs/api/interfaces/ITextGenerationService.md b/docs/api/interfaces/ITextGenerationService.md index 9a2e07b77fb..458c1e2da4e 100644 --- a/docs/api/interfaces/ITextGenerationService.md +++ b/docs/api/interfaces/ITextGenerationService.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / ITextGenerationService +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / ITextGenerationService # Interface: ITextGenerationService @@ -24,7 +24,7 @@ #### Defined in -[packages/core/src/types.ts:580](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L580) +[packages/core/src/types.ts:927](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L927) ## Methods @@ -48,21 +48,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) - -*** - -### getInstance() - -> **getInstance**(): [`ITextGenerationService`](ITextGenerationService.md) - -#### Returns - -[`ITextGenerationService`](ITextGenerationService.md) - -#### Defined in - -[packages/core/src/types.ts:683](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L683) +[packages/core/src/types.ts:932](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L932) *** @@ -76,7 +62,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:684](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L684) +[packages/core/src/types.ts:1040](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1040) *** @@ -104,7 +90,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:685](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L685) +[packages/core/src/types.ts:1041](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1041) *** @@ -132,7 +118,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:693](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L693) +[packages/core/src/types.ts:1049](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1049) *** @@ -150,4 +136,4 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:701](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L701) +[packages/core/src/types.ts:1057](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1057) diff --git a/docs/api/interfaces/ITranscriptionService.md b/docs/api/interfaces/ITranscriptionService.md index 8de9f141b55..e4f6cfbee20 100644 --- a/docs/api/interfaces/ITranscriptionService.md +++ b/docs/api/interfaces/ITranscriptionService.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / ITranscriptionService +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / ITranscriptionService # Interface: ITranscriptionService @@ -24,7 +24,7 @@ #### Defined in -[packages/core/src/types.ts:580](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L580) +[packages/core/src/types.ts:927](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L927) ## Methods @@ -48,21 +48,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) - -*** - -### getInstance() - -> **getInstance**(): [`ITranscriptionService`](ITranscriptionService.md) - -#### Returns - -[`ITranscriptionService`](ITranscriptionService.md) - -#### Defined in - -[packages/core/src/types.ts:665](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L665) +[packages/core/src/types.ts:932](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L932) *** @@ -80,7 +66,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:666](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L666) +[packages/core/src/types.ts:1024](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1024) *** @@ -98,7 +84,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:667](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L667) +[packages/core/src/types.ts:1025](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1025) *** @@ -116,7 +102,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:670](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L670) +[packages/core/src/types.ts:1028](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1028) *** @@ -134,4 +120,4 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:671](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L671) +[packages/core/src/types.ts:1029](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1029) diff --git a/docs/api/interfaces/IVideoService.md b/docs/api/interfaces/IVideoService.md index 84170517e81..19e01febaa3 100644 --- a/docs/api/interfaces/IVideoService.md +++ b/docs/api/interfaces/IVideoService.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / IVideoService +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / IVideoService # Interface: IVideoService @@ -24,7 +24,7 @@ #### Defined in -[packages/core/src/types.ts:580](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L580) +[packages/core/src/types.ts:927](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L927) ## Methods @@ -48,21 +48,7 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) - -*** - -### getInstance() - -> **getInstance**(): [`IVideoService`](IVideoService.md) - -#### Returns - -[`IVideoService`](IVideoService.md) - -#### Defined in - -[packages/core/src/types.ts:675](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L675) +[packages/core/src/types.ts:932](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L932) *** @@ -80,13 +66,13 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:676](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L676) +[packages/core/src/types.ts:1033](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1033) *** -### processVideo() +### fetchVideoInfo() -> **processVideo**(`url`): `Promise`\<[`Media`](../type-aliases/Media.md)\> +> **fetchVideoInfo**(`url`): `Promise`\<[`Media`](../type-aliases/Media.md)\> #### Parameters @@ -98,40 +84,42 @@ Add abstract initialize method that must be implemented by derived classes #### Defined in -[packages/core/src/types.ts:677](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L677) +[packages/core/src/types.ts:1034](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1034) *** -### fetchVideoInfo() +### downloadVideo() -> **fetchVideoInfo**(`url`): `Promise`\<[`Media`](../type-aliases/Media.md)\> +> **downloadVideo**(`videoInfo`): `Promise`\<`string`\> #### Parameters -• **url**: `string` +• **videoInfo**: [`Media`](../type-aliases/Media.md) #### Returns -`Promise`\<[`Media`](../type-aliases/Media.md)\> +`Promise`\<`string`\> #### Defined in -[packages/core/src/types.ts:678](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L678) +[packages/core/src/types.ts:1035](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1035) *** -### downloadVideo() +### processVideo() -> **downloadVideo**(`videoInfo`): `Promise`\<`string`\> +> **processVideo**(`url`, `runtime`): `Promise`\<[`Media`](../type-aliases/Media.md)\> #### Parameters -• **videoInfo**: [`Media`](../type-aliases/Media.md) +• **url**: `string` + +• **runtime**: [`IAgentRuntime`](IAgentRuntime.md) #### Returns -`Promise`\<`string`\> +`Promise`\<[`Media`](../type-aliases/Media.md)\> #### Defined in -[packages/core/src/types.ts:679](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L679) +[packages/core/src/types.ts:1036](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1036) diff --git a/docs/api/interfaces/Memory.md b/docs/api/interfaces/Memory.md index a0bb9dd4a33..c2977270c18 100644 --- a/docs/api/interfaces/Memory.md +++ b/docs/api/interfaces/Memory.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Memory +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Memory # Interface: Memory -Represents a memory record, which could be a message or any other piece of information remembered by the system, including its content, associated user IDs, and optionally, its embedding vector for similarity comparisons. +Represents a stored memory/message ## Properties @@ -10,9 +10,11 @@ Represents a memory record, which could be a message or any other piece of infor > `optional` **id**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Optional unique identifier + #### 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:306](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L306) *** @@ -20,9 +22,11 @@ Represents a memory record, which could be a message or any other piece of infor > **userId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Associated user ID + #### 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:309](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L309) *** @@ -30,9 +34,11 @@ Represents a memory record, which could be a message or any other piece of infor > **agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Associated agent ID + #### 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:312](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L312) *** @@ -40,9 +46,11 @@ Represents a memory record, which could be a message or any other piece of infor > `optional` **createdAt**: `number` +Optional creation timestamp + #### Defined in -[packages/core/src/types.ts:173](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L173) +[packages/core/src/types.ts:315](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L315) *** @@ -50,9 +58,11 @@ Represents a memory record, which could be a message or any other piece of infor > **content**: [`Content`](Content.md) +Memory content + #### Defined in -[packages/core/src/types.ts:174](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L174) +[packages/core/src/types.ts:318](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L318) *** @@ -60,9 +70,11 @@ Represents a memory record, which could be a message or any other piece of infor > `optional` **embedding**: `number`[] +Optional embedding vector + #### Defined in -[packages/core/src/types.ts:175](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L175) +[packages/core/src/types.ts:321](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L321) *** @@ -70,9 +82,11 @@ Represents a memory record, which could be a message or any other piece of infor > **roomId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Associated room ID + #### Defined in -[packages/core/src/types.ts:176](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L176) +[packages/core/src/types.ts:324](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L324) *** @@ -80,6 +94,20 @@ Represents a memory record, which could be a message or any other piece of infor > `optional` **unique**: `boolean` +Whether memory is unique + +#### Defined in + +[packages/core/src/types.ts:327](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L327) + +*** + +### similarity? + +> `optional` **similarity**: `number` + +Embedding similarity score + #### Defined in -[packages/core/src/types.ts:177](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L177) +[packages/core/src/types.ts:330](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L330) diff --git a/docs/api/interfaces/MessageExample.md b/docs/api/interfaces/MessageExample.md index 06eda42410b..afe398351d3 100644 --- a/docs/api/interfaces/MessageExample.md +++ b/docs/api/interfaces/MessageExample.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / MessageExample +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / MessageExample # Interface: MessageExample -Represents an example of a message, typically used for demonstrating or testing purposes, including optional content and action. +Example message for demonstration ## Properties @@ -10,9 +10,11 @@ Represents an example of a message, typically used for demonstrating or testing > **user**: `string` +Associated user + #### Defined in -[packages/core/src/types.ts:184](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L184) +[packages/core/src/types.ts:338](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L338) *** @@ -20,6 +22,8 @@ Represents an example of a message, typically used for demonstrating or testing > **content**: [`Content`](Content.md) +Message content + #### Defined in -[packages/core/src/types.ts:185](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L185) +[packages/core/src/types.ts:341](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L341) diff --git a/docs/api/interfaces/Objective.md b/docs/api/interfaces/Objective.md index bed81118a56..762460479b1 100644 --- a/docs/api/interfaces/Objective.md +++ b/docs/api/interfaces/Objective.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Objective +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Objective # Interface: Objective -Represents an objective within a goal, detailing what needs to be achieved and whether it has been completed. +Represents a single objective within a goal ## Properties @@ -10,9 +10,11 @@ Represents an objective within a goal, detailing what needs to be achieved and w > `optional` **id**: `string` +Optional unique identifier + #### Defined in -[packages/core/src/types.ts:51](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L51) +[packages/core/src/types.ts:87](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L87) *** @@ -20,9 +22,11 @@ Represents an objective within a goal, detailing what needs to be achieved and w > **description**: `string` +Description of what needs to be achieved + #### Defined in -[packages/core/src/types.ts:52](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L52) +[packages/core/src/types.ts:90](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L90) *** @@ -30,6 +34,8 @@ Represents an objective within a goal, detailing what needs to be achieved and w > **completed**: `boolean` +Whether objective is completed + #### Defined in -[packages/core/src/types.ts:53](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L53) +[packages/core/src/types.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L93) diff --git a/docs/api/interfaces/Participant.md b/docs/api/interfaces/Participant.md index dfe27713dca..c6a46e84c09 100644 --- a/docs/api/interfaces/Participant.md +++ b/docs/api/interfaces/Participant.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Participant +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Participant # Interface: Participant -Represents a participant in a room, including their ID and account details. +Room participant with account details ## Properties @@ -10,9 +10,11 @@ Represents a participant in a room, including their ID and account details. > **id**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Unique identifier + #### Defined in -[packages/core/src/types.ts:288](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L288) +[packages/core/src/types.ts:501](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L501) *** @@ -20,6 +22,8 @@ Represents a participant in a room, including their ID and account details. > **account**: [`Account`](Account.md) +Associated account + #### Defined in -[packages/core/src/types.ts:289](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L289) +[packages/core/src/types.ts:504](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L504) diff --git a/docs/api/interfaces/Provider.md b/docs/api/interfaces/Provider.md index bd944f4ba10..b02a1220fd6 100644 --- a/docs/api/interfaces/Provider.md +++ b/docs/api/interfaces/Provider.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Provider +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Provider # Interface: Provider -Represents a provider, which is used to retrieve information or perform actions on behalf of the agent, such as fetching data from an external API or service. +Provider for external data/services ## Properties @@ -10,6 +10,8 @@ Represents a provider, which is used to retrieve information or perform actions > **get**: (`runtime`, `message`, `state`?) => `Promise`\<`any`\> +Data retrieval function + #### Parameters • **runtime**: [`IAgentRuntime`](IAgentRuntime.md) @@ -24,4 +26,4 @@ Represents a provider, which is used to retrieve information or perform actions #### Defined in -[packages/core/src/types.ts:252](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L252) +[packages/core/src/types.ts:440](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L440) diff --git a/docs/api/interfaces/Relationship.md b/docs/api/interfaces/Relationship.md index 7bd088fa69a..a131746e99e 100644 --- a/docs/api/interfaces/Relationship.md +++ b/docs/api/interfaces/Relationship.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Relationship +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Relationship # Interface: Relationship -Represents a relationship between two users, including their IDs, the status of the relationship, and the room ID in which the relationship is established. +Represents a relationship between users ## Properties @@ -10,9 +10,11 @@ Represents a relationship between two users, including their IDs, the status of > **id**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Unique identifier + #### 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:452](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L452) *** @@ -20,9 +22,11 @@ Represents a relationship between two users, including their IDs, the status of > **userA**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +First user ID + #### Defined in -[packages/core/src/types.ts:264](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L264) +[packages/core/src/types.ts:455](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L455) *** @@ -30,9 +34,11 @@ Represents a relationship between two users, including their IDs, the status of > **userB**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Second user ID + #### Defined in -[packages/core/src/types.ts:265](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L265) +[packages/core/src/types.ts:458](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L458) *** @@ -40,9 +46,11 @@ Represents a relationship between two users, including their IDs, the status of > **userId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Primary user ID + #### Defined in -[packages/core/src/types.ts:266](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L266) +[packages/core/src/types.ts:461](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L461) *** @@ -50,9 +58,11 @@ Represents a relationship between two users, including their IDs, the status of > **roomId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Associated room ID + #### Defined in -[packages/core/src/types.ts:267](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L267) +[packages/core/src/types.ts:464](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L464) *** @@ -60,9 +70,11 @@ Represents a relationship between two users, including their IDs, the status of > **status**: `string` +Relationship status + #### Defined in -[packages/core/src/types.ts:268](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L268) +[packages/core/src/types.ts:467](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L467) *** @@ -70,6 +82,8 @@ Represents a relationship between two users, including their IDs, the status of > `optional` **createdAt**: `string` +Optional creation timestamp + #### Defined in -[packages/core/src/types.ts:269](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L269) +[packages/core/src/types.ts:470](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L470) diff --git a/docs/api/interfaces/Room.md b/docs/api/interfaces/Room.md index 65401829864..c6765fe4153 100644 --- a/docs/api/interfaces/Room.md +++ b/docs/api/interfaces/Room.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / Room +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Room # Interface: Room -Represents a room or conversation context, including its ID and a list of participants. +Represents a conversation room ## Properties @@ -10,9 +10,11 @@ Represents a room or conversation context, including its ID and a list of partic > **id**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Unique identifier + #### Defined in -[packages/core/src/types.ts:296](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L296) +[packages/core/src/types.ts:512](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L512) *** @@ -20,6 +22,8 @@ Represents a room or conversation context, including its ID and a list of partic > **participants**: [`Participant`](Participant.md)[] +Room participants + #### Defined in -[packages/core/src/types.ts:297](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L297) +[packages/core/src/types.ts:515](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L515) diff --git a/docs/api/interfaces/State.md b/docs/api/interfaces/State.md index 2b5676d22be..bb14f33d568 100644 --- a/docs/api/interfaces/State.md +++ b/docs/api/interfaces/State.md @@ -1,8 +1,8 @@ -[@ai16z/eliza v0.1.3](../index.md) / State +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / State # Interface: State -Represents the state of the conversation or context in which the agent is operating, including information about users, messages, goals, and other relevant data. +Represents the current state/context of a conversation ## Indexable @@ -14,9 +14,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **userId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +ID of user who sent current message + #### 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:226](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L226) *** @@ -24,9 +26,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +ID of agent in conversation + #### 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:229](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L229) *** @@ -34,9 +38,11 @@ Represents the state of the conversation or context in which the agent is operat > **bio**: `string` +Agent's biography + #### 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:232](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L232) *** @@ -44,9 +50,11 @@ Represents the state of the conversation or context in which the agent is operat > **lore**: `string` +Agent's background lore + #### 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:235](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L235) *** @@ -54,9 +62,11 @@ Represents the state of the conversation or context in which the agent is operat > **messageDirections**: `string` +Message handling directions + #### 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:238](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L238) *** @@ -64,9 +74,11 @@ Represents the state of the conversation or context in which the agent is operat > **postDirections**: `string` +Post handling directions + #### 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:241](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L241) *** @@ -74,9 +86,11 @@ Represents the state of the conversation or context in which the agent is operat > **roomId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` +Current room/conversation ID + #### 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:244](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L244) *** @@ -84,9 +98,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **agentName**: `string` +Optional agent name + #### 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:247](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L247) *** @@ -94,9 +110,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **senderName**: `string` +Optional message sender name + #### 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:250](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L250) *** @@ -104,9 +122,11 @@ Represents the state of the conversation or context in which the agent is operat > **actors**: `string` +String representation of conversation actors + #### 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:253](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L253) *** @@ -114,9 +134,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **actorsData**: [`Actor`](Actor.md)[] +Optional array of actor objects + #### 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:256](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L256) *** @@ -124,9 +146,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **goals**: `string` +Optional string representation of goals + #### 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:259](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L259) *** @@ -134,9 +158,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **goalsData**: [`Goal`](Goal.md)[] +Optional array of goal objects + #### 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:262](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L262) *** @@ -144,9 +170,11 @@ Represents the state of the conversation or context in which the agent is operat > **recentMessages**: `string` +Recent message history as string + #### 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:265](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L265) *** @@ -154,9 +182,11 @@ Represents the state of the conversation or context in which the agent is operat > **recentMessagesData**: [`Memory`](Memory.md)[] +Recent message objects + #### 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:268](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L268) *** @@ -164,9 +194,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **actionNames**: `string` +Optional valid action names + #### 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:271](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L271) *** @@ -174,9 +206,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **actions**: `string` +Optional action descriptions + #### 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:274](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L274) *** @@ -184,9 +218,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **actionsData**: [`Action`](Action.md)[] +Optional action objects + #### 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:277](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L277) *** @@ -194,9 +230,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **actionExamples**: `string` +Optional action examples + #### 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:280](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L280) *** @@ -204,9 +242,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **providers**: `string` +Optional provider descriptions + #### Defined in -[packages/core/src/types.ts:158](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L158) +[packages/core/src/types.ts:283](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L283) *** @@ -214,9 +254,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **responseData**: [`Content`](Content.md) +Optional response content + #### Defined in -[packages/core/src/types.ts:159](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L159) +[packages/core/src/types.ts:286](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L286) *** @@ -224,9 +266,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **recentInteractionsData**: [`Memory`](Memory.md)[] +Optional recent interaction objects + #### Defined in -[packages/core/src/types.ts:160](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L160) +[packages/core/src/types.ts:289](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L289) *** @@ -234,9 +278,11 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **recentInteractions**: `string` +Optional recent interactions string + #### Defined in -[packages/core/src/types.ts:161](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L161) +[packages/core/src/types.ts:292](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L292) *** @@ -244,6 +290,8 @@ Represents the state of the conversation or context in which the agent is operat > `optional` **formattedConversation**: `string` +Optional formatted conversation + #### Defined in -[packages/core/src/types.ts:162](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L162) +[packages/core/src/types.ts:295](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L295) diff --git a/docs/api/type-aliases/CacheOptions.md b/docs/api/type-aliases/CacheOptions.md index b193fcb1de3..ac89f39ed77 100644 --- a/docs/api/type-aliases/CacheOptions.md +++ b/docs/api/type-aliases/CacheOptions.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / CacheOptions +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / CacheOptions # Type Alias: CacheOptions @@ -12,4 +12,4 @@ ## Defined in -[packages/core/src/types.ts:556](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L556) +[packages/core/src/types.ts:903](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L903) diff --git a/docs/api/type-aliases/Character.md b/docs/api/type-aliases/Character.md index 50625e7f52a..7980ea25114 100644 --- a/docs/api/type-aliases/Character.md +++ b/docs/api/type-aliases/Character.md @@ -1,39 +1,55 @@ -[@ai16z/eliza v0.1.3](../index.md) / Character +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Character # Type Alias: Character > **Character**: `object` +Configuration for an agent character + ## Type declaration ### id? > `optional` **id**: [`UUID`](UUID.md) +Optional unique identifier + ### name > **name**: `string` +Character name + ### username? > `optional` **username**: `string` +Optional username + ### system? > `optional` **system**: `string` +Optional system prompt + ### modelProvider > **modelProvider**: [`ModelProviderName`](../enumerations/ModelProviderName.md) +Model provider to use + ### modelEndpointOverride? > `optional` **modelEndpointOverride**: `string` +Optional model endpoint override + ### templates? > `optional` **templates**: `object` +Optional prompt templates + ### templates.goalsTemplate? > `optional` **goalsTemplate**: `string` @@ -98,46 +114,68 @@ > **bio**: `string` \| `string`[] +Character biography + ### lore > **lore**: `string`[] +Character background lore + ### messageExamples > **messageExamples**: [`MessageExample`](../interfaces/MessageExample.md)[][] +Example messages + ### postExamples > **postExamples**: `string`[] +Example posts + ### people > **people**: `string`[] +Known people + ### topics > **topics**: `string`[] +Known topics + ### adjectives > **adjectives**: `string`[] +Character traits + ### knowledge? > `optional` **knowledge**: `string`[] +Optional knowledge base + ### clients > **clients**: [`Clients`](../enumerations/Clients.md)[] +Supported client platforms + ### plugins > **plugins**: [`Plugin`](Plugin.md)[] +Available plugins + ### settings? > `optional` **settings**: `object` +Optional configuration + ### settings.secrets? > `optional` **secrets**: `object` @@ -170,6 +208,8 @@ > `optional` **clientConfig**: `object` +Optional client-specific config + ### clientConfig.discord? > `optional` **discord**: `object` @@ -198,6 +238,8 @@ > **style**: `object` +Writing style guides + ### style.all > **all**: `string`[] @@ -214,6 +256,8 @@ > `optional` **twitterProfile**: `object` +Optional Twitter profile + ### twitterProfile.id > **id**: `string` @@ -236,4 +280,4 @@ ## Defined in -[packages/core/src/types.ts:331](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L331) +[packages/core/src/types.ts:590](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L590) diff --git a/docs/api/type-aliases/CharacterConfig.md b/docs/api/type-aliases/CharacterConfig.md index 5478db97eef..1086397f9d1 100644 --- a/docs/api/type-aliases/CharacterConfig.md +++ b/docs/api/type-aliases/CharacterConfig.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / CharacterConfig +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / CharacterConfig # Type Alias: CharacterConfig diff --git a/docs/api/type-aliases/Client.md b/docs/api/type-aliases/Client.md index 04920eb9e08..145d92abaf5 100644 --- a/docs/api/type-aliases/Client.md +++ b/docs/api/type-aliases/Client.md @@ -1,15 +1,19 @@ -[@ai16z/eliza v0.1.3](../index.md) / Client +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Client # Type Alias: Client > **Client**: `object` +Client interface for platform connections + ## Type declaration ### start() > **start**: (`runtime`?) => `Promise`\<`unknown`\> +Start client connection + #### Parameters • **runtime?**: [`IAgentRuntime`](../interfaces/IAgentRuntime.md) @@ -22,6 +26,8 @@ > **stop**: (`runtime`?) => `Promise`\<`unknown`\> +Stop client connection + #### Parameters • **runtime?**: [`IAgentRuntime`](../interfaces/IAgentRuntime.md) @@ -32,4 +38,4 @@ ## Defined in -[packages/core/src/types.ts:309](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L309) +[packages/core/src/types.ts:544](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L544) diff --git a/docs/api/type-aliases/EnvConfig.md b/docs/api/type-aliases/EnvConfig.md index 3589e81e7ee..8a0bd585a76 100644 --- a/docs/api/type-aliases/EnvConfig.md +++ b/docs/api/type-aliases/EnvConfig.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / EnvConfig +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / EnvConfig # Type Alias: EnvConfig diff --git a/docs/api/type-aliases/Handler.md b/docs/api/type-aliases/Handler.md index 9a9b9e325d9..72216585fcc 100644 --- a/docs/api/type-aliases/Handler.md +++ b/docs/api/type-aliases/Handler.md @@ -1,10 +1,10 @@ -[@ai16z/eliza v0.1.3](../index.md) / Handler +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Handler # Type Alias: Handler() > **Handler**: (`runtime`, `message`, `state`?, `options`?, `callback`?) => `Promise`\<`unknown`\> -Represents the type of a handler function, which takes a runtime instance, a message, and an optional state, and returns a promise resolving to any type. +Handler function type for processing messages ## Parameters @@ -24,4 +24,4 @@ Represents the type of a handler function, which takes a runtime instance, a mes ## Defined in -[packages/core/src/types.ts:191](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L191) +[packages/core/src/types.ts:347](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L347) diff --git a/docs/api/type-aliases/HandlerCallback.md b/docs/api/type-aliases/HandlerCallback.md index 27101ffa3ca..4976d2ea797 100644 --- a/docs/api/type-aliases/HandlerCallback.md +++ b/docs/api/type-aliases/HandlerCallback.md @@ -1,9 +1,11 @@ -[@ai16z/eliza v0.1.3](../index.md) / HandlerCallback +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / HandlerCallback # Type Alias: HandlerCallback() > **HandlerCallback**: (`response`, `files`?) => `Promise`\<[`Memory`](../interfaces/Memory.md)[]\> +Callback function type for handlers + ## Parameters • **response**: [`Content`](../interfaces/Content.md) @@ -16,4 +18,4 @@ ## Defined in -[packages/core/src/types.ts:200](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L200) +[packages/core/src/types.ts:358](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L358) diff --git a/docs/api/type-aliases/KnowledgeItem.md b/docs/api/type-aliases/KnowledgeItem.md new file mode 100644 index 00000000000..3df648ca292 --- /dev/null +++ b/docs/api/type-aliases/KnowledgeItem.md @@ -0,0 +1,19 @@ +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / KnowledgeItem + +# Type Alias: KnowledgeItem + +> **KnowledgeItem**: `object` + +## Type declaration + +### id + +> **id**: [`UUID`](UUID.md) + +### content + +> **content**: [`Content`](../interfaces/Content.md) + +## Defined in + +[packages/core/src/types.ts:1094](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1094) diff --git a/docs/api/type-aliases/Media.md b/docs/api/type-aliases/Media.md index 57b5211d232..8ae70e81c50 100644 --- a/docs/api/type-aliases/Media.md +++ b/docs/api/type-aliases/Media.md @@ -1,35 +1,49 @@ -[@ai16z/eliza v0.1.3](../index.md) / Media +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Media # Type Alias: Media > **Media**: `object` +Represents a media attachment + ## Type declaration ### id > **id**: `string` +Unique identifier + ### url > **url**: `string` +Media URL + ### title > **title**: `string` +Media title + ### source > **source**: `string` +Media source + ### description > **description**: `string` +Media description + ### text > **text**: `string` +Text content + ## Defined in -[packages/core/src/types.ts:300](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L300) +[packages/core/src/types.ts:521](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L521) diff --git a/docs/api/type-aliases/Model.md b/docs/api/type-aliases/Model.md index 0e32e6ebdab..902f2de593e 100644 --- a/docs/api/type-aliases/Model.md +++ b/docs/api/type-aliases/Model.md @@ -1,51 +1,73 @@ -[@ai16z/eliza v0.1.3](../index.md) / Model +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Model # Type Alias: Model > **Model**: `object` +Configuration for an AI model + ## Type declaration ### endpoint? > `optional` **endpoint**: `string` +Optional API endpoint + ### settings > **settings**: `object` +Model settings + ### settings.maxInputTokens > **maxInputTokens**: `number` +Maximum input tokens + ### settings.maxOutputTokens > **maxOutputTokens**: `number` +Maximum output tokens + ### settings.frequency\_penalty? > `optional` **frequency\_penalty**: `number` +Optional frequency penalty + ### settings.presence\_penalty? > `optional` **presence\_penalty**: `number` +Optional presence penalty + ### settings.repetition\_penalty? > `optional` **repetition\_penalty**: `number` +Optional repetition penalty + ### settings.stop > **stop**: `string`[] +Stop sequences + ### settings.temperature > **temperature**: `number` +Temperature setting + ### imageSettings? > `optional` **imageSettings**: `object` +Optional image generation settings + ### imageSettings.steps? > `optional` **steps**: `number` @@ -54,6 +76,8 @@ > **model**: `object` +Model names by size class + ### model.small > **small**: `string` @@ -76,4 +100,4 @@ ## Defined in -[packages/core/src/types.ts:82](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L82) +[packages/core/src/types.ts:142](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L142) diff --git a/docs/api/type-aliases/Models.md b/docs/api/type-aliases/Models.md index 4b23a905b66..34f2e5a836b 100644 --- a/docs/api/type-aliases/Models.md +++ b/docs/api/type-aliases/Models.md @@ -1,9 +1,11 @@ -[@ai16z/eliza v0.1.3](../index.md) / Models +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Models # Type Alias: Models > **Models**: `object` +Model configurations by provider + ## Type declaration ### openai @@ -56,4 +58,4 @@ ## Defined in -[packages/core/src/types.ts:105](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L105) +[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/Plugin.md b/docs/api/type-aliases/Plugin.md index 7e53f531729..2421b866b97 100644 --- a/docs/api/type-aliases/Plugin.md +++ b/docs/api/type-aliases/Plugin.md @@ -1,39 +1,55 @@ -[@ai16z/eliza v0.1.3](../index.md) / Plugin +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Plugin # Type Alias: Plugin > **Plugin**: `object` +Plugin for extending agent functionality + ## Type declaration ### name > **name**: `string` +Plugin name + ### description > **description**: `string` +Plugin description + ### actions? > `optional` **actions**: [`Action`](../interfaces/Action.md)[] +Optional actions + ### providers? > `optional` **providers**: [`Provider`](../interfaces/Provider.md)[] +Optional providers + ### evaluators? > `optional` **evaluators**: [`Evaluator`](../interfaces/Evaluator.md)[] +Optional evaluators + ### services? > `optional` **services**: [`Service`](../classes/Service.md)[] +Optional services + ### clients? > `optional` **clients**: [`Client`](Client.md)[] +Optional clients + ## Defined in -[packages/core/src/types.ts:314](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L314) +[packages/core/src/types.ts:555](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L555) diff --git a/docs/api/type-aliases/UUID.md b/docs/api/type-aliases/UUID.md index 8efc5cd6427..207b73f0e90 100644 --- a/docs/api/type-aliases/UUID.md +++ b/docs/api/type-aliases/UUID.md @@ -1,10 +1,10 @@ -[@ai16z/eliza v0.1.3](../index.md) / UUID +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / UUID # Type Alias: UUID > **UUID**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` -Represents a UUID, which is a universally unique identifier conforming to the UUID standard. +Represents a UUID string in the format "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ## Defined in diff --git a/docs/api/type-aliases/Validator.md b/docs/api/type-aliases/Validator.md index 88c9fa90e8e..150d8733a2b 100644 --- a/docs/api/type-aliases/Validator.md +++ b/docs/api/type-aliases/Validator.md @@ -1,10 +1,10 @@ -[@ai16z/eliza v0.1.3](../index.md) / Validator +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / Validator # Type Alias: Validator() > **Validator**: (`runtime`, `message`, `state`?) => `Promise`\<`boolean`\> -Represents the type of a validator function, which takes a runtime instance, a message, and an optional state, and returns a promise resolving to a boolean indicating whether the validation passed. +Validator function type for actions/evaluators ## Parameters @@ -20,4 +20,4 @@ Represents the type of a validator function, which takes a runtime instance, a m ## Defined in -[packages/core/src/types.ts:208](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L208) +[packages/core/src/types.ts:366](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L366) diff --git a/docs/api/typedoc-sidebar.cjs b/docs/api/typedoc-sidebar.cjs index b914158da13..ff564b9dac9 100644 --- a/docs/api/typedoc-sidebar.cjs +++ b/docs/api/typedoc-sidebar.cjs @@ -1,4 +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":"doc","id":"enumerations/LoggingLevel","label":"LoggingLevel"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"classes/MemoryCacheAdapter","label":"MemoryCacheAdapter"},{"type":"doc","id":"classes/FsCacheAdapter","label":"FsCacheAdapter"},{"type":"doc","id":"classes/DbCacheAdapter","label":"DbCacheAdapter"},{"type":"doc","id":"classes/CacheManager","label":"CacheManager"},{"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/ICacheAdapter","label":"ICacheAdapter"},{"type":"doc","id":"interfaces/GenerationOptions","label":"GenerationOptions"},{"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/IDatabaseCacheAdapter","label":"IDatabaseCacheAdapter"},{"type":"doc","id":"interfaces/IMemoryManager","label":"IMemoryManager"},{"type":"doc","id":"interfaces/ICacheManager","label":"ICacheManager"},{"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/EnvConfig","label":"EnvConfig"},{"type":"doc","id":"type-aliases/CharacterConfig","label":"CharacterConfig"},{"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":"doc","id":"type-aliases/CacheOptions","label":"CacheOptions"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"variables/defaultCharacter","label":"defaultCharacter"},{"type":"doc","id":"variables/envSchema","label":"envSchema"},{"type":"doc","id":"variables/CharacterSchema","label":"CharacterSchema"},{"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/models","label":"models"},{"type":"doc","id":"variables/messageCompletionFooter","label":"messageCompletionFooter"},{"type":"doc","id":"variables/shouldRespondFooter","label":"shouldRespondFooter"},{"type":"doc","id":"variables/booleanFooter","label":"booleanFooter"},{"type":"doc","id":"variables/stringArrayFooter","label":"stringArrayFooter"},{"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/validateEnv","label":"validateEnv"},{"type":"doc","id":"functions/validateCharacterConfig","label":"validateCharacterConfig"},{"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/generateObjectV2","label":"generateObjectV2"},{"type":"doc","id":"functions/handleProvider","label":"handleProvider"},{"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/parseShouldRespondFromText","label":"parseShouldRespondFromText"},{"type":"doc","id":"functions/parseBooleanFromText","label":"parseBooleanFromText"},{"type":"doc","id":"functions/parseJsonArrayFromText","label":"parseJsonArrayFromText"},{"type":"doc","id":"functions/parseJSONObjectFromText","label":"parseJSONObjectFromText"},{"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/configureSettings","label":"configureSettings"},{"type":"doc","id":"functions/loadEnvConfig","label":"loadEnvConfig"},{"type":"doc","id":"functions/getEnvVariable","label":"getEnvVariable"},{"type":"doc","id":"functions/hasEnvVariable","label":"hasEnvVariable"},{"type":"doc","id":"functions/stringToUuid","label":"stringToUuid"}]}]}; +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":"doc","id":"enumerations/LoggingLevel","label":"LoggingLevel"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"classes/MemoryCacheAdapter","label":"MemoryCacheAdapter"},{"type":"doc","id":"classes/FsCacheAdapter","label":"FsCacheAdapter"},{"type":"doc","id":"classes/DbCacheAdapter","label":"DbCacheAdapter"},{"type":"doc","id":"classes/CacheManager","label":"CacheManager"},{"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/ICacheAdapter","label":"ICacheAdapter"},{"type":"doc","id":"interfaces/GenerationOptions","label":"GenerationOptions"},{"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/IDatabaseCacheAdapter","label":"IDatabaseCacheAdapter"},{"type":"doc","id":"interfaces/IMemoryManager","label":"IMemoryManager"},{"type":"doc","id":"interfaces/ICacheManager","label":"ICacheManager"},{"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/EnvConfig","label":"EnvConfig"},{"type":"doc","id":"type-aliases/CharacterConfig","label":"CharacterConfig"},{"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":"doc","id":"type-aliases/CacheOptions","label":"CacheOptions"},{"type":"doc","id":"type-aliases/KnowledgeItem","label":"KnowledgeItem"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"variables/defaultCharacter","label":"defaultCharacter"},{"type":"doc","id":"variables/envSchema","label":"envSchema"},{"type":"doc","id":"variables/CharacterSchema","label":"CharacterSchema"},{"type":"doc","id":"variables/evaluationTemplate","label":"evaluationTemplate"},{"type":"doc","id":"variables/knowledge","label":"knowledge"},{"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/models","label":"models"},{"type":"doc","id":"variables/messageCompletionFooter","label":"messageCompletionFooter"},{"type":"doc","id":"variables/shouldRespondFooter","label":"shouldRespondFooter"},{"type":"doc","id":"variables/booleanFooter","label":"booleanFooter"},{"type":"doc","id":"variables/stringArrayFooter","label":"stringArrayFooter"},{"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/validateEnv","label":"validateEnv"},{"type":"doc","id":"functions/validateCharacterConfig","label":"validateCharacterConfig"},{"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/generateObjectV2","label":"generateObjectV2"},{"type":"doc","id":"functions/handleProvider","label":"handleProvider"},{"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/parseShouldRespondFromText","label":"parseShouldRespondFromText"},{"type":"doc","id":"functions/parseBooleanFromText","label":"parseBooleanFromText"},{"type":"doc","id":"functions/parseJsonArrayFromText","label":"parseJsonArrayFromText"},{"type":"doc","id":"functions/parseJSONObjectFromText","label":"parseJSONObjectFromText"},{"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/configureSettings","label":"configureSettings"},{"type":"doc","id":"functions/loadEnvConfig","label":"loadEnvConfig"},{"type":"doc","id":"functions/getEnvVariable","label":"getEnvVariable"},{"type":"doc","id":"functions/hasEnvVariable","label":"hasEnvVariable"},{"type":"doc","id":"functions/stringToUuid","label":"stringToUuid"}]}]}; module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/api/variables/CharacterSchema.md b/docs/api/variables/CharacterSchema.md index f6a7feaaea3..d03e58dd1cc 100644 --- a/docs/api/variables/CharacterSchema.md +++ b/docs/api/variables/CharacterSchema.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / CharacterSchema +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / CharacterSchema # Variable: CharacterSchema diff --git a/docs/api/variables/booleanFooter.md b/docs/api/variables/booleanFooter.md index dce847a0340..eaca80dc199 100644 --- a/docs/api/variables/booleanFooter.md +++ b/docs/api/variables/booleanFooter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / booleanFooter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / booleanFooter # Variable: booleanFooter diff --git a/docs/api/variables/defaultCharacter.md b/docs/api/variables/defaultCharacter.md index 440af0a0aa1..cb092bc81f5 100644 --- a/docs/api/variables/defaultCharacter.md +++ b/docs/api/variables/defaultCharacter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / defaultCharacter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / defaultCharacter # Variable: defaultCharacter diff --git a/docs/api/variables/elizaLogger.md b/docs/api/variables/elizaLogger.md index 3ccab07c80e..6781da0457a 100644 --- a/docs/api/variables/elizaLogger.md +++ b/docs/api/variables/elizaLogger.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / elizaLogger +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / elizaLogger # Variable: elizaLogger @@ -6,4 +6,4 @@ ## Defined in -[packages/core/src/logger.ts:241](https://github.com/ai16z/eliza/blob/main/packages/core/src/logger.ts#L241) +[packages/core/src/logger.ts:264](https://github.com/ai16z/eliza/blob/main/packages/core/src/logger.ts#L264) diff --git a/docs/api/variables/embeddingDimension.md b/docs/api/variables/embeddingDimension.md index e72da188361..202732e6df4 100644 --- a/docs/api/variables/embeddingDimension.md +++ b/docs/api/variables/embeddingDimension.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / embeddingDimension +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / embeddingDimension # Variable: embeddingDimension diff --git a/docs/api/variables/embeddingZeroVector.md b/docs/api/variables/embeddingZeroVector.md index c4227cee86c..42a55a883fc 100644 --- a/docs/api/variables/embeddingZeroVector.md +++ b/docs/api/variables/embeddingZeroVector.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / embeddingZeroVector +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / embeddingZeroVector # Variable: embeddingZeroVector diff --git a/docs/api/variables/envSchema.md b/docs/api/variables/envSchema.md index 7540d3d23e6..36618f477e2 100644 --- a/docs/api/variables/envSchema.md +++ b/docs/api/variables/envSchema.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / envSchema +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / envSchema # Variable: envSchema diff --git a/docs/api/variables/evaluationTemplate.md b/docs/api/variables/evaluationTemplate.md index ee125581b13..c9340abac7d 100644 --- a/docs/api/variables/evaluationTemplate.md +++ b/docs/api/variables/evaluationTemplate.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / evaluationTemplate +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / evaluationTemplate # Variable: evaluationTemplate diff --git a/docs/api/variables/knowledge.md b/docs/api/variables/knowledge.md new file mode 100644 index 00000000000..859ddc0e7ab --- /dev/null +++ b/docs/api/variables/knowledge.md @@ -0,0 +1,47 @@ +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / knowledge + +# Variable: knowledge + +> **knowledge**: `object` + +## Type declaration + +### get() + +> **get**: (`runtime`, `message`) => `Promise`\<`string`[]\> + +#### Parameters + +• **runtime**: [`AgentRuntime`](../classes/AgentRuntime.md) + +• **message**: [`Memory`](../interfaces/Memory.md) + +#### Returns + +`Promise`\<`string`[]\> + +### set() + +> **set**: (`runtime`, `item`, `chunkSize`, `bleed`) => `Promise`\<`void`\> + +#### Parameters + +• **runtime**: [`AgentRuntime`](../classes/AgentRuntime.md) + +• **item**: [`KnowledgeItem`](../type-aliases/KnowledgeItem.md) + +• **chunkSize**: `number` = `512` + +• **bleed**: `number` = `20` + +#### Returns + +`Promise`\<`void`\> + +### process + +> **process**: `Process` + +## Defined in + +[packages/core/src/knowledge.ts:116](https://github.com/ai16z/eliza/blob/main/packages/core/src/knowledge.ts#L116) diff --git a/docs/api/variables/messageCompletionFooter.md b/docs/api/variables/messageCompletionFooter.md index a3cc89795d9..edb027e3927 100644 --- a/docs/api/variables/messageCompletionFooter.md +++ b/docs/api/variables/messageCompletionFooter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / messageCompletionFooter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / messageCompletionFooter # Variable: messageCompletionFooter diff --git a/docs/api/variables/models.md b/docs/api/variables/models.md index 3dcfec01fec..028aa1ba0a8 100644 --- a/docs/api/variables/models.md +++ b/docs/api/variables/models.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / models +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / models # Variable: models diff --git a/docs/api/variables/settings.md b/docs/api/variables/settings.md index 4e3bad4324e..ac13104ebfd 100644 --- a/docs/api/variables/settings.md +++ b/docs/api/variables/settings.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / settings +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / settings # Variable: settings diff --git a/docs/api/variables/shouldRespondFooter.md b/docs/api/variables/shouldRespondFooter.md index 52b7d30aa40..1d055ad00e9 100644 --- a/docs/api/variables/shouldRespondFooter.md +++ b/docs/api/variables/shouldRespondFooter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / shouldRespondFooter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / shouldRespondFooter # Variable: shouldRespondFooter diff --git a/docs/api/variables/stringArrayFooter.md b/docs/api/variables/stringArrayFooter.md index d99c919a569..de7a7dd8fec 100644 --- a/docs/api/variables/stringArrayFooter.md +++ b/docs/api/variables/stringArrayFooter.md @@ -1,4 +1,4 @@ -[@ai16z/eliza v0.1.3](../index.md) / stringArrayFooter +[@ai16z/eliza v0.1.4-alpha.3](../index.md) / stringArrayFooter # Variable: stringArrayFooter