Skip to main content

Class: OpenAIAgentWorker

OpenAI agent worker. This class is responsible for running the agent.

Implements

Constructors

constructor

new OpenAIAgentWorker(«destructured»): OpenAIAgentWorker

Initialize.

Parameters

NameType
«destructured»OpenAIAgentWorkerParams

Returns

OpenAIAgentWorker

Defined in

packages/core/src/agent/openai/worker.ts:103

Properties

_getTools

Private _getTools: (input: string) => Promise<BaseTool[]>

Type declaration

▸ (input): Promise<BaseTool[]>

Parameters
NameType
inputstring
Returns

Promise<BaseTool[]>

Defined in

packages/core/src/agent/openai/worker.ts:98


callbackManager

callbackManager: undefined | CallbackManager

Defined in

packages/core/src/agent/openai/worker.ts:96


llm

Private llm: OpenAI

Defined in

packages/core/src/agent/openai/worker.ts:91


maxFunctionCalls

Private maxFunctionCalls: number

Defined in

packages/core/src/agent/openai/worker.ts:93


prefixMessages

prefixMessages: ChatMessage[]

Defined in

packages/core/src/agent/openai/worker.ts:95


verbose

Private verbose: boolean

Defined in

packages/core/src/agent/openai/worker.ts:92

Methods

_getAgentResponse

_getAgentResponse(task, mode, llmChatKwargs): Promise<AgentChatResponse>

Get agent response.

Parameters

NameType
taskTask
modeChatResponseMode
llmChatKwargsany

Returns

Promise<AgentChatResponse>

Defined in

packages/core/src/agent/openai/worker.ts:205


_getLlmChatKwargs

_getLlmChatKwargs(task, openaiTools, toolChoice?): Object

Parameters

NameTypeDefault value
taskTaskundefined
openaiTools{ [key: string]: any; }[]undefined
toolChoicestring | { [key: string]: any; }"auto"

Returns

Object

Defined in

packages/core/src/agent/openai/worker.ts:165


_processMessage

_processMessage(task, chatResponse): AsyncIterable<ChatResponseChunk> | AgentChatResponse

Process message.

Parameters

NameType
taskTask
chatResponseChatResponse

Returns

AsyncIterable<ChatResponseChunk> | AgentChatResponse

Defined in

packages/core/src/agent/openai/worker.ts:188


_runStep

_runStep(step, task, mode?, toolChoice?): Promise<TaskStepOutput>

Parameters

NameTypeDefault value
stepTaskStepundefined
taskTaskundefined
modeChatResponseModeChatResponseMode.WAIT
toolChoicestring | { [key: string]: any; }"auto"

Returns

Promise<TaskStepOutput>

Defined in

packages/core/src/agent/openai/worker.ts:306


_shouldContinue

_shouldContinue(toolCalls, nFunctionCalls): boolean

Should continue.

Parameters

NameType
toolCallsnull | ChatCompletionMessageToolCall[]
nFunctionCallsnumber

Returns

boolean

Defined in

packages/core/src/agent/openai/worker.ts:282


callFunction

callFunction(tools, toolCall): Promise<CallFunctionOutput>

Call function.

Parameters

NameType
toolsBaseTool[]
toolCallChatCompletionMessageToolCall

Returns

Promise<CallFunctionOutput>

Defined in

packages/core/src/agent/openai/worker.ts:230


finalizeTask

finalizeTask(task, kwargs?): void

Finalize task.

Parameters

NameType
taskTask
kwargs?any

Returns

void

Implementation of

AgentWorker.finalizeTask

Defined in

packages/core/src/agent/openai/worker.ts:402


getAllMessages

getAllMessages(task): ChatMessage[]

Get all messages.

Parameters

NameType
taskTask

Returns

ChatMessage[]

Defined in

packages/core/src/agent/openai/worker.ts:135


getLatestToolCalls

getLatestToolCalls(task): null | ChatCompletionMessageToolCall[]

Get latest tool calls.

Parameters

NameType
taskTask

Returns

null | ChatCompletionMessageToolCall[]

Defined in

packages/core/src/agent/openai/worker.ts:148


getTools

getTools(input): Promise<BaseTool[]>

Get tools.

Parameters

NameType
inputstring

Returns

Promise<BaseTool[]>

Defined in

packages/core/src/agent/openai/worker.ts:302


initializeStep

initializeStep(task, kwargs?): TaskStep

Initialize step.

Parameters

NameType
taskTask
kwargs?any

Returns

TaskStep

Implementation of

AgentWorker.initializeStep

Defined in

packages/core/src/agent/openai/worker.ts:257


runStep

runStep(step, task, kwargs?): Promise<TaskStepOutput>

Run step.

Parameters

NameType
stepTaskStep
taskTask
kwargs?any

Returns

Promise<TaskStepOutput>

Implementation of

AgentWorker.runStep

Defined in

packages/core/src/agent/openai/worker.ts:371


streamStep

streamStep(step, task, kwargs?): Promise<TaskStepOutput>

Stream step.

Parameters

NameType
stepTaskStep
taskTask
kwargs?any

Returns

Promise<TaskStepOutput>

Implementation of

AgentWorker.streamStep

Defined in

packages/core/src/agent/openai/worker.ts:387