Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken docs #321

Merged
merged 2 commits into from
Nov 15, 2024
Merged

Fix broken docs #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
951aa3e
fix broken links in stream notes
madjin Nov 15, 2024
4f11b3b
fix docs
madjin Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 42 additions & 46 deletions docs/api/classes/AgentRuntime.md
View file
Open in desktop
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,23 +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**\<`T`\>(`service`): `T`
#### Type Parameters

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

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

#### Returns

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

#### Implementation of

Expand All @@ -426,7 +422,7 @@ Searchable document fragments

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

---
***

### registerService()

Expand All @@ -448,7 +444,7 @@ Searchable document fragments

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

---
***

### getSetting()

Expand All @@ -470,7 +466,7 @@ Searchable document fragments

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

---
***

### getConversationLength()

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

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

---
***

### registerAction()

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

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

---
***

### registerEvaluator()

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

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

---
***

### registerContextProvider()

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

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

---
***

### processActions()

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

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

---
***

### evaluate()

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

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

---
***

### ensureParticipantExists()

Expand Down Expand Up @@ -660,9 +656,9 @@ An error if the participant cannot be added.

#### Defined in

[packages/core/src/runtime.ts:572](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L572)
[packages/core/src/runtime.ts:571](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L571)

---
***

### ensureUserExists()

Expand Down Expand Up @@ -696,9 +692,9 @@ The user name to ensure the existence of.

#### Defined in

[packages/core/src/runtime.ts:588](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L588)
[packages/core/src/runtime.ts:587](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L587)

---
***

### ensureParticipantInRoom()

Expand All @@ -720,9 +716,9 @@ The user name to ensure the existence of.

#### Defined in

[packages/core/src/runtime.ts:608](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L608)
[packages/core/src/runtime.ts:607](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L607)

---
***

### ensureConnection()

Expand Down Expand Up @@ -750,9 +746,9 @@ The user name to ensure the existence of.

#### Defined in

[packages/core/src/runtime.ts:619](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L619)
[packages/core/src/runtime.ts:618](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L618)

---
***

### ensureRoomExists()

Expand Down Expand Up @@ -781,9 +777,9 @@ An error if the room cannot be created.

#### Defined in

[packages/core/src/runtime.ts:655](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L655)
[packages/core/src/runtime.ts:654](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L654)

---
***

### composeState()

Expand Down Expand Up @@ -811,9 +807,9 @@ The state of the agent.

#### Defined in

[packages/core/src/runtime.ts:668](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L668)
[packages/core/src/runtime.ts:667](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L667)

---
***

### updateRecentMessageState()

Expand All @@ -833,4 +829,4 @@ The state of the agent.

#### Defined in

[packages/core/src/runtime.ts:1126](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1126)
[packages/core/src/runtime.ts:1124](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1124)
Loading
Loading