Skip to content

Commit

Permalink
Merge pull request #364 from ai16z/new_docs
Browse files Browse the repository at this point in the history
feat: update docs with new stream notes
  • Loading branch information
twilwa authored Nov 16, 2024
2 parents ccdf3db + 7e7a230 commit 4b1caa0
Show file tree
Hide file tree
Showing 45 changed files with 947 additions and 680 deletions.
70 changes: 35 additions & 35 deletions docs/api/classes/AgentRuntime.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,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

Expand All @@ -113,7 +113,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

Expand All @@ -129,7 +129,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

Expand All @@ -145,7 +145,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

Expand All @@ -161,7 +161,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

Expand All @@ -177,7 +177,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

Expand All @@ -193,7 +193,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

Expand All @@ -209,7 +209,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()

Expand Down Expand Up @@ -244,7 +244,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

Expand All @@ -260,7 +260,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

Expand All @@ -276,7 +276,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

Expand All @@ -292,7 +292,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

Expand All @@ -308,7 +308,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

Expand All @@ -320,7 +320,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)

---
***

### knowledgeManager

Expand All @@ -332,7 +332,7 @@ Searchable document fragments

[packages/core/src/runtime.ts:129](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L129)

---
***

### services

Expand All @@ -346,7 +346,7 @@ Searchable document fragments

[packages/core/src/runtime.ts:131](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L131)

---
***

### memoryManagers

Expand Down Expand Up @@ -378,7 +378,7 @@ Searchable document fragments

[packages/core/src/runtime.ts:134](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L134)

---
***

### getMemoryManager()

Expand All @@ -400,19 +400,19 @@ Searchable document fragments

[packages/core/src/runtime.ts:149](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L149)

---
***

### getService()

> **getService**(`service`): _typeof_ [`Service`](Service.md)
> **getService**(`service`): *typeof* [`Service`](Service.md)
#### Parameters

**service**: [`ServiceType`](../enumerations/ServiceType.md)

#### Returns

_typeof_ [`Service`](Service.md)
*typeof* [`Service`](Service.md)

#### Implementation of

Expand All @@ -422,7 +422,7 @@ _typeof_ [`Service`](Service.md)

[packages/core/src/runtime.ts:153](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L153)

---
***

### registerService()

Expand All @@ -444,7 +444,7 @@ _typeof_ [`Service`](Service.md)

[packages/core/src/runtime.ts:161](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L161)

---
***

### getSetting()

Expand All @@ -466,7 +466,7 @@ _typeof_ [`Service`](Service.md)

[packages/core/src/runtime.ts:368](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L368)

---
***

### getConversationLength()

Expand All @@ -488,7 +488,7 @@ The number of recent messages to be kept in memory.

[packages/core/src/runtime.ts:390](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L390)

---
***

### registerAction()

Expand All @@ -514,7 +514,7 @@ The action to register.

[packages/core/src/runtime.ts:398](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L398)

---
***

### registerEvaluator()

Expand All @@ -536,7 +536,7 @@ The evaluator to register.

[packages/core/src/runtime.ts:407](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L407)

---
***

### registerContextProvider()

Expand All @@ -558,7 +558,7 @@ The context provider to register.

[packages/core/src/runtime.ts:415](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L415)

---
***

### processActions()

Expand Down Expand Up @@ -590,7 +590,7 @@ The message to process.

[packages/core/src/runtime.ts:424](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L424)

---
***

### evaluate()

Expand Down Expand Up @@ -626,7 +626,7 @@ The results of the evaluation.

[packages/core/src/runtime.ts:497](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L497)

---
***

### ensureParticipantExists()

Expand Down Expand Up @@ -658,7 +658,7 @@ An error if the participant cannot be added.

[packages/core/src/runtime.ts:567](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L567)

---
***

### ensureUserExists()

Expand Down Expand Up @@ -694,7 +694,7 @@ The user name to ensure the existence of.

[packages/core/src/runtime.ts:583](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L583)

---
***

### ensureParticipantInRoom()

Expand All @@ -718,7 +718,7 @@ The user name to ensure the existence of.

[packages/core/src/runtime.ts:603](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L603)

---
***

### ensureConnection()

Expand Down Expand Up @@ -748,7 +748,7 @@ The user name to ensure the existence of.

[packages/core/src/runtime.ts:614](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L614)

---
***

### ensureRoomExists()

Expand Down Expand Up @@ -779,7 +779,7 @@ An error if the room cannot be created.

[packages/core/src/runtime.ts:650](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L650)

---
***

### composeState()

Expand Down Expand Up @@ -809,7 +809,7 @@ The state of the agent.

[packages/core/src/runtime.ts:663](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L663)

---
***

### updateRecentMessageState()

Expand Down
Loading

0 comments on commit 4b1caa0

Please sign in to comment.