Skip to main content

@elizaos/core v1.0.6 / v2 / Provider

Interface: Provider

Provider for external data/services

Properties​

name​

name: string

Provider name

Defined in​

packages/core/src/specs/v2/types.ts:465

description?​

optional description: string

Description of the provider

Defined in​

packages/core/src/specs/v2/types.ts:468

dynamic?​

optional dynamic: boolean

Whether the provider is dynamic

Defined in​

packages/core/src/specs/v2/types.ts:471

position?​

optional position: number

Position of the provider in the provider list, positive or negative

Defined in​

packages/core/src/specs/v2/types.ts:474

private?​

optional private: boolean

Whether the provider is private

Private providers are not displayed in the regular provider list, they have to be called explicitly

Defined in​

packages/core/src/specs/v2/types.ts:481

get()​

get: (runtime, message, state) => Promise<ProviderResult>

Data retrieval function

Parameters​

• runtime: IAgentRuntime

• message: Memory

• state: State

Returns​

Promise<ProviderResult>

Defined in​

packages/core/src/specs/v2/types.ts:484