IAgentRuntime.md

@ai16z/eliza v0.1.5-alpha.3 / IAgentRuntime

Interface: IAgentRuntime

Properties

agentId

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

Properties

Defined in

packages/core/src/types.ts:978

---

serverUrl

serverUrl: string

Defined in

packages/core/src/types.ts:979

---

databaseAdapter

databaseAdapter: IDatabaseAdapter

Defined in

packages/core/src/types.ts:980

---

token

token: string

Defined in

packages/core/src/types.ts:981

---

modelProvider

modelProvider: ModelProviderName

Defined in

packages/core/src/types.ts:982

---

imageModelProvider

imageModelProvider: ModelProviderName

Defined in

packages/core/src/types.ts:983

---

character

character: Character

Defined in

packages/core/src/types.ts:984

---

providers

providers: Provider[]

Defined in

packages/core/src/types.ts:985

---

actions

actions: Action[]

Defined in

packages/core/src/types.ts:986

---

evaluators

evaluators: Evaluator[]

Defined in

packages/core/src/types.ts:987

---

plugins

plugins: Plugin[]

Defined in

packages/core/src/types.ts:988

---

messageManager

messageManager: IMemoryManager

Defined in

packages/core/src/types.ts:990

---

descriptionManager

descriptionManager: IMemoryManager

Defined in

packages/core/src/types.ts:991

---

documentsManager

documentsManager: IMemoryManager

Defined in

packages/core/src/types.ts:992

---

knowledgeManager

knowledgeManager: IMemoryManager

Defined in

packages/core/src/types.ts:993

---

loreManager

loreManager: IMemoryManager

Defined in

packages/core/src/types.ts:994

---

cacheManager

cacheManager: ICacheManager

Defined in

packages/core/src/types.ts:996

---

services

services: Map<ServiceType, Service>

Defined in

packages/core/src/types.ts:998

Methods

initialize()

initialize(): Promise<void>

Returns

Promise<void>

Defined in

packages/core/src/types.ts:1000

---

registerMemoryManager()

registerMemoryManager(manager): void

Parameters

• manager: IMemoryManager

Returns

void

Defined in

packages/core/src/types.ts:1002

---

getMemoryManager()

getMemoryManager(name): IMemoryManager

Parameters

• name: string

Returns

IMemoryManager

Defined in

packages/core/src/types.ts:1004

---

getService()

getService<T>(service): T

Type Parameters

• T extends Service

Parameters

• service: ServiceType

Returns

T

Defined in

packages/core/src/types.ts:1006

---

registerService()

registerService(service): void

Parameters

• service: Service

Returns

void

Defined in

packages/core/src/types.ts:1008

---

getSetting()

getSetting(key): string

Parameters

• key: string

Returns

string

Defined in

packages/core/src/types.ts:1010

---

getConversationLength()

getConversationLength(): number

Methods

Returns

number

Defined in

packages/core/src/types.ts:1013

---

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:1015

---

evaluate()

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

Parameters

• message: Memory

• state?: State

• didRespond?: boolean

Returns

Promise<string[]>

Defined in

packages/core/src/types.ts:1022

---

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:1028

---

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:1030

---

registerAction()

registerAction(action): void

Parameters

• action: Action

Returns

void

Defined in

packages/core/src/types.ts:1037

---

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:1039

---

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:1047

---

ensureRoomExists()

ensureRoomExists(roomId): Promise<void>

Parameters

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

Returns

Promise<void>

Defined in

packages/core/src/types.ts:1049

---

composeState()

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

Parameters

• message: Memory

• additionalKeys?

Returns

Promise<State>

Defined in

packages/core/src/types.ts:1051

---

updateRecentMessageState()

updateRecentMessageState(state): Promise<State>

Parameters

• state: State

Returns

Promise<State>

Defined in

packages/core/src/types.ts:1056