Skip to content

Commit

Permalink
chore: changes to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shakkernerd committed Nov 30, 2024
1 parent 232fcf2 commit fa95f2c
Show file tree
Hide file tree
Showing 16 changed files with 63 additions and 55 deletions.
30 changes: 15 additions & 15 deletions docs/api/classes/AgentRuntime.md
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ Searchable document fragments

#### Defined in

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

***

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

#### Defined in

[packages/core/src/runtime.ts:436](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L436)
[packages/core/src/runtime.ts:439](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L439)

***

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

#### Defined in

[packages/core/src/runtime.ts:458](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L458)
[packages/core/src/runtime.ts:461](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L461)

***

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

#### Defined in

[packages/core/src/runtime.ts:466](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L466)
[packages/core/src/runtime.ts:469](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L469)

***

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

#### Defined in

[packages/core/src/runtime.ts:475](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L475)
[packages/core/src/runtime.ts:478](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L478)

***

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

#### Defined in

[packages/core/src/runtime.ts:483](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L483)
[packages/core/src/runtime.ts:486](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L486)

***

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

#### Defined in

[packages/core/src/runtime.ts:492](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L492)
[packages/core/src/runtime.ts:495](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L495)

***

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

#### Defined in

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

***

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

#### Defined in

[packages/core/src/runtime.ts:639](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L639)
[packages/core/src/runtime.ts:642](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L642)

***

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

#### 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:658](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L658)

***

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

#### Defined in

[packages/core/src/runtime.ts:675](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L675)
[packages/core/src/runtime.ts:678](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L678)

***

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

#### Defined in

[packages/core/src/runtime.ts:692](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L692)
[packages/core/src/runtime.ts:695](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L695)

***

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

#### Defined in

[packages/core/src/runtime.ts:728](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L728)
[packages/core/src/runtime.ts:731](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L731)

***

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

#### Defined in

[packages/core/src/runtime.ts:741](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L741)
[packages/core/src/runtime.ts:744](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L744)

***

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

#### Defined in

[packages/core/src/runtime.ts:1187](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1187)
[packages/core/src/runtime.ts:1190](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L1190)
2 changes: 1 addition & 1 deletion docs/api/functions/configureSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ Object containing environment variables

## Defined in

[packages/core/src/settings.ts:53](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L53)
[packages/core/src/settings.ts:69](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L69)
12 changes: 8 additions & 4 deletions docs/api/functions/embed.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

> **embed**(`runtime`, `input`): `Promise`\<`number`[]\>
Generate embeddings for input text using configured model provider
Gets embeddings from a remote API endpoint. Falls back to local BGE/384

## Parameters

**runtime**: [`IAgentRuntime`](../interfaces/IAgentRuntime.md)

The agent runtime containing model configuration
The agent runtime context

**input**: `string`

Expand All @@ -20,8 +20,12 @@ The text to generate embeddings for

`Promise`\<`number`[]\>

Array of embedding numbers
Array of embedding values

## Throws

If the API request fails

## Defined in

[packages/core/src/embedding.ts:103](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L103)
[packages/core/src/embedding.ts:138](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L138)
2 changes: 1 addition & 1 deletion docs/api/functions/findNearestEnvFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Path to the nearest .env file or null if not found

## Defined in

[packages/core/src/settings.ts:27](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L27)
[packages/core/src/settings.ts:43](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L43)
27 changes: 27 additions & 0 deletions docs/api/functions/getEmbeddingConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[@ai16z/eliza v0.1.4-alpha.3](../index.md) / getEmbeddingConfig

# Function: getEmbeddingConfig()

> **getEmbeddingConfig**(): `object`
Add the embedding configuration

## Returns

`object`

### dimensions

> **dimensions**: `number`
### model

> **model**: `string`
### provider

> **provider**: `string`
## Defined in

[packages/core/src/embedding.ts:18](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L18)
2 changes: 1 addition & 1 deletion docs/api/functions/getEmbeddingType.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@

## Defined in

[packages/core/src/embedding.ts:68](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L68)
[packages/core/src/embedding.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L93)
8 changes: 2 additions & 6 deletions docs/api/functions/getEmbeddingZeroVector.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,12 @@

# Function: getEmbeddingZeroVector()

> **getEmbeddingZeroVector**(`runtime`): `number`[]
## Parameters

**runtime**: [`IAgentRuntime`](../interfaces/IAgentRuntime.md)
> **getEmbeddingZeroVector**(): `number`[]
## Returns

`number`[]

## Defined in

[packages/core/src/embedding.ts:86](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L86)
[packages/core/src/embedding.ts:111](https://github.com/ai16z/eliza/blob/main/packages/core/src/embedding.ts#L111)
2 changes: 1 addition & 1 deletion docs/api/functions/getEnvVariable.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ The environment variable value or default value

## Defined in

[packages/core/src/settings.ts:87](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L87)
[packages/core/src/settings.ts:103](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L103)
2 changes: 1 addition & 1 deletion docs/api/functions/hasEnvVariable.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ True if the environment variable exists

## Defined in

[packages/core/src/settings.ts:102](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L102)
[packages/core/src/settings.ts:118](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L118)
2 changes: 1 addition & 1 deletion docs/api/functions/loadEnvConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ If no .env file is found in Node.js environment

## Defined in

[packages/core/src/settings.ts:63](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L63)
[packages/core/src/settings.ts:79](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L79)
19 changes: 0 additions & 19 deletions docs/api/functions/retrieveCachedEmbedding.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,10 @@
- [formatActions](functions/formatActions.md)
- [composeContext](functions/composeContext.md)
- [addHeader](functions/addHeader.md)
- [getEmbeddingConfig](functions/getEmbeddingConfig.md)
- [getEmbeddingType](functions/getEmbeddingType.md)
- [getEmbeddingZeroVector](functions/getEmbeddingZeroVector.md)
- [embed](functions/embed.md)
- [retrieveCachedEmbedding](functions/retrieveCachedEmbedding.md)
- [validateEnv](functions/validateEnv.md)
- [validateCharacterConfig](functions/validateCharacterConfig.md)
- [formatEvaluatorNames](functions/formatEvaluatorNames.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/api/typedoc-sidebar.cjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/variables/elizaLogger.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
## Defined in

[packages/core/src/logger.ts:254](https://github.com/ai16z/eliza/blob/main/packages/core/src/logger.ts#L254)
[packages/core/src/logger.ts:266](https://github.com/ai16z/eliza/blob/main/packages/core/src/logger.ts#L266)
2 changes: 1 addition & 1 deletion docs/api/variables/knowledge.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@

## Defined in

[packages/core/src/knowledge.ts:117](https://github.com/ai16z/eliza/blob/main/packages/core/src/knowledge.ts#L117)
[packages/core/src/knowledge.ts:150](https://github.com/ai16z/eliza/blob/main/packages/core/src/knowledge.ts#L150)
2 changes: 1 addition & 1 deletion docs/api/variables/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Initialize settings based on environment

## Defined in

[packages/core/src/settings.ts:110](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L110)
[packages/core/src/settings.ts:126](https://github.com/ai16z/eliza/blob/main/packages/core/src/settings.ts#L126)

0 comments on commit fa95f2c

Please sign in to comment.