Skip to main content

Class: OpenAIContextAwareAgent

Extends​

Constructors​

new OpenAIContextAwareAgent()​

new OpenAIContextAwareAgent(params): OpenAIContextAwareAgent

Parameters​

• params: OpenAIContextAwareAgentParams

Returns​

OpenAIContextAwareAgent

Overrides​

withContextAwareness(OpenAIAgent).constructor

Defined in​

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

Properties​

contextRetriever​

contextRetriever: BaseRetriever

Inherited from​

withContextAwareness(OpenAIAgent).contextRetriever

Defined in​

packages/llamaindex/src/agent/contextAwareMixin.ts:33

createStore​

createStore: () => object & () => object

Inherited from​

withContextAwareness(OpenAIAgent).createStore

Defined in​

packages/llamaindex/src/agent/contextAwareMixin.ts:42

retrievedContext​

retrievedContext: null | string = null

Inherited from​

withContextAwareness(OpenAIAgent).retrievedContext

Defined in​

packages/llamaindex/src/agent/contextAwareMixin.ts:34

taskHandler​

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

Inherited from​

withContextAwareness(OpenAIAgent).taskHandler

Defined in​

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

defaultTaskHandler​

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

Inherited from​

withContextAwareness(OpenAIAgent).defaultTaskHandler

Defined in​

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

Accessors​

chatHistory​

get chatHistory(): ChatMessage<AdditionalMessageOptions>[]

Returns​

ChatMessage<AdditionalMessageOptions>[]

Inherited from​

withContextAwareness(OpenAIAgent).chatHistory

Defined in​

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

llm​

get llm(): AI

Returns​

AI

Inherited from​

withContextAwareness(OpenAIAgent).llm

Defined in​

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

verbose​

get verbose(): boolean

Returns​

boolean

Inherited from​

withContextAwareness(OpenAIAgent).verbose

Defined in​

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

Methods​

chat()​

chat(params)​

chat(params): Promise<EngineResponse>

Parameters​

• params: NonStreamingChatEngineParams<object>

Returns​

Promise<EngineResponse>

Inherited from​

withContextAwareness(OpenAIAgent).chat

Defined in​

packages/llamaindex/src/agent/contextAwareMixin.ts:63

chat(params)​

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

Parameters​

• params: StreamingChatEngineParams<object>

Returns​

Promise<ReadableStream<EngineResponse>>

Inherited from​

withContextAwareness(OpenAIAgent).chat

Defined in​

packages/llamaindex/src/agent/contextAwareMixin.ts:64

createTask()​

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

Parameters​

• message: MessageContent

• stream?: boolean

• verbose?: boolean

• chatHistory?: ChatMessage<object>[]

Returns​

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

Inherited from​

withContextAwareness(OpenAIAgent).createTask

Defined in​

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

getTools()​

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

Parameters​

• query: MessageContent

Returns​

BaseToolWithCall[] | Promise<BaseToolWithCall[]>

Inherited from​

withContextAwareness(OpenAIAgent).getTools

Defined in​

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

injectContext()​

injectContext(context): Promise<void>

Parameters​

• context: string

Returns​

Promise<void>

Inherited from​

withContextAwareness(OpenAIAgent).injectContext

Defined in​

packages/llamaindex/src/agent/contextAwareMixin.ts:53

reset()​

reset(): void

Returns​

void

Inherited from​

withContextAwareness(OpenAIAgent).reset

Defined in​

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

retrieveContext()​

retrieveContext(query): Promise<string>

Parameters​

• query: MessageContent

Returns​

Promise<string>

Inherited from​

withContextAwareness(OpenAIAgent).retrieveContext

Defined in​

packages/llamaindex/src/agent/contextAwareMixin.ts:46

defaultCreateStore()​

static defaultCreateStore(): object

Returns​

object

Inherited from​

withContextAwareness(OpenAIAgent).defaultCreateStore

Defined in​

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

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​

withContextAwareness(OpenAIAgent).shouldContinue

Defined in​

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