Skip to main content

Class: abstract AgentRunner<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>

Runner will manage the task execution and provide a high-level API for the user

Extends​

Extended by​

Type Parameters​

• AI extends LLM

• Store extends object = object

• AdditionalMessageOptions extends object = AI extends LLM<object, infer AdditionalMessageOptions> ? AdditionalMessageOptions : never

• AdditionalChatOptions extends object = object

Constructors​

new AgentRunner()​

protected new AgentRunner<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>(params): AgentRunner<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>

Parameters​

• params: AgentRunnerParams<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>

Returns​

AgentRunner<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>

Overrides​

BaseChatEngine.constructor

Defined in​

packages/core/agent/dist/index.d.ts:80

Properties​

defaultTaskHandler​

static defaultTaskHandler: TaskHandler<LLM<object, object>, object, object, object>

Defined in​

packages/core/agent/dist/index.d.ts:79

Accessors​

chatHistory​

Get Signature​

get chatHistory(): ChatMessage<AdditionalMessageOptions>[]

Returns​

ChatMessage<AdditionalMessageOptions>[]

Overrides​

BaseChatEngine.chatHistory

Defined in​

packages/core/agent/dist/index.d.ts:82

llm​

Get Signature​

get llm(): AI

Returns​

AI

Defined in​

packages/core/agent/dist/index.d.ts:81

verbose​

Get Signature​

get verbose(): boolean

Returns​

boolean

Defined in​

packages/core/agent/dist/index.d.ts:83

Methods​

chat()​

chat(params)​

chat(params): Promise<EngineResponse>

Parameters​

• params: NonStreamingChatEngineParams<AdditionalMessageOptions, AdditionalChatOptions>

Returns​

Promise<EngineResponse>

Overrides​

BaseChatEngine.chat

Defined in​

packages/core/agent/dist/index.d.ts:88

chat(params)​

chat(params): Promise<ReadableStream<EngineResponse>>

Parameters​

• params: StreamingChatEngineParams<AdditionalMessageOptions, AdditionalChatOptions>

Returns​

Promise<ReadableStream<EngineResponse>>

Overrides​

BaseChatEngine.chat

Defined in​

packages/core/agent/dist/index.d.ts:89

createStore()​

abstract createStore(): Store

Returns​

Store

Defined in​

packages/core/agent/dist/index.d.ts:77

createTask()​

createTask(message, stream?, verbose?, chatHistory?, additionalChatOptions?): ReadableStream<TaskStepOutput<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>>

Parameters​

• message: MessageContent

• stream?: boolean

• verbose?: boolean

• chatHistory?: ChatMessage<AdditionalMessageOptions>[]

• additionalChatOptions?: AdditionalChatOptions

Returns​

ReadableStream<TaskStepOutput<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>>

Defined in​

packages/core/agent/dist/index.d.ts:87

getTools()​

getTools(query): BaseToolWithCall[] | Promise<BaseToolWithCall[]>

Parameters​

• query: MessageContent

Returns​

BaseToolWithCall[] | Promise<BaseToolWithCall[]>

Defined in​

packages/core/agent/dist/index.d.ts:85

reset()​

reset(): void

Returns​

void

Defined in​

packages/core/agent/dist/index.d.ts:84

defaultCreateStore()​

static defaultCreateStore(): object

Returns​

object

Defined in​

packages/core/agent/dist/index.d.ts:78

shouldContinue()​

static shouldContinue<AI, Store, AdditionalMessageOptions>(task): boolean

Type Parameters​

• AI extends LLM<object, object>

• Store extends object = object

• AdditionalMessageOptions extends object = AI extends LLM<object, AdditionalMessageOptions> ? AdditionalMessageOptions : never

Parameters​

• task: Readonly<TaskStep<AI, Store, AdditionalMessageOptions, object>>

Returns​

boolean

Defined in​

packages/core/agent/dist/index.d.ts:86