elizaos--eliza
426e9eeabd
Voice Workbench / headless workbench (mocked backends) (push) Has been cancelled
Voice Workbench / real acoustic lane (nightly, provisioned only) (push) Has been cancelled
ci / test (push) Has been cancelled
ci / lint-and-format (push) Has been cancelled
ci / build (push) Has been cancelled
ci / dev-startup (push) Has been cancelled
gitleaks / gitleaks (push) Has been cancelled
Markdown Links / Relative Markdown Links (push) Has been cancelled
Quality (Extended) / Homepage Build (PR smoke) (push) Has been cancelled
Quality (Extended) / Comment-only diff guard (push) Has been cancelled
Quality (Extended) / Format + Type Safety Ratchet (push) Has been cancelled
Quality (Extended) / Develop Gate (secret scan + UI determinism) (push) Has been cancelled
Quality (Extended) / Develop Gate (lint) (push) Has been cancelled
Chat shell gestures / Chat shell gesture + parity e2e (push) Has been cancelled
Cloud Gateway Discord / Test (push) Has been cancelled
Benchmark Bridge Tests / benchmark (bunx @biomejs/biome check packages/lifeops-bench/src, benchmark-lint) (push) Has been cancelled
Benchmark Bridge Tests / benchmark (bunx vitest run --config packages/lifeops-bench/vitest.config.ts --root packages/lifeops-bench --passWithNoTests, benchmark-tests) (push) Has been cancelled
Build Agent Image / build-and-push (push) Has been cancelled
Dev Smoke / bun run dev onboarding chat (push) Has been cancelled
Dev Smoke / Vite HMR dependency-level smoke (push) Has been cancelled
Electrobun Submodule Guard / electrobun gitlink is fetchable (push) Has been cancelled
Publish @elizaos/example-code / check_npm (push) Has been cancelled
Publish @elizaos/example-code / publish_npm (push) Has been cancelled
Publish @elizaos/plugin-elizacloud / verify_version (push) Has been cancelled
Publish @elizaos/plugin-elizacloud / publish_npm (push) Has been cancelled
Sandbox Live Smoke / Sandbox live smoke (push) Has been cancelled
Snap Build & Test / Build Snap (amd64) (push) Has been cancelled
Snap Build & Test / Build Snap (arm64) (push) Has been cancelled
Test Packaging / elizaos CLI global-install smoke (node + bun) (push) Has been cancelled
Cloud Gateway Webhook / Test (push) Has been cancelled
Cloud Tests / lint-and-types (push) Has been cancelled
Cloud Tests / unit-tests (push) Has been cancelled
Cloud Tests / integration-tests (push) Has been cancelled
Cloud Tests / e2e-tests (push) Has been cancelled
CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
Deploy Apps Worker (Product 2) / Determine environment (push) Has been cancelled
Deploy Apps Worker (Product 2) / Deploy apps worker to apps-control host (${{ needs.determine-env.outputs.environment }}) (push) Has been cancelled
Deploy Eliza Provisioning Worker / Determine environment (push) Has been cancelled
Deploy Eliza Provisioning Worker / Deploy worker to Hetzner host (${{ needs.determine-env.outputs.environment }} @ ${{ needs.determine-env.outputs.deployment_sha }}) (push) Has been cancelled
Dev Smoke / Classify changed paths (push) Has been cancelled
supply-chain / sbom (push) Has been cancelled
supply-chain / vulnerability-scan (push) Has been cancelled
Build, Push & Deploy to Phala Cloud / build-and-push (push) Has been cancelled
Test Packaging / Validate Packaging Configs (push) Has been cancelled
Test Packaging / Build & Test PyPI Package (push) Has been cancelled
Test Packaging / PyPI on Python ${{ matrix.python }} (push) Has been cancelled
Test Packaging / Pack & Test JS Tarballs (push) Has been cancelled
UI Fixture E2E / ui-fixture-e2e (push) Has been cancelled
UI Fixture E2E / fixture-e2e (push) Has been cancelled
UI Story Gate / story-gate (push) Has been cancelled
vault-ci / test (macos-latest) (push) Has been cancelled
vault-ci / test (ubuntu-latest) (push) Has been cancelled
vault-ci / test (windows-latest) (push) Has been cancelled
vault-ci / app-core wiring tests (push) Has been cancelled
verify-patches / verify patches/CHECKSUMS.sha256 (push) Has been cancelled
Voice Benchmark Smoke / voice-emotion fixture smoke (push) Has been cancelled
Voice Benchmark Smoke / voiceagentbench fixture smoke (push) Has been cancelled
Voice Benchmark Smoke / voicebench-quality unit smoke (push) Has been cancelled
Voice Benchmark Smoke / voicebench TypeScript unit (no audio) (push) Has been cancelled
Voice Benchmark Smoke / voice bench smoke summary (push) Has been cancelled
Windows CI / windows ([bun run --cwd packages/app-core test bun run --cwd packages/elizaos test bun run --cwd packages/cloud/shared test], app-and-cli) (push) Has been cancelled
Windows CI / windows ([bun run --cwd packages/scenario-runner test bun run --cwd packages/vault test bun run --cwd packages/security test bun run --cwd plugins/plugin-coding-tools test], framework-packages) (push) Has been cancelled
Windows CI / windows ([bun run --cwd plugins/plugin-elizacloud test bun run --cwd plugins/plugin-discord test bun run --cwd plugins/plugin-anthropic test bun run --cwd plugins/plugin-openai test bun run --cwd plugins/plugin-app-control test bun run --cwd plugins/pl… (push) Has been cancelled
Windows CI / windows ([node packages/scripts/run-turbo.mjs run build --filter=@elizaos/core --filter=@elizaos/shared --filter=@elizaos/agent --concurrency=4 node packages/scripts/run-bash-linux-only.mjs scripts/verify-riscv64-buildpaths.sh node packages/scripts/run… (push) Has been cancelled
Windows CI / windows ([node packages/scripts/run-turbo.mjs run typecheck --filter=@elizaos/core --filter=@elizaos/shared --filter=@elizaos/cloud-shared --concurrency=4 bun run --cwd packages/core test bun run --cwd packages/shared test], core-runtime, 75) (push) Has been cancelled
320 行
7.2 KiB
Plaintext
320 行
7.2 KiB
Plaintext
---
|
|
title: Character JSON
|
|
description: Complete reference for elizaOS character JSON configuration. Define agent personality, behavior, and settings.
|
|
---
|
|
|
|
# Character JSON
|
|
|
|
Define your agent's personality and behavior with the character JSON format.
|
|
|
|
## Overview
|
|
|
|
The character JSON is the core configuration for an elizaOS agent. It defines:
|
|
|
|
- **Identity**: Name, bio, and background
|
|
- **Personality**: Communication style and behavior
|
|
- **Capabilities**: Model settings and plugins
|
|
- **Knowledge**: Topics and expertise areas
|
|
|
|
## Complete Schema
|
|
|
|
```json
|
|
{
|
|
"name": "Agent Name",
|
|
"description": "Brief description",
|
|
"bio": ["First bio statement", "Second bio statement"],
|
|
"lore": ["Background story element", "Another lore element"],
|
|
"style": {
|
|
"all": ["Global style instruction"],
|
|
"chat": ["Chat-specific style"],
|
|
"post": ["Social media style"]
|
|
},
|
|
"topics": ["topic1", "topic2"],
|
|
"adjectives": ["helpful", "friendly"],
|
|
"modelProvider": "openai",
|
|
"settings": {
|
|
"model": "gpt-4o",
|
|
"temperature": 0.7,
|
|
"maxTokens": 4096
|
|
},
|
|
"plugins": [],
|
|
"clients": []
|
|
}
|
|
```
|
|
|
|
## Field Reference
|
|
|
|
### Core Identity
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------- | -------- | -------- | --------------------- |
|
|
| `name` | string | ✓ | Agent display name |
|
|
| `description` | string | | Brief description |
|
|
| `bio` | string[] | ✓ | Background statements |
|
|
| `lore` | string[] | | Backstory elements |
|
|
|
|
### Personality
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------ | -------- | -------- | ---------------------- |
|
|
| `style.all` | string[] | | Global style rules |
|
|
| `style.chat` | string[] | | Chat interaction style |
|
|
| `style.post` | string[] | | Social media style |
|
|
| `topics` | string[] | | Expertise areas |
|
|
| `adjectives` | string[] | | Personality traits |
|
|
|
|
### Model Settings
|
|
|
|
| Field | Type | Required | Description |
|
|
| ---------------------- | ------ | -------- | ------------------- |
|
|
| `modelProvider` | string | ✓ | AI provider |
|
|
| `settings.model` | string | | Specific model |
|
|
| `settings.temperature` | number | | Creativity (0-2) |
|
|
| `settings.maxTokens` | number | | Max response length |
|
|
|
|
## Bio Guidelines
|
|
|
|
The bio array defines your agent's background:
|
|
|
|
```json
|
|
{
|
|
"bio": [
|
|
"Expert in machine learning and data science",
|
|
"10 years of experience in AI research",
|
|
"Published author and conference speaker",
|
|
"Passionate about explaining complex topics simply"
|
|
]
|
|
}
|
|
```
|
|
|
|
**Best Practices:**
|
|
|
|
- 3-5 statements
|
|
- Mix expertise and personality
|
|
- Be specific about capabilities
|
|
- Include relevant experience
|
|
|
|
## Style Instructions
|
|
|
|
### Global Style (`style.all`)
|
|
|
|
Applies to all interactions:
|
|
|
|
```json
|
|
{
|
|
"style": {
|
|
"all": [
|
|
"Be professional yet approachable",
|
|
"Use clear, concise language",
|
|
"Cite sources when making claims",
|
|
"Ask clarifying questions when needed"
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
### Chat Style (`style.chat`)
|
|
|
|
Specific to chat conversations:
|
|
|
|
```json
|
|
{
|
|
"style": {
|
|
"chat": [
|
|
"Keep responses focused and concise",
|
|
"Use bullet points for complex topics",
|
|
"Provide examples when helpful",
|
|
"End with a question to continue the conversation"
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
### Post Style (`style.post`)
|
|
|
|
For social media interactions:
|
|
|
|
```json
|
|
{
|
|
"style": {
|
|
"post": [
|
|
"Keep posts under 280 characters",
|
|
"Use relevant hashtags",
|
|
"Be engaging and thought-provoking",
|
|
"Include a call to action"
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
## Model Providers
|
|
|
|
### Available Providers
|
|
|
|
| Provider | Models |
|
|
| ----------- | -------------------------------- |
|
|
| `openai` | OpenAI-compatible model ids from the current catalog |
|
|
| `anthropic` | claude-sonnet-4-6, claude-opus-4-7 |
|
|
| `google` | gemini-1.5-pro, gemini-1.5-flash |
|
|
|
|
### Provider Settings
|
|
|
|
```json
|
|
{
|
|
"modelProvider": "openai",
|
|
"settings": {
|
|
"model": "gpt-4o",
|
|
"temperature": 0.7,
|
|
"maxTokens": 4096,
|
|
"topP": 0.9,
|
|
"frequencyPenalty": 0,
|
|
"presencePenalty": 0
|
|
}
|
|
}
|
|
```
|
|
|
|
## Advanced Settings
|
|
|
|
### Knowledge Base
|
|
|
|
Connect documents:
|
|
|
|
```json
|
|
{
|
|
"settings": {
|
|
"knowledge": {
|
|
"enabled": true,
|
|
"documentIds": ["doc_abc123"],
|
|
"queryLimit": 5,
|
|
"minScore": 0.7
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### MCP Tools
|
|
|
|
Enable MCP servers:
|
|
|
|
```json
|
|
{
|
|
"settings": {
|
|
"mcp": {
|
|
"enabled": true,
|
|
"servers": [{ "id": "weather", "url": "https://mcp.eliza.ai/weather" }]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Voice
|
|
|
|
Configure voice synthesis:
|
|
|
|
```json
|
|
{
|
|
"settings": {
|
|
"voice": {
|
|
"provider": "elevenlabs",
|
|
"voiceId": "voice_abc123",
|
|
"model": "eleven_multilingual_v2"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Templates
|
|
|
|
### Customer Support
|
|
|
|
```json
|
|
{
|
|
"name": "Support Assistant",
|
|
"bio": [
|
|
"Dedicated customer support specialist",
|
|
"Expert in troubleshooting and problem-solving",
|
|
"Patient and thorough in explanations"
|
|
],
|
|
"style": {
|
|
"all": [
|
|
"Always be polite and empathetic",
|
|
"Acknowledge the customer's issue",
|
|
"Provide step-by-step solutions"
|
|
],
|
|
"chat": [
|
|
"Ask for specifics when needed",
|
|
"Confirm understanding before solving",
|
|
"Follow up on resolution"
|
|
]
|
|
},
|
|
"topics": ["support", "troubleshooting", "product help"],
|
|
"modelProvider": "openai",
|
|
"settings": {
|
|
"model": "gpt-4o",
|
|
"temperature": 0.5
|
|
}
|
|
}
|
|
```
|
|
|
|
### Research Assistant
|
|
|
|
```json
|
|
{
|
|
"name": "Research Assistant",
|
|
"bio": [
|
|
"Academic researcher with expertise in literature review",
|
|
"Skilled at synthesizing complex information",
|
|
"Trained on scientific methodology"
|
|
],
|
|
"style": {
|
|
"all": [
|
|
"Use academic language appropriately",
|
|
"Cite sources when possible",
|
|
"Be precise and thorough"
|
|
],
|
|
"chat": [
|
|
"Break down complex topics",
|
|
"Provide evidence for claims",
|
|
"Suggest further reading"
|
|
]
|
|
},
|
|
"topics": ["research", "analysis", "academic writing"],
|
|
"modelProvider": "anthropic",
|
|
"settings": {
|
|
"model": "claude-sonnet-4-6",
|
|
"temperature": 0.3
|
|
}
|
|
}
|
|
```
|
|
|
|
## Validation
|
|
|
|
The character JSON is validated on upload. Common errors:
|
|
|
|
| Error | Cause | Solution |
|
|
| --------------------- | --------------------- | ---------------------- |
|
|
| `name required` | Missing name field | Add name |
|
|
| `invalid provider` | Unknown modelProvider | Use supported provider |
|
|
| `invalid temperature` | Outside 0-2 range | Adjust temperature |
|
|
|
|
## Best Practices
|
|
|
|
- **Be Specific** — Detailed bios and styles produce more consistent agents
|
|
- **Test Thoroughly** — Try various scenarios before deploying
|
|
- **Iterate** — Refine based on actual conversations
|
|
- **Version Control** — Track changes to your character files in git
|
|
|
|
## Next Steps
|
|
|
|
<CardGroup>
|
|
<CardGroup.Card title="Agent Creator" href="/cloud/agent-creator">
|
|
Build agents visually
|
|
</CardGroup.Card>
|
|
<CardGroup.Card title="AI Agents" href="/cloud/agents">
|
|
Deploy your agent
|
|
</CardGroup.Card>
|
|
<CardGroup.Card title="Knowledge Base" href="/cloud/documents">
|
|
Add documents for RAG
|
|
</CardGroup.Card>
|
|
</CardGroup>
|