Skip to main content

Class: OpenAIAgent

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

Extends

Constructors

new OpenAIAgent()

new OpenAIAgent(params): OpenAIAgent

Parameters

params: LLMAgentParams

Returns

OpenAIAgent

Overrides

LLMAgent.constructor

Defined in

packages/llamaindex/src/agent/openai.ts:12

Properties

createStore()

createStore: () => object = AgentRunner.defaultCreateStore

Returns

object

Inherited from

LLMAgent.createStore

Defined in

packages/llamaindex/src/agent/llm.ts:44


taskHandler

taskHandler: TaskHandler<LLM<object, object>> = AgentRunner.defaultTaskHandler

Inherited from

LLMAgent.taskHandler

Defined in

packages/llamaindex/src/agent/llm.ts:45


defaultTaskHandler

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

Inherited from

LLMAgent.defaultTaskHandler

Defined in

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

Accessors

chatHistory

get chatHistory(): ChatMessage<AdditionalMessageOptions>[]

Returns

ChatMessage<AdditionalMessageOptions>[]

Inherited from

LLMAgent.chatHistory

Defined in

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


llm

get llm(): AI

Returns

AI

Inherited from

LLMAgent.llm

Defined in

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


verbose

get verbose(): boolean

Returns

boolean

Inherited from

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

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

LLMAgent.chat

Defined in

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


createTask()

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

Parameters

message: MessageContent

stream: boolean = false

verbose: undefined | boolean = undefined

chatHistory?: ChatMessage<object>[]

Returns

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

Inherited from

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

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

LLMAgent.reset

Defined in

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


defaultCreateStore()

static defaultCreateStore(): object

Returns

object

Inherited from

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

LLMAgent.shouldContinue

Defined in

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