BaseWorkflowAgent

Defined in: packages/workflow/src/agent/base.ts:20

Base interface for workflow agents

Properties

name

readonly name: string

Defined in: packages/workflow/src/agent/base.ts:21

---

systemPrompt

readonly systemPrompt: string

Defined in: packages/workflow/src/agent/base.ts:22

---

description

readonly description: string

Defined in: packages/workflow/src/agent/base.ts:23

---

tools

readonly tools: BaseToolWithCall[]

Defined in: packages/workflow/src/agent/base.ts:24

---

llm

readonly llm: LLM

Defined in: packages/workflow/src/agent/base.ts:25

---

canHandoffTo

readonly canHandoffTo: string[]

Defined in: packages/workflow/src/agent/base.ts:26

Methods

getStructuredOutput()

getStructuredOutput(responseFormat, response): Promise<JSONObject>

Defined in: packages/workflow/src/agent/base.ts:31

Take the final response and convert it to a structured output

Parameters

responseFormat

ZodSchema

response

ChatMessage

Returns

Promise<JSONObject>

---

takeStep()

takeStep(ctx, state, llmInput, tools): Promise<AgentOutput>

Defined in: packages/workflow/src/agent/base.ts:40

Take a single step with the agent Using memory directly to get messages instead of requiring them to be passed in

Parameters

ctx

WorkflowContext

state

AgentWorkflowState

llmInput

ChatMessage[]

tools

BaseToolWithCall[]

Returns

Promise<AgentOutput>

---

handleToolCallResults()

handleToolCallResults(state, results): Promise<void>

Defined in: packages/workflow/src/agent/base.ts:50

Handle results from tool calls

Parameters

state

AgentWorkflowState

results

AgentToolCallResult[]

Returns

Promise<void>

---

finalize()

finalize(state, output): Promise<AgentOutput>

Defined in: packages/workflow/src/agent/base.ts:58

Finalize the agent's output

Parameters

state

AgentWorkflowState

output

AgentOutput

Returns

Promise<AgentOutput>