跳转到内容
LlamaIndex TypeScript API Reference

FunctionAgent

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:110

工作流智能体的基础接口

实现

Section titled “Implements”

构造函数

Section titled “Constructors”

构造函数

Section titled “Constructor”

new FunctionAgent(__namedParameters): FunctionAgent

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:118

参数

Section titled “Parameters”
__namedParameters
Section titled “__namedParameters”

FunctionAgentParams

返回

Section titled “Returns”

FunctionAgent

属性

Section titled “Properties”

名称

Section titled “name”

readonly 名称: string

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:111

实现

Section titled “Implementation of”

BaseWorkflowAgent.name

systemPrompt

Section titled “systemPrompt”

readonly systemPrompt: string

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:112

实现

Section titled “Implementation of”

BaseWorkflowAgent.systemPrompt

描述

Section titled “description”

readonly 描述: string

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:113

实现

Section titled “Implementation of”

BaseWorkflowAgent.description

大语言模型

Section titled “llm”

readonly llm: ToolCallLLM

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:114

实现

Section titled “Implementation of”

BaseWorkflowAgent.llm

工具

Section titled “tools”

readonly 工具: BaseToolWithCall[]

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:115

实现

Section titled “Implementation of”

BaseWorkflowAgent.tools

canHandoffTo

Section titled “canHandoffTo”

readonly 可转交给: string[]

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:116

实现

Section titled “Implementation of”

BaseWorkflowAgent.canHandoffTo

方法

Section titled “Methods”

getStructuredOutput()

Section titled “getStructuredOutput()”

getStructuredOutput(responseFormat, response): Promise<any>

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:139

获取最终响应并将其转换为结构化输出

参数

Section titled “Parameters”
responseFormat
Section titled “responseFormat”

ZodSchema

响应
Section titled “response”

ChatMessage

返回

Section titled “Returns”

Promise<any>

实现

Section titled “Implementation of”

BaseWorkflowAgent.getStructuredOutput

takeStep()

Section titled “takeStep()”

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

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:181

使用智能体执行单步操作 直接使用内存获取消息，无需传入消息

参数

Section titled “Parameters”
上下文
Section titled “ctx”

WorkflowContext

状态
Section titled “state”

AgentWorkflowState

llmInput
Section titled “llmInput”

ChatMessage[]

工具
Section titled “tools”

BaseToolWithCall[]

返回

Section titled “Returns”

Promise<AgentOutput>

实现

Section titled “Implementation of”

BaseWorkflowAgent.takeStep

handleToolCallResults()

Section titled “handleToolCallResults()”

handleToolCallResults(state, results): Promise<void>

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:242

处理工具调用的结果

参数

Section titled “Parameters”
状态
Section titled “state”

AgentWorkflowState

结果
Section titled “results”

AgentToolCallResult[]

返回

Section titled “Returns”

Promise<void>

实现

Section titled “Implementation of”

BaseWorkflowAgent.handleToolCallResults

finalize()

Section titled “finalize()”

finalize(state, output): Promise<AgentOutput>

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:268

完成智能体的输出

参数

Section titled “Parameters”
状态
Section titled “state”

AgentWorkflowState

输出
Section titled “output”

AgentOutput

返回

Section titled “Returns”

Promise<AgentOutput>

实现

Section titled “Implementation of”

BaseWorkflowAgent.finalize

fromWorkflowStep()

Section titled “fromWorkflowStep()”

static fromWorkflowStep(__namedParameters): FunctionAgent

定义于：.build/typescript/packages/workflow/src/agent/function-agent.ts:339

创建一个FunctionAgent来处理工作流中的一个步骤。

参数

Section titled “Parameters”
__namedParameters
Section titled “__namedParameters”

StepHandlerParams

返回

Section titled “Returns”

FunctionAgent

一个新的FunctionAgent实例