Class: OpenAIAgentWorker

Implements

• AgentWorker<LLMChatParamsBase<OpenAIAdditionalChatOptions>>

Constructors

constructor

• new OpenAIAgentWorker(«destructured»): OpenAIAgentWorker

Parameters

Name	Type
«destructured»	OpenAIAgentWorkerParams

Returns

OpenAIAgentWorker

Defined in

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

Properties

_getTools

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

Type declaration

▸ (input): Promise<BaseTool[]>

Parameters

Name	Type
input	string

Returns

Promise<BaseTool[]>

Defined in

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

---

llm

• Private llm: OpenAI

Defined in

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

---

maxFunctionCalls

• Private maxFunctionCalls: number = 5

Defined in

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

---

prefixMessages

• prefixMessages: { content: MessageContent ; options?: Record<string, unknown> ; role: MessageType }[]

Defined in

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

Methods

_getAgentResponse

▸ _getAgentResponse(task, mode, llmChatParams): Promise<AgentChatResponse | StreamingAgentChatResponse>

Parameters

Name	Type
task	Task
mode	ChatResponseMode
llmChatParams	LLMChatParamsBase<OpenAIAdditionalChatOptions, Record<string, unknown>>

Returns

Promise<AgentChatResponse | StreamingAgentChatResponse>

Defined in

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

---

_getLlmChatParams

▸ _getLlmChatParams(task, openaiTools, toolChoice?): LLMChatParamsBase<OpenAIAdditionalChatOptions, Record<string, unknown>>

Parameters

Name	Type	Default value
task	Task	undefined
openaiTools	BaseTool[]	undefined
toolChoice	ChatCompletionToolChoiceOption	"auto"

Returns

LLMChatParamsBase<OpenAIAdditionalChatOptions, Record<string, unknown>>

Defined in

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

---

_getStreamAiResponse

▸ _getStreamAiResponse(task, llmChatParams): Promise<AgentChatResponse | StreamingAgentChatResponse>

Parameters

Name	Type
task	Task
llmChatParams	LLMChatParamsBase<OpenAIAdditionalChatOptions, Record<string, unknown>>

Returns

Promise<AgentChatResponse | StreamingAgentChatResponse>

Defined in

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

---

_processMessage

▸ _processMessage(task, aiMessage): AgentChatResponse

Parameters

Name	Type
task	Task
aiMessage	Object
aiMessage.content	MessageContent
aiMessage.options?	Record<string, unknown>
aiMessage.role	MessageType

Returns

AgentChatResponse

Defined in

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

---

_runStep

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

Parameters

Name	Type	Default value
step	TaskStep	undefined
task	Task	undefined
mode	ChatResponseMode	ChatResponseMode.WAIT
toolChoice	ChatCompletionToolChoiceOption	"auto"

Returns

Promise<TaskStepOutput>

Defined in

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

---

_shouldContinue

▸ _shouldContinue(toolCalls, nFunctionCalls): boolean

Parameters

Name	Type
toolCalls	null | ChatCompletionMessageToolCall[]
nFunctionCalls	number

Returns

boolean

Defined in

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

---

callFunction

▸ callFunction(tools, toolCall): Promise<CallFunctionOutput>

Parameters

Name	Type
tools	BaseTool[]
toolCall	ChatCompletionMessageToolCall

Returns

Promise<CallFunctionOutput>

Defined in

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

---

finalizeTask

▸ finalizeTask(task): void

Parameters

Name	Type
task	Task

Returns

void

Implementation of

AgentWorker.finalizeTask

Defined in

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

---

getAllMessages

▸ getAllMessages(task): { content: MessageContent ; options?: Record<string, unknown> ; role: MessageType }[]

Parameters

Name	Type
task	Task

Returns

{ content: MessageContent ; options?: Record<string, unknown> ; role: MessageType }[]

Defined in

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

---

getLatestToolCalls

▸ getLatestToolCalls(task): null | ChatCompletionMessageToolCall[]

Parameters

Name	Type
task	Task

Returns

null | ChatCompletionMessageToolCall[]

Defined in

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

---

getTools

▸ getTools(input): Promise<BaseTool[]>

Parameters

Name	Type
input	string

Returns

Promise<BaseTool[]>

Defined in

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

---

initializeStep

▸ initializeStep(task): TaskStep

Parameters

Name	Type
task	Task

Returns

TaskStep

Implementation of

AgentWorker.initializeStep

Defined in

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

---

runStep

▸ runStep(step, task, chatParams): Promise<TaskStepOutput>

Parameters

Name	Type
step	TaskStep
task	Task
chatParams	LLMChatParamsBase<OpenAIAdditionalChatOptions, Record<string, unknown>>

Returns

Promise<TaskStepOutput>

Implementation of

AgentWorker.runStep

Defined in

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

---

streamStep

▸ streamStep(step, task, chatParams): Promise<TaskStepOutput>

Parameters

Name	Type
step	TaskStep
task	Task
chatParams	LLMChatParamsBase<OpenAIAdditionalChatOptions, Record<string, unknown>>

Returns

Promise<TaskStepOutput>

Implementation of

AgentWorker.streamStep

Defined in

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