Skip to content

Commit b7b7fca

Browse files
authored
Merge pull request #321 from ai16z/fix_docs
Fix broken docs
2 parents 8805eb4 + 4f11b3b commit b7b7fca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+4446
-4079
lines changed

docs/api/classes/AgentRuntime.md

+42-46
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ The ID of the agent
9797

9898
[packages/core/src/runtime.ts:59](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L59)
9999

100-
---
100+
***
101101

102102
### serverUrl
103103

@@ -113,7 +113,7 @@ The base URL of the server where the agent's requests are processed.
113113

114114
[packages/core/src/runtime.ts:63](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L63)
115115

116-
---
116+
***
117117

118118
### databaseAdapter
119119

@@ -129,7 +129,7 @@ The database adapter used for interacting with the database.
129129

130130
[packages/core/src/runtime.ts:68](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L68)
131131

132-
---
132+
***
133133

134134
### token
135135

@@ -145,7 +145,7 @@ Authentication token used for securing requests.
145145

146146
[packages/core/src/runtime.ts:73](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L73)
147147

148-
---
148+
***
149149

150150
### actions
151151

@@ -161,7 +161,7 @@ Custom actions that the agent can perform.
161161

162162
[packages/core/src/runtime.ts:78](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L78)
163163

164-
---
164+
***
165165

166166
### evaluators
167167

@@ -177,7 +177,7 @@ Evaluators used to assess and guide the agent's responses.
177177

178178
[packages/core/src/runtime.ts:83](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L83)
179179

180-
---
180+
***
181181

182182
### providers
183183

@@ -193,7 +193,7 @@ Context providers used to provide context for message generation.
193193

194194
[packages/core/src/runtime.ts:88](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L88)
195195

196-
---
196+
***
197197

198198
### modelProvider
199199

@@ -209,7 +209,7 @@ The model to use for generateText.
209209

210210
[packages/core/src/runtime.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L93)
211211

212-
---
212+
***
213213

214214
### fetch()
215215

@@ -244,7 +244,7 @@ Some environments may not have access to the global fetch function and need a cu
244244

245245
[packages/core/src/runtime.ts:99](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L99)
246246

247-
---
247+
***
248248

249249
### character
250250

@@ -260,7 +260,7 @@ The character to use for the agent
260260

261261
[packages/core/src/runtime.ts:104](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L104)
262262

263-
---
263+
***
264264

265265
### messageManager
266266

@@ -276,7 +276,7 @@ Store messages that are sent and received by the agent.
276276

277277
[packages/core/src/runtime.ts:109](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L109)
278278

279-
---
279+
***
280280

281281
### descriptionManager
282282

@@ -292,7 +292,7 @@ Store and recall descriptions of users based on conversations.
292292

293293
[packages/core/src/runtime.ts:114](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L114)
294294

295-
---
295+
***
296296

297297
### loreManager
298298

@@ -308,7 +308,7 @@ Manage the creation and recall of static information (documents, historical game
308308

309309
[packages/core/src/runtime.ts:119](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L119)
310310

311-
---
311+
***
312312

313313
### documentsManager
314314

@@ -320,7 +320,7 @@ Hold large documents that can be referenced
320320

321321
[packages/core/src/runtime.ts:124](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L124)
322322

323-
---
323+
***
324324

325325
### knowledgeManager
326326

@@ -332,7 +332,7 @@ Searchable document fragments
332332

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

335-
---
335+
***
336336

337337
### services
338338

@@ -346,7 +346,7 @@ Searchable document fragments
346346

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

349-
---
349+
***
350350

351351
### memoryManagers
352352

@@ -378,7 +378,7 @@ Searchable document fragments
378378

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

381-
---
381+
***
382382

383383
### getMemoryManager()
384384

@@ -400,23 +400,19 @@ Searchable document fragments
400400

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

403-
---
403+
***
404404

405405
### getService()
406406

407-
> **getService**\<`T`\>(`service`): `T`
408-
409-
#### Type Parameters
410-
411-
**T**
407+
> **getService**(`service`): *typeof* [`Service`](Service.md)
412408
413409
#### Parameters
414410

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

417413
#### Returns
418414

419-
`T`
415+
*typeof* [`Service`](Service.md)
420416

421417
#### Implementation of
422418

@@ -426,7 +422,7 @@ Searchable document fragments
426422

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

429-
---
425+
***
430426

431427
### registerService()
432428

@@ -448,7 +444,7 @@ Searchable document fragments
448444

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

451-
---
447+
***
452448

453449
### getSetting()
454450

@@ -470,7 +466,7 @@ Searchable document fragments
470466

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

473-
---
469+
***
474470

475471
### getConversationLength()
476472

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

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

495-
---
491+
***
496492

497493
### registerAction()
498494

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

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

521-
---
517+
***
522518

523519
### registerEvaluator()
524520

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

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

543-
---
539+
***
544540

545541
### registerContextProvider()
546542

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

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

565-
---
561+
***
566562

567563
### processActions()
568564

@@ -594,7 +590,7 @@ The message to process.
594590

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

597-
---
593+
***
598594

599595
### evaluate()
600596

@@ -630,7 +626,7 @@ The results of the evaluation.
630626

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

633-
---
629+
***
634630

635631
### ensureParticipantExists()
636632

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

661657
#### Defined in
662658

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

665-
---
661+
***
666662

667663
### ensureUserExists()
668664

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

697693
#### Defined in
698694

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

701-
---
697+
***
702698

703699
### ensureParticipantInRoom()
704700

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

721717
#### Defined in
722718

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

725-
---
721+
***
726722

727723
### ensureConnection()
728724

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

751747
#### Defined in
752748

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

755-
---
751+
***
756752

757753
### ensureRoomExists()
758754

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

782778
#### Defined in
783779

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

786-
---
782+
***
787783

788784
### composeState()
789785

@@ -811,9 +807,9 @@ The state of the agent.
811807

812808
#### Defined in
813809

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

816-
---
812+
***
817813

818814
### updateRecentMessageState()
819815

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

834830
#### Defined in
835831

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

0 commit comments

Comments
 (0)