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

docs: characterfile.md docs outdated with latest eliza version #1042

Merged
merged 3 commits into from
Dec 13, 2024
Merged

docs: characterfile.md docs outdated with latest eliza version #1042

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
376e5a2
Update README.md
lalalune Dec 13, 2024
23a0c30
Merge pull request #1038 from ai16z/lalalune-patch-1
monilpat Dec 13, 2024
7f30fcf
fix: characterfile.md docs outdated with latest eliza version
tqdpham96 Dec 13, 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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading