AgentRunner

Defined in: packages/core/src/agent/base.ts:256

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

Deprecated

Use agent instead.

Extends

• BaseChatEngine

Extended by

• LLMAgent

Type Parameters

AI

AI extends LLM

Store

Store extends object = object

AdditionalMessageOptions

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

AdditionalChatOptions

AdditionalChatOptions extends object = object

Constructors

Constructor

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

Defined in: packages/core/src/agent/base.ts:321

Parameters

params

AgentRunnerParams<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>

Returns

AgentRunner<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>

Overrides

BaseChatEngine.constructor

Properties

defaultTaskHandler

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

Defined in: packages/core/src/agent/base.ts:288

Accessors

llm

Get Signature

get llm(): AI

Defined in: packages/core/src/agent/base.ts:341

Returns

AI

---

chatHistory

Get Signature

get chatHistory(): ChatMessage<AdditionalMessageOptions>[]

Defined in: packages/core/src/agent/base.ts:345

Returns

ChatMessage<AdditionalMessageOptions>[]

Overrides

BaseChatEngine.chatHistory

---

verbose

Get Signature

get verbose(): boolean

Defined in: packages/core/src/agent/base.ts:349

Returns

boolean

Methods

createStore()

abstract createStore(): Store

Defined in: packages/core/src/agent/base.ts:282

Returns

Store

---

defaultCreateStore()

static defaultCreateStore(): object

Defined in: packages/core/src/agent/base.ts:284

Returns

object

---

reset()

reset(): void

Defined in: packages/core/src/agent/base.ts:353

Returns

void

---

getTools()

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

Defined in: packages/core/src/agent/base.ts:357

Parameters

query

MessageContent

Returns

BaseToolWithCall[] | Promise<BaseToolWithCall[]>

---

shouldContinue()

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

Defined in: packages/core/src/agent/base.ts:363

Type Parameters

AI

AI extends LLM<object, object>

Store

Store extends object = object

AdditionalMessageOptions

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

Parameters

task

Readonly<TaskStep<AI, Store, AdditionalMessageOptions>>

Returns

boolean

---

createTask()

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

Defined in: packages/core/src/agent/base.ts:376

Parameters

message

MessageContent

stream

boolean = false

verbose

undefined | boolean

chatHistory?

ChatMessage<AdditionalMessageOptions>[]

additionalChatOptions?

AdditionalChatOptions

Returns

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

---

chat()

Call Signature

chat(params): Promise<EngineResponse>

Defined in: packages/core/src/agent/base.ts:420

Parameters

params

NonStreamingChatEngineParams<AdditionalMessageOptions, AdditionalChatOptions>

Returns

Promise<EngineResponse>

Overrides

BaseChatEngine.chat

Call Signature

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

Defined in: packages/core/src/agent/base.ts:426

Parameters

params

StreamingChatEngineParams<AdditionalMessageOptions, AdditionalChatOptions>

Returns

Promise<ReadableStream<EngineResponse>>

Overrides

BaseChatEngine.chat