Skip to content

Commit

Permalink
Merge pull request #1042 from tqdpham96/main
Browse files Browse the repository at this point in the history
docs: characterfile.md docs outdated with latest eliza version
  • Loading branch information
odilitime authored Dec 13, 2024
2 parents 0af4cbe + 7f30fcf commit d8bfbcd
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
- 📦 Just works!

## Video Tutorials
[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)

## 🎯 Use Cases

- 🤖 Chatbots
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/core/characterfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ A `characterfile` implements the [Character](/api/type-aliases/character) type a
```json
{
"name": "trump",
"clients": ["DISCORD", "DIRECT"],
"clients": ["discord", "direct"],
"settings": {
"voice": { "model": "en_US-male-medium" }
},
Expand Down Expand Up @@ -92,11 +92,11 @@ The character's display name for identification and in conversations.

#### `modelProvider` (required)

Specifies the AI model provider. Supported options from [ModelProviderName](/api/enumerations/modelprovidername) include `ANTHROPIC`, `LLAMALOCAL`, `OPENAI`, and others.
Specifies the AI model provider. Supported options from [ModelProviderName](/api/enumerations/modelprovidername) include `anthropic`, `llama_local`, `openai`, and others.

#### `clients` (required)

Array of supported client types from [Clients](/api/enumerations/clients) e.g., `DISCORD`, `DIRECT`, `TWITTER`, `TELEGRAM`.
Array of supported client types from [Clients](/api/enumerations/clients) e.g., `discord`, `direct`, `twitter`, `telegram`, `farcaster`.

#### `bio`

Expand Down Expand Up @@ -261,8 +261,8 @@ Your response should not contain any questions. Brief, concise statements only.
```json
{
"name": "TechAI",
"modelProvider": "ANTHROPIC",
"clients": ["DISCORD", "DIRECT"],
"modelProvider": "anthropic",
"clients": ["discord", "direct"],
"bio": "AI researcher and educator focused on practical applications",
"lore": [
"Pioneer in open-source AI development",
Expand Down

0 comments on commit d8bfbcd

Please sign in to comment.