IAgentRuntime.md

@elizaos/core v0.25.8 / IAgentRuntime

Interface: IAgentRuntime

Properties

agentId

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

Properties

Defined in

packages/core/src/types.ts:1280

---

serverUrl

serverUrl: string

Defined in

packages/core/src/types.ts:1281

---

databaseAdapter

databaseAdapter: IDatabaseAdapter

Defined in

packages/core/src/types.ts:1282

---

token

token: string

Defined in

packages/core/src/types.ts:1283

---

modelProvider

modelProvider: ModelProviderName

Defined in

packages/core/src/types.ts:1284

---

imageModelProvider

imageModelProvider: ModelProviderName

Defined in

packages/core/src/types.ts:1285

---

imageVisionModelProvider

imageVisionModelProvider: ModelProviderName

Defined in

packages/core/src/types.ts:1286

---

character

character: Character

Defined in

packages/core/src/types.ts:1287

---

providers

providers: Provider[]

Defined in

packages/core/src/types.ts:1288

---

actions

actions: Action[]

Defined in

packages/core/src/types.ts:1289

---

evaluators

evaluators: Evaluator[]

Defined in

packages/core/src/types.ts:1290

---

plugins

plugins: Plugin[]

Defined in

packages/core/src/types.ts:1291

---

fetch()?

optional fetch: (input, init?) => Promise<Response>(input, init?) => Promise<Response>

MDN Reference

Parameters

• input: RequestInfo | URL

• init?: RequestInit

Returns

Promise<Response>

Parameters

• input: string | Request | URL

• init?: RequestInit

Returns

Promise<Response>

Defined in

packages/core/src/types.ts:1293

---

messageManager

messageManager: IMemoryManager

Defined in

packages/core/src/types.ts:1295

---

descriptionManager

descriptionManager: IMemoryManager

Defined in

packages/core/src/types.ts:1296

---

documentsManager

documentsManager: IMemoryManager

Defined in

packages/core/src/types.ts:1297

---

knowledgeManager

knowledgeManager: IMemoryManager

Defined in

packages/core/src/types.ts:1298

---

ragKnowledgeManager

ragKnowledgeManager: IRAGKnowledgeManager

Defined in

packages/core/src/types.ts:1299

---

loreManager

loreManager: IMemoryManager

Defined in

packages/core/src/types.ts:1300

---

cacheManager

cacheManager: ICacheManager

Defined in

packages/core/src/types.ts:1302

---

services

services: Map<ServiceType, Service>

Defined in

packages/core/src/types.ts:1304

---

clients

clients: ClientInstance[]

Defined in

packages/core/src/types.ts:1305

Methods

initialize()

initialize(): Promise<void>

verifiableInferenceAdapter?: IVerifiableInferenceAdapter | null;

Returns

Promise<void>

Defined in

packages/core/src/types.ts:1309

---

registerMemoryManager()

registerMemoryManager(manager): void

Parameters

• manager: IMemoryManager

Returns

void

Defined in

packages/core/src/types.ts:1311

---

getMemoryManager()

getMemoryManager(name): IMemoryManager

Parameters

• name: string

Returns

IMemoryManager

Defined in

packages/core/src/types.ts:1313

---

getService()

getService<T>(service): T

Type Parameters

• T extends Service

Parameters

• service: ServiceType

Returns

T

Defined in

packages/core/src/types.ts:1315

---

registerService()

registerService(service): void

Parameters

• service: Service

Returns

void

Defined in

packages/core/src/types.ts:1317

---

getSetting()

getSetting(key): string

Parameters

• key: string

Returns

string

Defined in

packages/core/src/types.ts:1319

---

getConversationLength()

getConversationLength(): number

Methods

Returns

number

Defined in

packages/core/src/types.ts:1322

---

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

---

evaluate()

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

Parameters

• message: Memory

• state?: State

• didRespond?: boolean

• callback?: HandlerCallback

Returns

Promise<string[]>

Defined in

packages/core/src/types.ts:1331

---

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

---

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

---

registerAction()

registerAction(action): void

Parameters

• action: Action

Returns

void

Defined in

packages/core/src/types.ts:1347

---

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

---

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

---

ensureRoomExists()

ensureRoomExists(roomId): Promise<void>

Parameters

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

Returns

Promise<void>

Defined in

packages/core/src/types.ts:1359

---

composeState()

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

Parameters

• message: Memory

• additionalKeys?

Returns

Promise<State>

Defined in

packages/core/src/types.ts:1361

---

updateRecentMessageState()

updateRecentMessageState(state): Promise<State>

Parameters

• state: State

Returns

Promise<State>

Defined in

packages/core/src/types.ts:1366