Skip to main content

@okcashpro/okai v0.1.7-alpha.1 / State

Interface: State

Represents the current state/context of a conversation

Indexable​

[key: string]: unknown

Properties​

userId?​

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

ID of user who sent current message

Defined in​

packages/core/src/types.ts:248

agentId?​

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

ID of agent in conversation

Defined in​

packages/core/src/types.ts:251

bio​

bio: string

Agent's biography

Defined in​

packages/core/src/types.ts:254

lore​

lore: string

Agent's background lore

Defined in​

packages/core/src/types.ts:257

messageDirections​

messageDirections: string

Message handling directions

Defined in​

packages/core/src/types.ts:260

postDirections​

postDirections: string

Post handling directions

Defined in​

packages/core/src/types.ts:263

roomId​

roomId: `${string}-${string}-${string}-${string}-${string}`

Current room/conversation ID

Defined in​

packages/core/src/types.ts:266

agentName?​

optional agentName: string

Optional agent name

Defined in​

packages/core/src/types.ts:269

senderName?​

optional senderName: string

Optional message sender name

Defined in​

packages/core/src/types.ts:272

actors​

actors: string

String representation of conversation actors

Defined in​

packages/core/src/types.ts:275

actorsData?​

optional actorsData: Actor[]

Optional array of actor objects

Defined in​

packages/core/src/types.ts:278

goals?​

optional goals: string

Optional string representation of goals

Defined in​

packages/core/src/types.ts:281

goalsData?​

optional goalsData: Goal[]

Optional array of goal objects

Defined in​

packages/core/src/types.ts:284

recentMessages​

recentMessages: string

Recent message history as string

Defined in​

packages/core/src/types.ts:287

recentMessagesData​

recentMessagesData: Memory[]

Recent message objects

Defined in​

packages/core/src/types.ts:290

actionNames?​

optional actionNames: string

Optional valid action names

Defined in​

packages/core/src/types.ts:293

actions?​

optional actions: string

Optional action descriptions

Defined in​

packages/core/src/types.ts:296

actionsData?​

optional actionsData: Action[]

Optional action objects

Defined in​

packages/core/src/types.ts:299

actionExamples?​

optional actionExamples: string

Optional action examples

Defined in​

packages/core/src/types.ts:302

providers?​

optional providers: string

Optional provider descriptions

Defined in​

packages/core/src/types.ts:305

responseData?​

optional responseData: Content

Optional response content

Defined in​

packages/core/src/types.ts:308

recentInteractionsData?​

optional recentInteractionsData: Memory[]

Optional recent interaction objects

Defined in​

packages/core/src/types.ts:311

recentInteractions?​

optional recentInteractions: string

Optional recent interactions string

Defined in​

packages/core/src/types.ts:314

formattedConversation?​

optional formattedConversation: string

Optional formatted conversation

Defined in​

packages/core/src/types.ts:317

knowledge?​

optional knowledge: string

Optional formatted knowledge

Defined in​

packages/core/src/types.ts:320

knowledgeData?​

optional knowledgeData: KnowledgeItem[]

Optional knowledge data

Defined in​

packages/core/src/types.ts:322