Skip to main content

@ai16z/eliza v0.1.4-alpha.3 / Character

Type Alias: Character

Character: object

Configuration for an agent character

Type declaration​

id?​

optional id: UUID

Optional unique identifier

name​

name: string

Character name

username?​

optional username: string

Optional username

system?​

optional system: string

Optional system prompt

modelProvider​

modelProvider: ModelProviderName

Model provider to use

imageModelProvider?​

optional imageModelProvider: ModelProviderName

Image model provider to use, if different from modelProvider

modelEndpointOverride?​

optional modelEndpointOverride: string

Optional model endpoint override

templates?​

optional templates: object

Optional prompt templates

templates.goalsTemplate?​

optional goalsTemplate: string

templates.factsTemplate?​

optional factsTemplate: string

templates.messageHandlerTemplate?​

optional messageHandlerTemplate: string

templates.shouldRespondTemplate?​

optional shouldRespondTemplate: string

templates.continueMessageHandlerTemplate?​

optional continueMessageHandlerTemplate: string

templates.evaluationTemplate?​

optional evaluationTemplate: string

templates.twitterSearchTemplate?​

optional twitterSearchTemplate: string

templates.twitterPostTemplate?​

optional twitterPostTemplate: string

templates.twitterMessageHandlerTemplate?​

optional twitterMessageHandlerTemplate: string

templates.twitterShouldRespondTemplate?​

optional twitterShouldRespondTemplate: string

templates.farcasterPostTemplate?​

optional farcasterPostTemplate: string

templates.farcasterMessageHandlerTemplate?​

optional farcasterMessageHandlerTemplate: string

templates.farcasterShouldRespondTemplate?​

optional farcasterShouldRespondTemplate: string

templates.telegramMessageHandlerTemplate?​

optional telegramMessageHandlerTemplate: string

templates.telegramShouldRespondTemplate?​

optional telegramShouldRespondTemplate: string

templates.discordVoiceHandlerTemplate?​

optional discordVoiceHandlerTemplate: string

templates.discordShouldRespondTemplate?​

optional discordShouldRespondTemplate: string

templates.discordMessageHandlerTemplate?​

optional discordMessageHandlerTemplate: string

bio​

bio: string | string[]

Character biography

lore​

lore: string[]

Character background lore

messageExamples​

messageExamples: MessageExample[][]

Example messages

postExamples​

postExamples: string[]

Example posts

topics​

topics: string[]

Known topics

adjectives​

adjectives: string[]

Character traits

knowledge?​

optional knowledge: string[]

Optional knowledge base

clients​

clients: Clients[]

Supported client platforms

plugins​

plugins: Plugin[]

Available plugins

settings?​

optional settings: object

Optional configuration

settings.secrets?​

optional secrets: object

Index Signature​

[key: string]: string

settings.buttplug?​

optional buttplug: boolean

settings.voice?​

optional voice: object

settings.voice.model?​

optional model: string

settings.voice.url?​

optional url: string

settings.model?​

optional model: string

settings.embeddingModel?​

optional embeddingModel: string

settings.chains?​

optional chains: object

Index Signature​

[key: string]: any[]

settings.chains.evm?​

optional evm: any[]

settings.chains.solana?​

optional solana: any[]

clientConfig?​

optional clientConfig: object

Optional client-specific config

clientConfig.discord?​

optional discord: object

clientConfig.discord.shouldIgnoreBotMessages?​

optional shouldIgnoreBotMessages: boolean

clientConfig.discord.shouldIgnoreDirectMessages?​

optional shouldIgnoreDirectMessages: boolean

clientConfig.telegram?​

optional telegram: object

clientConfig.telegram.shouldIgnoreBotMessages?​

optional shouldIgnoreBotMessages: boolean

clientConfig.telegram.shouldIgnoreDirectMessages?​

optional shouldIgnoreDirectMessages: boolean

style​

style: object

Writing style guides

style.all​

all: string[]

style.chat​

chat: string[]

style.post​

post: string[]

twitterProfile?​

optional twitterProfile: object

Optional Twitter profile

twitterProfile.id​

id: string

twitterProfile.username​

username: string

twitterProfile.screenName​

screenName: string

twitterProfile.bio​

bio: string

twitterProfile.nicknames?​

optional nicknames: string[]

Defined in​

packages/core/src/types.ts:601