Merge pull request #253 from ai16z/docs

Update docs

Author: lalalune

docs/api/classes/AgentRuntime.md

@@ -95,7 +95,7 @@ The ID of the agent
 
 [packages/core/src/runtime.ts:59](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L59)
 
----
+***
 
 ### serverUrl
 
@@ -111,7 +111,7 @@ The base URL of the server where the agent's requests are processed.
 
 [packages/core/src/runtime.ts:63](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L63)
 
----
+***
 
 ### databaseAdapter
 
@@ -127,7 +127,7 @@ The database adapter used for interacting with the database.
 
 [packages/core/src/runtime.ts:68](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L68)
 
----
+***
 
 ### token
 
@@ -143,7 +143,7 @@ Authentication token used for securing requests.
 
 [packages/core/src/runtime.ts:73](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L73)
 
----
+***
 
 ### actions
 
@@ -159,7 +159,7 @@ Custom actions that the agent can perform.
 
 [packages/core/src/runtime.ts:78](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L78)
 
----
+***
 
 ### evaluators
 
@@ -175,7 +175,7 @@ Evaluators used to assess and guide the agent's responses.
 
 [packages/core/src/runtime.ts:83](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L83)
 
----
+***
 
 ### providers
 
@@ -191,7 +191,7 @@ Context providers used to provide context for message generation.
 
 [packages/core/src/runtime.ts:88](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L88)
 
----
+***
 
 ### modelProvider
 
@@ -207,7 +207,7 @@ The model to use for generateText.
 
 [packages/core/src/runtime.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L93)
 
----
+***
 
 ### fetch()
 
@@ -242,7 +242,7 @@ Some environments may not have access to the global fetch function and need a cu
 
 [packages/core/src/runtime.ts:99](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L99)
 
----
+***
 
 ### character
 
@@ -258,7 +258,7 @@ The character to use for the agent
 
 [packages/core/src/runtime.ts:104](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L104)
 
----
+***
 
 ### messageManager
 
@@ -274,7 +274,7 @@ Store messages that are sent and received by the agent.
 
 [packages/core/src/runtime.ts:109](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L109)
 
----
+***
 
 ### descriptionManager
 
@@ -290,7 +290,7 @@ Store and recall descriptions of users based on conversations.
 
 [packages/core/src/runtime.ts:114](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L114)
 
----
+***
 
 ### loreManager
 
@@ -306,7 +306,7 @@ Manage the creation and recall of static information (documents, historical game
 
 [packages/core/src/runtime.ts:119](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L119)
 
----
+***
 
 ### documentsManager
 
@@ -318,7 +318,7 @@ Hold large documents that can be referenced
 
 [packages/core/src/runtime.ts:124](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L124)
 
----
+***
 
 ### fragmentsManager
 
@@ -330,7 +330,7 @@ Searchable document fragments
 
 [packages/core/src/runtime.ts:129](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L129)
 
----
+***
 
 ### services
 
@@ -344,7 +344,7 @@ Searchable document fragments
 
 [packages/core/src/runtime.ts:131](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L131)
 
----
+***
 
 ### memoryManagers
 
@@ -376,7 +376,7 @@ Searchable document fragments
 
 [packages/core/src/runtime.ts:134](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L134)
 
----
+***
 
 ### getMemoryManager()
 
@@ -398,7 +398,7 @@ Searchable document fragments
 
 [packages/core/src/runtime.ts:149](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L149)
 
----
+***
 
 ### getService()
 
@@ -424,7 +424,7 @@ Searchable document fragments
 
 [packages/core/src/runtime.ts:153](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L153)
 
----
+***
 
 ### registerService()
 
@@ -446,7 +446,7 @@ Searchable document fragments
 
 [packages/core/src/runtime.ts:161](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L161)
 
----
+***
 
 ### getSetting()
 
@@ -472,7 +472,7 @@ then chunks the content into fragments, embeds each fragment, and creates fragme
 
 [packages/core/src/runtime.ts:371](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L371)
 
----
+***
 
 ### getConversationLength()
 
@@ -494,7 +494,7 @@ The number of recent messages to be kept in memory.
 
 [packages/core/src/runtime.ts:393](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L393)
 
----
+***
 
 ### registerAction()
 
@@ -520,7 +520,7 @@ The action to register.
 
 [packages/core/src/runtime.ts:401](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L401)
 
----
+***
 
 ### registerEvaluator()
 
@@ -542,7 +542,7 @@ The evaluator to register.
 
 [packages/core/src/runtime.ts:410](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L410)
 
----
+***
 
 ### registerContextProvider()
 
@@ -564,7 +564,7 @@ The context provider to register.
 
 [packages/core/src/runtime.ts:418](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L418)
 
----
+***
 
 ### processActions()
 
@@ -596,11 +596,11 @@ The message to process.
 
 [packages/core/src/runtime.ts:427](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L427)
 
----
+***
 
 ### evaluate()
 
-> **evaluate**(`message`, `state`?): `Promise`\<`string`[]\>
+> **evaluate**(`message`, `state`?, `didRespond`?): `Promise`\<`string`[]\>
 
 Evaluate the message and state using the registered evaluators.
 
@@ -614,6 +614,10 @@ The message to evaluate.
 
 The state of the agent.
 
+• **didRespond?**: `boolean`
+
+Whether the agent responded to the message.
+
 #### Returns
 
 `Promise`\<`string`[]\>
@@ -626,9 +630,9 @@ The results of the evaluation.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:499](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L499)
+[packages/core/src/runtime.ts:500](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L500)
 
----
+***
 
 ### ensureParticipantExists()
 
@@ -658,9 +662,9 @@ An error if the participant cannot be added.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:565](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L565)
+[packages/core/src/runtime.ts:571](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L571)
 
----
+***
 
 ### ensureUserExists()
 
@@ -694,9 +698,9 @@ The user name to ensure the existence of.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:581](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L581)
+[packages/core/src/runtime.ts:587](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L587)
 
----
+***
 
 ### ensureParticipantInRoom()
 
@@ -718,9 +722,9 @@ The user name to ensure the existence of.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:601](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L601)
+[packages/core/src/runtime.ts:607](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L607)
 
----
+***
 
 ### ensureConnection()
 
@@ -748,9 +752,9 @@ The user name to ensure the existence of.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:612](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L612)
+[packages/core/src/runtime.ts:618](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L618)
 
----
+***
 
 ### ensureRoomExists()
 
@@ -779,9 +783,9 @@ An error if the room cannot be created.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:648](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L648)
+[packages/core/src/runtime.ts:654](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L654)
 
----
+***
 
 ### composeState()
 
@@ -809,9 +813,9 @@ The state of the agent.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:661](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L661)
+[packages/core/src/runtime.ts:667](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L667)
 
----
+***
 
 ### updateRecentMessageState()
 
@@ -831,4 +835,4 @@ The state of the agent.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:1094](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1094)
+[packages/core/src/runtime.ts:1100](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1100)