Class: ReActAgent

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

Extends

• AgentRunner<LLM, ReACTAgentStore>

Constructors

new ReActAgent()

new ReActAgent(params): ReActAgent

Parameters

• params: ReACTAgentParams

Returns

ReActAgent

Overrides

AgentRunner.constructor

Defined in

packages/llamaindex/src/agent/react.ts:329

Properties

defaultTaskHandler

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

Inherited from

AgentRunner.defaultTaskHandler

Defined in

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

---

taskHandler

static taskHandler: TaskHandler<LLM<object, object>, ReACTAgentStore>

Defined in

packages/llamaindex/src/agent/react.ts:350

Accessors

chatHistory

get chatHistory(): ChatMessage<AdditionalMessageOptions>[]

Returns

ChatMessage<AdditionalMessageOptions>[]

Inherited from

AgentRunner.chatHistory

Defined in

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

---

llm

get llm(): AI

Returns

AI

Inherited from

AgentRunner.llm

Defined in

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

---

verbose

get verbose(): boolean

Returns

boolean

Inherited from

AgentRunner.verbose

Defined in

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

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>

Inherited from

AgentRunner.chat

Defined in

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

chat(params)

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

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

Parameters

• params: ChatEngineParamsStreaming

Returns

Promise<ReadableStream<EngineResponse>>

Inherited from

AgentRunner.chat

Defined in

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

---

createStore()

createStore(): object

Returns

object

reasons

reasons: never[] = []

Overrides

AgentRunner.createStore

Defined in

packages/llamaindex/src/agent/react.ts:344

---

createTask()

createTask(message, stream, verbose, chatHistory?): ReadableStream<TaskStepOutput<LLM<object, object>, ReACTAgentStore, object>>

Parameters

• message: MessageContent

• stream: boolean = false

• verbose: undefined | boolean = undefined

• chatHistory?: ChatMessage<object>[]

Returns

ReadableStream<TaskStepOutput<LLM<object, object>, ReACTAgentStore, object>>

Inherited from

AgentRunner.createTask

Defined in

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

---

getTools()

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

Parameters

• query: MessageContent

Returns

BaseToolWithCall[] | Promise<BaseToolWithCall[]>

Inherited from

AgentRunner.getTools

Defined in

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

---

reset()

reset(): void

Resets the chat history so that it's empty.

Returns

void

Inherited from

AgentRunner.reset

Defined in

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

---

defaultCreateStore()

static defaultCreateStore(): object

Returns

object

Inherited from

AgentRunner.defaultCreateStore

Defined in

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

---

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

Inherited from

AgentRunner.shouldContinue

Defined in

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