Skip to main content

@elizaos/core v1.0.12 / Character

Interface: Character

Configuration for an agent's character, defining its personality, knowledge, and capabilities. This is a central piece of an agent's definition, used by the AgentRuntime to initialize and operate the agent. It includes:

  • id: Optional unique identifier for the character.
  • name, username: Identifying names for the character.
  • system: A system prompt that guides the agent's overall behavior.
  • templates: A map of prompt templates for various situations (e.g., message generation, summarization).
  • bio: A textual biography or description of the character.
  • messageExamples, postExamples: Examples of how the character communicates.
  • topics, adjectives: Keywords describing the character's knowledge areas and traits.
  • knowledge: Paths to knowledge files or directories to be loaded into the agent's memory.
  • plugins: A list of plugin names to be loaded for this character.
  • settings, secrets: Configuration key-value pairs, with secrets being handled more securely.
  • style: Guidelines for the character's writing style in different contexts (chat, post).

Extended by​

Properties​

id?​

optional id: `${string}-${string}-${string}-${string}-${string}`

Optional unique identifier

Defined in​

packages/core/src/types/agent.ts:38

name​

name: string

Character name

Defined in​

packages/core/src/types/agent.ts:41

username?​

optional username: string

Optional username

Defined in​

packages/core/src/types/agent.ts:44

system?​

optional system: string

Optional system prompt

Defined in​

packages/core/src/types/agent.ts:47

templates?​

optional templates: object

Optional prompt templates

Index Signature​

[key: string]: TemplateType

Defined in​

packages/core/src/types/agent.ts:50

bio​

bio: string | string[]

Character biography

Defined in​

packages/core/src/types/agent.ts:55

messageExamples?​

optional messageExamples: MessageExample[][]

Example messages

Defined in​

packages/core/src/types/agent.ts:58

postExamples?​

optional postExamples: string[]

Example posts

Defined in​

packages/core/src/types/agent.ts:61

topics?​

optional topics: string[]

Known topics

Defined in​

packages/core/src/types/agent.ts:64

adjectives?​

optional adjectives: string[]

Character traits

Defined in​

packages/core/src/types/agent.ts:67

knowledge?​

optional knowledge: (string | DirectoryItem | object)[]

Optional knowledge base

Defined in​

packages/core/src/types/agent.ts:70

plugins?​

optional plugins: string[]

Available plugins

Defined in​

packages/core/src/types/agent.ts:73

settings?​

optional settings: object

Optional configuration

Index Signature​

[key: string]: string | number | boolean | Record<string, any>

Defined in​

packages/core/src/types/agent.ts:76

secrets?​

optional secrets: object

Optional secrets

Index Signature​

[key: string]: string | number | boolean

Defined in​

packages/core/src/types/agent.ts:81

style?​

optional style: object

Writing style guides

all?​

optional all: string[]

chat?​

optional chat: string[]

post?​

optional post: string[]

Defined in​

packages/core/src/types/agent.ts:86