Skip to main content

Interface: IAgentRuntime

Properties

actions

actions: Action[]

Defined in

packages/core/src/types.ts:527


agentId

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

Defined in

packages/core/src/types.ts:520


character

character: Character

Defined in

packages/core/src/types.ts:525


databaseAdapter

databaseAdapter: IDatabaseAdapter

Defined in

packages/core/src/types.ts:522


descriptionManager

descriptionManager: IMemoryManager

Defined in

packages/core/src/types.ts:531


evaluators

evaluators: Evaluator[]

Defined in

packages/core/src/types.ts:528


loreManager

loreManager: IMemoryManager

Defined in

packages/core/src/types.ts:532


messageManager

messageManager: IMemoryManager

Defined in

packages/core/src/types.ts:530


modelProvider

modelProvider: ModelProviderName

Defined in

packages/core/src/types.ts:524


providers

providers: Provider[]

Defined in

packages/core/src/types.ts:526


serverUrl

serverUrl: string

Defined in

packages/core/src/types.ts:521


services

services: Map<ServiceType, Service>

Defined in

packages/core/src/types.ts:534


token

token: string

Defined in

packages/core/src/types.ts:523

Methods

composeState()

composeState(message, additionalKeys?): Promise<State>

Parameters

message: Memory

additionalKeys?

Returns

Promise<State>

Defined in

packages/core/src/types.ts:575


ensureConnection()

ensureConnection(userId, roomId, userName?, userScreenName?, source?): Promise<void>

Parameters

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

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

userName?: string

userScreenName?: string

source?: string

Returns

Promise<void>

Defined in

packages/core/src/types.ts:566


ensureParticipantExists()

ensureParticipantExists(userId, roomId): Promise<void>

Parameters

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

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

Returns

Promise<void>

Defined in

packages/core/src/types.ts:558


ensureParticipantInRoom()

ensureParticipantInRoom(userId, roomId): Promise<void>

Parameters

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

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

Returns

Promise<void>

Defined in

packages/core/src/types.ts:573


ensureRoomExists()

ensureRoomExists(roomId): Promise<void>

Parameters

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

Returns

Promise<void>

Defined in

packages/core/src/types.ts:574


ensureUserExists()

ensureUserExists(userId, userName, name, source): Promise<void>

Parameters

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

userName: string

name: string

source: string

Returns

Promise<void>

Defined in

packages/core/src/types.ts:559


evaluate()

evaluate(message, state?, didRespond?): Promise<string[]>

Parameters

message: Memory

state?: State

didRespond?: boolean

Returns

Promise<string[]>

Defined in

packages/core/src/types.ts:553


getConversationLength()

getConversationLength(): number

Returns

number

Defined in

packages/core/src/types.ts:546


getMemoryManager()

getMemoryManager(name): IMemoryManager

Parameters

name: string

Returns

IMemoryManager

Defined in

packages/core/src/types.ts:537


getService()

getService(service): typeof Service

Parameters

service: string

Returns

typeof Service

Defined in

packages/core/src/types.ts:539


getSetting()

getSetting(key): string

Parameters

key: string

Returns

string

Defined in

packages/core/src/types.ts:543


processActions()

processActions(message, responses, state?, callback?): Promise<void>

Parameters

message: Memory

responses: Memory[]

state?: State

callback?: HandlerCallback

Returns

Promise<void>

Defined in

packages/core/src/types.ts:547


registerAction()

registerAction(action): void

Parameters

action: Action

Returns

void

Defined in

packages/core/src/types.ts:565


registerMemoryManager()

registerMemoryManager(manager): void

Parameters

manager: IMemoryManager

Returns

void

Defined in

packages/core/src/types.ts:535


registerService()

registerService(service): void

Parameters

service: Service

Returns

void

Defined in

packages/core/src/types.ts:541


updateRecentMessageState()

updateRecentMessageState(state): Promise<State>

Parameters

state: State

Returns

Promise<State>

Defined in

packages/core/src/types.ts:579