Skip to main content

Class: abstract AgentRunner<AI, Store, AdditionalMessageOptions>

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

Extended by​

Type parameters​

• AI extends LLM

• Store extends object = object

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

Implements​

Constructors​

new AgentRunner()​

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

Parameters​

• params: AgentRunnerParams<AI, Store, AdditionalMessageOptions>

Returns​

AgentRunner<AI, Store, AdditionalMessageOptions>

Source​

packages/llamaindex/src/agent/base.ts:245

Properties​

#chatHistory​

private #chatHistory: ChatMessage<AdditionalMessageOptions>[]

Source​

packages/llamaindex/src/agent/base.ts:207

#llm​

private readonly #llm: AI

Source​

packages/llamaindex/src/agent/base.ts:202

#runner​

private readonly #runner: AgentWorker<AI, Store, AdditionalMessageOptions>

Source​

packages/llamaindex/src/agent/base.ts:208

#systemPrompt​

private readonly #systemPrompt: null | MessageContent = null

Source​

packages/llamaindex/src/agent/base.ts:206

#tools​

private readonly #tools: BaseToolWithCall[] | (query) => Promise <BaseToolWithCall[]>

Source​

packages/llamaindex/src/agent/base.ts:203

#verbose​

private readonly #verbose: boolean

Source​

packages/llamaindex/src/agent/base.ts:209

defaultTaskHandler​

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

Source​

packages/llamaindex/src/agent/base.ts:218

Accessors​

chatHistory​

get chatHistory(): ChatMessage<AdditionalMessageOptions>[]

Returns​

ChatMessage<AdditionalMessageOptions>[]

Source​

packages/llamaindex/src/agent/base.ts:263

llm​

get llm(): AI

Returns​

AI

Source​

packages/llamaindex/src/agent/base.ts:259

verbose​

get verbose(): boolean

Returns​

boolean

Source​

packages/llamaindex/src/agent/base.ts:267

Methods​

chat()​

chat(params)​

chat(params): Promise <EngineResponse>

Send message along with the class's current chat history to the LLM.

Parameters​

• params: ChatEngineParamsNonStreaming

Returns​

Promise <EngineResponse>

Implementation of​

ChatEngine . chat

Source​

packages/llamaindex/src/agent/base.ts:334

chat(params)​

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

Parameters​

• params: ChatEngineParamsStreaming

Returns​

Promise<ReadableStream <EngineResponse>>

Implementation of​

ChatEngine . chat

Source​

packages/llamaindex/src/agent/base.ts:335

createStore()​

abstract createStore(): Store

Returns​

Store

Source​

packages/llamaindex/src/agent/base.ts:212

createTask()​

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

Parameters​

• message: MessageContent

• stream: boolean= false

• verbose: undefined | boolean= undefined

• chatHistory?: ChatMessage<AdditionalMessageOptions>[]

Returns​

ReadableStream<TaskStepOutput<AI, Store, AdditionalMessageOptions>>

Source​

packages/llamaindex/src/agent/base.ts:294

getTools()​

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

Parameters​

• query: MessageContent

Returns​

BaseToolWithCall[] | Promise <BaseToolWithCall[]>

Source​

packages/llamaindex/src/agent/base.ts:275

reset()​

reset(): void

Resets the chat history so that it's empty.

Returns​

void

Implementation of​

ChatEngine . reset

Source​

packages/llamaindex/src/agent/base.ts:271

defaultCreateStore()​

static defaultCreateStore(): object

Returns​

object

Source​

packages/llamaindex/src/agent/base.ts:214

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

Returns​

boolean

Source​

packages/llamaindex/src/agent/base.ts:281