Skip to content

Commit 63cd52d

Browse files
committed
update api docs
1 parent 577ef88 commit 63cd52d

File tree

127 files changed

+990
-624
lines changed

Some content is hidden

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

127 files changed

+990
-624
lines changed

docs/api/classes/AgentRuntime.md

+48-40
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[@ai16z/eliza v0.1.3](../index.md) / AgentRuntime
1+
[@ai16z/eliza v0.1.4-alpha.3](../index.md) / AgentRuntime
22

33
# Class: AgentRuntime
44

@@ -83,7 +83,7 @@ Custom fetch function to use for making requests.
8383

8484
#### Defined in
8585

86-
[packages/core/src/runtime.ts:197](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L197)
86+
[packages/core/src/runtime.ts:202](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L202)
8787

8888
## Properties
8989

@@ -99,7 +99,7 @@ The ID of the agent
9999

100100
#### Defined in
101101

102-
[packages/core/src/runtime.ts:61](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L61)
102+
[packages/core/src/runtime.ts:62](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L62)
103103

104104
***
105105

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

116116
#### Defined in
117117

118-
[packages/core/src/runtime.ts:65](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L65)
118+
[packages/core/src/runtime.ts:66](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L66)
119119

120120
***
121121

@@ -131,7 +131,7 @@ The database adapter used for interacting with the database.
131131

132132
#### Defined in
133133

134-
[packages/core/src/runtime.ts:70](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L70)
134+
[packages/core/src/runtime.ts:71](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L71)
135135

136136
***
137137

@@ -147,7 +147,7 @@ Authentication token used for securing requests.
147147

148148
#### Defined in
149149

150-
[packages/core/src/runtime.ts:75](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L75)
150+
[packages/core/src/runtime.ts:76](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L76)
151151

152152
***
153153

@@ -163,7 +163,7 @@ Custom actions that the agent can perform.
163163

164164
#### Defined in
165165

166-
[packages/core/src/runtime.ts:80](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L80)
166+
[packages/core/src/runtime.ts:81](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L81)
167167

168168
***
169169

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

180180
#### Defined in
181181

182-
[packages/core/src/runtime.ts:85](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L85)
182+
[packages/core/src/runtime.ts:86](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L86)
183183

184184
***
185185

@@ -195,7 +195,7 @@ Context providers used to provide context for message generation.
195195

196196
#### Defined in
197197

198-
[packages/core/src/runtime.ts:90](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L90)
198+
[packages/core/src/runtime.ts:91](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L91)
199199

200200
***
201201

@@ -209,7 +209,7 @@ Context providers used to provide context for message generation.
209209

210210
#### Defined in
211211

212-
[packages/core/src/runtime.ts:92](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L92)
212+
[packages/core/src/runtime.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L93)
213213

214214
***
215215

@@ -225,7 +225,7 @@ The model to use for generateText.
225225

226226
#### Defined in
227227

228-
[packages/core/src/runtime.ts:97](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L97)
228+
[packages/core/src/runtime.ts:98](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L98)
229229

230230
***
231231

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

261261
#### Defined in
262262

263-
[packages/core/src/runtime.ts:103](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L103)
263+
[packages/core/src/runtime.ts:104](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L104)
264264

265265
***
266266

@@ -276,7 +276,7 @@ The character to use for the agent
276276

277277
#### Defined in
278278

279-
[packages/core/src/runtime.ts:108](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L108)
279+
[packages/core/src/runtime.ts:109](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L109)
280280

281281
***
282282

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

293293
#### Defined in
294294

295-
[packages/core/src/runtime.ts:113](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L113)
295+
[packages/core/src/runtime.ts:114](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L114)
296296

297297
***
298298

@@ -308,7 +308,7 @@ Store and recall descriptions of users based on conversations.
308308

309309
#### Defined in
310310

311-
[packages/core/src/runtime.ts:118](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L118)
311+
[packages/core/src/runtime.ts:119](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L119)
312312

313313
***
314314

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

325325
#### Defined in
326326

327-
[packages/core/src/runtime.ts:123](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L123)
327+
[packages/core/src/runtime.ts:124](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L124)
328328

329329
***
330330

@@ -334,9 +334,13 @@ Manage the creation and recall of static information (documents, historical game
334334
335335
Hold large documents that can be referenced
336336

337+
#### Implementation of
338+
339+
[`IAgentRuntime`](../interfaces/IAgentRuntime.md).[`documentsManager`](../interfaces/IAgentRuntime.md#documentsManager)
340+
337341
#### Defined in
338342

339-
[packages/core/src/runtime.ts:128](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L128)
343+
[packages/core/src/runtime.ts:129](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L129)
340344

341345
***
342346

@@ -346,9 +350,13 @@ Hold large documents that can be referenced
346350
347351
Searchable document fragments
348352

353+
#### Implementation of
354+
355+
[`IAgentRuntime`](../interfaces/IAgentRuntime.md).[`knowledgeManager`](../interfaces/IAgentRuntime.md#knowledgeManager)
356+
349357
#### Defined in
350358

351-
[packages/core/src/runtime.ts:133](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L133)
359+
[packages/core/src/runtime.ts:134](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L134)
352360

353361
***
354362

@@ -362,7 +370,7 @@ Searchable document fragments
362370

363371
#### Defined in
364372

365-
[packages/core/src/runtime.ts:135](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L135)
373+
[packages/core/src/runtime.ts:136](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L136)
366374

367375
***
368376

@@ -372,7 +380,7 @@ Searchable document fragments
372380
373381
#### Defined in
374382

375-
[packages/core/src/runtime.ts:136](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L136)
383+
[packages/core/src/runtime.ts:137](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L137)
376384

377385
***
378386

@@ -386,7 +394,7 @@ Searchable document fragments
386394

387395
#### Defined in
388396

389-
[packages/core/src/runtime.ts:137](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L137)
397+
[packages/core/src/runtime.ts:138](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L138)
390398

391399
## Methods
392400

@@ -408,7 +416,7 @@ Searchable document fragments
408416

409417
#### Defined in
410418

411-
[packages/core/src/runtime.ts:139](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L139)
419+
[packages/core/src/runtime.ts:140](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L140)
412420

413421
***
414422

@@ -430,7 +438,7 @@ Searchable document fragments
430438

431439
#### Defined in
432440

433-
[packages/core/src/runtime.ts:154](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L154)
441+
[packages/core/src/runtime.ts:155](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L155)
434442

435443
***
436444

@@ -456,7 +464,7 @@ Searchable document fragments
456464

457465
#### Defined in
458466

459-
[packages/core/src/runtime.ts:158](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L158)
467+
[packages/core/src/runtime.ts:159](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L159)
460468

461469
***
462470

@@ -478,7 +486,7 @@ Searchable document fragments
478486

479487
#### Defined in
480488

481-
[packages/core/src/runtime.ts:167](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L167)
489+
[packages/core/src/runtime.ts:168](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L168)
482490

483491
***
484492

@@ -496,7 +504,7 @@ Searchable document fragments
496504

497505
#### Defined in
498506

499-
[packages/core/src/runtime.ts:312](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L312)
507+
[packages/core/src/runtime.ts:359](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L359)
500508

501509
***
502510

@@ -518,7 +526,7 @@ Searchable document fragments
518526

519527
#### Defined in
520528

521-
[packages/core/src/runtime.ts:408](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L408)
529+
[packages/core/src/runtime.ts:423](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L423)
522530

523531
***
524532

@@ -540,7 +548,7 @@ The number of recent messages to be kept in memory.
540548

541549
#### Defined in
542550

543-
[packages/core/src/runtime.ts:430](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L430)
551+
[packages/core/src/runtime.ts:445](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L445)
544552

545553
***
546554

@@ -566,7 +574,7 @@ The action to register.
566574

567575
#### Defined in
568576

569-
[packages/core/src/runtime.ts:438](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L438)
577+
[packages/core/src/runtime.ts:453](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L453)
570578

571579
***
572580

@@ -588,7 +596,7 @@ The evaluator to register.
588596

589597
#### Defined in
590598

591-
[packages/core/src/runtime.ts:447](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L447)
599+
[packages/core/src/runtime.ts:462](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L462)
592600

593601
***
594602

@@ -610,7 +618,7 @@ The context provider to register.
610618

611619
#### Defined in
612620

613-
[packages/core/src/runtime.ts:455](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L455)
621+
[packages/core/src/runtime.ts:470](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L470)
614622

615623
***
616624

@@ -642,7 +650,7 @@ The message to process.
642650

643651
#### Defined in
644652

645-
[packages/core/src/runtime.ts:464](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L464)
653+
[packages/core/src/runtime.ts:479](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L479)
646654

647655
***
648656

@@ -678,7 +686,7 @@ The results of the evaluation.
678686

679687
#### Defined in
680688

681-
[packages/core/src/runtime.ts:537](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L537)
689+
[packages/core/src/runtime.ts:556](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L556)
682690

683691
***
684692

@@ -710,7 +718,7 @@ An error if the participant cannot be added.
710718

711719
#### Defined in
712720

713-
[packages/core/src/runtime.ts:607](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L607)
721+
[packages/core/src/runtime.ts:626](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L626)
714722

715723
***
716724

@@ -746,7 +754,7 @@ The user name to ensure the existence of.
746754

747755
#### Defined in
748756

749-
[packages/core/src/runtime.ts:623](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L623)
757+
[packages/core/src/runtime.ts:642](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L642)
750758

751759
***
752760

@@ -770,7 +778,7 @@ The user name to ensure the existence of.
770778

771779
#### Defined in
772780

773-
[packages/core/src/runtime.ts:643](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L643)
781+
[packages/core/src/runtime.ts:662](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L662)
774782

775783
***
776784

@@ -800,7 +808,7 @@ The user name to ensure the existence of.
800808

801809
#### Defined in
802810

803-
[packages/core/src/runtime.ts:660](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L660)
811+
[packages/core/src/runtime.ts:679](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L679)
804812

805813
***
806814

@@ -831,7 +839,7 @@ An error if the room cannot be created.
831839

832840
#### Defined in
833841

834-
[packages/core/src/runtime.ts:696](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L696)
842+
[packages/core/src/runtime.ts:715](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L715)
835843

836844
***
837845

@@ -861,7 +869,7 @@ The state of the agent.
861869

862870
#### Defined in
863871

864-
[packages/core/src/runtime.ts:709](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L709)
872+
[packages/core/src/runtime.ts:728](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L728)
865873

866874
***
867875

@@ -883,4 +891,4 @@ The state of the agent.
883891

884892
#### Defined in
885893

886-
[packages/core/src/runtime.ts:1181](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1181)
894+
[packages/core/src/runtime.ts:1173](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1173)

docs/api/classes/CacheManager.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[@ai16z/eliza v0.1.3](../index.md) / CacheManager
1+
[@ai16z/eliza v0.1.4-alpha.3](../index.md) / CacheManager
22

33
# Class: CacheManager\<CacheAdapter\>
44

0 commit comments

Comments
 (0)