Merge pull request #3772 from elizaOS/jin-better-docs

chore: improve quickstart, plugin showcase, doc fixes
elizaOS · Mar 5, 2025 · a8a8313 · a8a8313
2 parents 3ff8bbc + 265940d
commit a8a8313
Show file tree

Hide file tree

Showing 549 changed files with 31,897 additions and 4,381 deletions.
diff --git a/docs/api/classes/AgentRuntime.md b/docs/api/classes/AgentRuntime.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / AgentRuntime
+[@elizaos/core v0.25.9](../index.md) / AgentRuntime
 
 # Class: AgentRuntime
 
@@ -272,7 +272,7 @@ The model to use for describing images.
 
 ### fetch()
 
-> **fetch**: (`input`, `init`?) => `Promise`\<`Response`\>(`input`, `init`?) => `Promise`\<`Response`\>
+> **fetch**: (`input`, `init`?) => `Promise`\<`Response`\>
 
 Fetch function to use
 Some environments may not have access to the global fetch function and need a custom fetch override.
@@ -289,16 +289,6 @@ Some environments may not have access to the global fetch function and need a cu
 
 `Promise`\<`Response`\>
 
-#### Parameters
-
-• **input**: `string` \| `Request` \| `URL`
-
-• **init?**: `RequestInit`
-
-#### Returns
-
-`Promise`\<`Response`\>
-
 #### Implementation of
 
 [`IAgentRuntime`](../interfaces/IAgentRuntime.md).[`fetch`](../interfaces/IAgentRuntime.md#fetch)
@@ -617,7 +607,7 @@ verifiableInferenceAdapter?: IVerifiableInferenceAdapter | null;
 
 #### Defined in
 
-[packages/core/src/runtime.ts:945](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L945)
+[packages/core/src/runtime.ts:959](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L959)
 
 ***
 
@@ -639,7 +629,7 @@ The number of recent messages to be kept in memory.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:967](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L967)
+[packages/core/src/runtime.ts:981](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L981)
 
 ***
 
@@ -665,7 +655,7 @@ The action to register.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:975](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L975)
+[packages/core/src/runtime.ts:989](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L989)
 
 ***
 
@@ -687,7 +677,7 @@ The evaluator to register.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:984](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L984)
+[packages/core/src/runtime.ts:998](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L998)
 
 ***
 
@@ -709,7 +699,7 @@ The context provider to register.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:992](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L992)
+[packages/core/src/runtime.ts:1006](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1006)
 
 ***
 
@@ -731,7 +721,7 @@ The adapter to register.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1000](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1000)
+[packages/core/src/runtime.ts:1014](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1014)
 
 ***
 
@@ -763,7 +753,7 @@ The message to process.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1009](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1009)
+[packages/core/src/runtime.ts:1023](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1023)
 
 ***
 
@@ -803,7 +793,7 @@ The results of the evaluation.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1093](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1093)
+[packages/core/src/runtime.ts:1107](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1107)
 
 ***
 
@@ -835,7 +825,7 @@ An error if the participant cannot be added.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1163](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1163)
+[packages/core/src/runtime.ts:1177](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1177)
 
 ***
 
@@ -871,7 +861,7 @@ The user name to ensure the existence of.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1179](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1179)
+[packages/core/src/runtime.ts:1193](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1193)
 
 ***
 
@@ -895,7 +885,7 @@ The user name to ensure the existence of.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1205](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1205)
+[packages/core/src/runtime.ts:1219](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1219)
 
 ***
 
@@ -925,7 +915,7 @@ The user name to ensure the existence of.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1222](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1222)
+[packages/core/src/runtime.ts:1236](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1236)
 
 ***
 
@@ -956,7 +946,7 @@ An error if the room cannot be created.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1258](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1258)
+[packages/core/src/runtime.ts:1272](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1272)
 
 ***
 
@@ -986,7 +976,7 @@ The state of the agent.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1271](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1271)
+[packages/core/src/runtime.ts:1285](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1285)
 
 ***
 
@@ -1008,4 +998,4 @@ The state of the agent.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1728](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1728)
+[packages/core/src/runtime.ts:1742](https://github.com/elizaOS/eliza/blob/main/packages/core/src/runtime.ts#L1742)
diff --git a/docs/api/classes/CacheManager.md b/docs/api/classes/CacheManager.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / CacheManager
+[@elizaos/core v0.25.9](../index.md) / CacheManager
 
 # Class: CacheManager\<CacheAdapter\>
 

diff --git a/docs/api/classes/DatabaseAdapter.md b/docs/api/classes/DatabaseAdapter.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / DatabaseAdapter
+[@elizaos/core v0.25.9](../index.md) / DatabaseAdapter
 
 # Class: `abstract` DatabaseAdapter\<DB\>
 

diff --git a/docs/api/classes/DbCacheAdapter.md b/docs/api/classes/DbCacheAdapter.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / DbCacheAdapter
+[@elizaos/core v0.25.9](../index.md) / DbCacheAdapter
 
 # Class: DbCacheAdapter
 

diff --git a/docs/api/classes/FsCacheAdapter.md b/docs/api/classes/FsCacheAdapter.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / FsCacheAdapter
+[@elizaos/core v0.25.9](../index.md) / FsCacheAdapter
 
 # Class: FsCacheAdapter
 

diff --git a/docs/api/classes/MemoryCacheAdapter.md b/docs/api/classes/MemoryCacheAdapter.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / MemoryCacheAdapter
+[@elizaos/core v0.25.9](../index.md) / MemoryCacheAdapter
 
 # Class: MemoryCacheAdapter
 

diff --git a/docs/api/classes/MemoryManager.md b/docs/api/classes/MemoryManager.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / MemoryManager
+[@elizaos/core v0.25.9](../index.md) / MemoryManager
 
 # Class: MemoryManager
 
@@ -278,6 +278,28 @@ A Promise that resolves when the operation completes.
 
 ***
 
+### getMemoriesByIds()
+
+> **getMemoriesByIds**(`ids`): `Promise`\<[`Memory`](../interfaces/Memory.md)[]\>
+
+#### Parameters
+
+• **ids**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\`[]
+
+#### Returns
+
+`Promise`\<[`Memory`](../interfaces/Memory.md)[]\>
+
+#### Implementation of
+
+[`IMemoryManager`](../interfaces/IMemoryManager.md).[`getMemoriesByIds`](../interfaces/IMemoryManager.md#getMemoriesByIds)
+
+#### Defined in
+
+[packages/core/src/memory.ts:201](https://github.com/elizaOS/eliza/blob/main/packages/core/src/memory.ts#L201)
+
+***
+
 ### getMemoryById()
 
 > **getMemoryById**(`id`): `Promise`\<[`Memory`](../interfaces/Memory.md)\>
@@ -296,7 +318,7 @@ A Promise that resolves when the operation completes.
 
 #### Defined in
 
-[packages/core/src/memory.ts:201](https://github.com/elizaOS/eliza/blob/main/packages/core/src/memory.ts#L201)
+[packages/core/src/memory.ts:205](https://github.com/elizaOS/eliza/blob/main/packages/core/src/memory.ts#L205)
 
 ***
 
@@ -324,7 +346,7 @@ A Promise that resolves when the operation completes.
 
 #### Defined in
 
-[packages/core/src/memory.ts:212](https://github.com/elizaOS/eliza/blob/main/packages/core/src/memory.ts#L212)
+[packages/core/src/memory.ts:216](https://github.com/elizaOS/eliza/blob/main/packages/core/src/memory.ts#L216)
 
 ***
 
@@ -352,7 +374,7 @@ A Promise that resolves when the operation completes.
 
 #### Defined in
 
-[packages/core/src/memory.ts:224](https://github.com/elizaOS/eliza/blob/main/packages/core/src/memory.ts#L224)
+[packages/core/src/memory.ts:228](https://github.com/elizaOS/eliza/blob/main/packages/core/src/memory.ts#L228)
 
 ***
 
@@ -384,4 +406,4 @@ A Promise resolving to the count of memories.
 
 #### Defined in
 
-[packages/core/src/memory.ts:237](https://github.com/elizaOS/eliza/blob/main/packages/core/src/memory.ts#L237)
+[packages/core/src/memory.ts:241](https://github.com/elizaOS/eliza/blob/main/packages/core/src/memory.ts#L241)
diff --git a/docs/api/classes/RAGKnowledgeManager.md b/docs/api/classes/RAGKnowledgeManager.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / RAGKnowledgeManager
+[@elizaos/core v0.25.9](../index.md) / RAGKnowledgeManager
 
 # Class: RAGKnowledgeManager
 

diff --git a/docs/api/classes/Service.md b/docs/api/classes/Service.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / Service
+[@elizaos/core v0.25.9](../index.md) / Service
 
 # Class: `abstract` Service
 
@@ -40,7 +40,7 @@
 
 #### Defined in
 
-[packages/core/src/types.ts:1268](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1268)
+[packages/core/src/types.ts:1269](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1269)
 
 ***
 
@@ -56,7 +56,7 @@
 
 #### Defined in
 
-[packages/core/src/types.ts:1279](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1279)
+[packages/core/src/types.ts:1280](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1280)
 
 ## Methods
 
@@ -74,7 +74,7 @@
 
 #### Defined in
 
-[packages/core/src/types.ts:1272](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1272)
+[packages/core/src/types.ts:1273](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1273)
 
 ***
 
@@ -94,4 +94,4 @@ Add abstract initialize method that must be implemented by derived classes
 
 #### Defined in
 
-[packages/core/src/types.ts:1284](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1284)
+[packages/core/src/types.ts:1285](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1285)
diff --git a/docs/api/enumerations/ActionTimelineType.md b/docs/api/enumerations/ActionTimelineType.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / ActionTimelineType
+[@elizaos/core v0.25.9](../index.md) / ActionTimelineType
 
 # Enumeration: ActionTimelineType
 
@@ -10,7 +10,7 @@
 
 #### Defined in
 
-[packages/core/src/types.ts:1601](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1601)
+[packages/core/src/types.ts:1602](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1602)
 
 ***
 
@@ -20,4 +20,4 @@
 
 #### Defined in
 
-[packages/core/src/types.ts:1602](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1602)
+[packages/core/src/types.ts:1603](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1603)
diff --git a/docs/api/enumerations/CacheKeyPrefix.md b/docs/api/enumerations/CacheKeyPrefix.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / CacheKeyPrefix
+[@elizaos/core v0.25.9](../index.md) / CacheKeyPrefix
 
 # Enumeration: CacheKeyPrefix
 
@@ -10,4 +10,4 @@
 
 #### Defined in
 
-[packages/core/src/types.ts:1610](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1610)
+[packages/core/src/types.ts:1611](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1611)
diff --git a/docs/api/enumerations/CacheStore.md b/docs/api/enumerations/CacheStore.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / CacheStore
+[@elizaos/core v0.25.9](../index.md) / CacheStore
 
 # Enumeration: CacheStore
 
@@ -10,7 +10,7 @@
 
 #### Defined in
 
-[packages/core/src/types.ts:1254](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1254)
+[packages/core/src/types.ts:1255](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1255)
 
 ***
 
@@ -20,7 +20,7 @@
 
 #### Defined in
 
-[packages/core/src/types.ts:1255](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1255)
+[packages/core/src/types.ts:1256](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1256)
 
 ***
 
@@ -30,4 +30,4 @@
 
 #### Defined in
 
-[packages/core/src/types.ts:1256](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1256)
+[packages/core/src/types.ts:1257](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L1257)
diff --git a/docs/api/enumerations/GoalStatus.md b/docs/api/enumerations/GoalStatus.md
@@ -1,4 +1,4 @@
-[@elizaos/core v0.25.8](../index.md) / GoalStatus
+[@elizaos/core v0.25.9](../index.md) / GoalStatus
 
 # Enumeration: GoalStatus