AgentWorkflow
定义于:.build/typescript/packages/workflow/src/agent/agent-workflow.ts:171
AgentWorkflow - 一个用于通过工具执行智能体的事件驱动工作流
该类提供了一个简单的接口,用于基于LlamaIndexTS工作流系统创建和运行智能体工作流。它支持具有多个工具的单智能体工作流。
Workflow
new AgentWorkflow(
__namedParameters):AgentWorkflow
定义于:.build/typescript/packages/workflow/src/agent/agent-workflow.ts:182
__namedParameters
Section titled “__namedParameters”AgentWorkflow
handle()
Section titled “handle()”handle<
AcceptEvents,Result>(accept,handler):void
定义于:.build/typescript/packages/workflow/src/agent/agent-workflow.ts:240
为一个或多个工作流事件注册处理函数。
每当通过工作流上下文发送任何已接受事件时,该处理器将被调用。处理器可以处理事件,并可选择返回新事件以继续工作流。
AcceptEvents
Section titled “AcceptEvents”AcceptEvents extends WorkflowEvent<unknown>[]
此处理器接受的事件类型数组
Result 继承 void | WorkflowEventData<unknown, string>
处理程序的返回类型(事件数据或空)
AcceptEvents
触发此处理程序的事件类型数组
Handler<AcceptEvents, Result>
当接收到匹配事件时执行的函数
void
// Handle multiple event typesworkflow.handle([StartEvent, RestartEvent], async (context, event) => \{ if (StartEvent.include(event)) { return ProcessEvent.with({ action: 'start' \}); } else \{ return ProcessEvent.with({ action: 'restart' \}); }});Workflow.handle
createContext()
Section titled “createContext()”createContext():
WorkflowContext
定义于:.build/typescript/packages/workflow/src/agent/agent-workflow.ts:247
为事件处理创建一个新的工作流上下文。
上下文为执行处理器和管理事件流提供了运行时环境。每个上下文维护其自身的执行状态和事件队列。
WorkflowContext
一个新的工作流上下文实例
const context = workflow.createContext();
// Send events through the contextawait context.send(MyEvent.with(\{ data: 'hello' \}));
// Listen for specific eventsconst result = await context.waitFor(CompletionEvent);Workflow.createContext
addAgent()
Section titled “addAgent()”addAgent(
agent):this
定义于:.build/typescript/packages/workflow/src/agent/agent-workflow.ts:301
向工作流中添加一个新的智能体
this
getAgents()
Section titled “getAgents()”getAgents():
BaseWorkflowAgent[]
定义于:.build/typescript/packages/workflow/src/agent/agent-workflow.ts:312
获取此工作流中的所有智能体
此工作流中的智能体数组
fromTools()
Section titled “fromTools()”
staticfromTools(params):AgentWorkflow
定义于:.build/typescript/packages/workflow/src/agent/agent-workflow.ts:321
创建一个包含单个智能体和指定工具的简单工作流
单智能体工作流的参数
AgentWorkflow
一个新的智能体工作流实例
runStream()
Section titled “runStream()”runStream<
Z>(userInput,params?):WorkflowStream<WorkflowEventData<AgentResultData<ZodInfer<Z>>>>
定义于:.build/typescript/packages/workflow/src/agent/agent-workflow.ts:651
Z extends ZodSchema
userInput
Section titled “userInput”MessageContent
ChatMessage[]
Z
WorkflowStream<WorkflowEventData<AgentResultData<ZodInfer<Z>>>>
运行<
Z>(userInput,params?):Promise<WorkflowEventData<AgentResultData<ZodInfer<Z>>>>
定义于:.build/typescript/packages/workflow/src/agent/agent-workflow.ts:677
Z extends ZodSchema
userInput
Section titled “userInput”MessageContent
ChatMessage[]
Z
Promise<WorkflowEventData<AgentResultData<ZodInfer<Z>>>>
createHandoffTool()
Section titled “createHandoffTool()”createHandoffTool(
agents):FunctionTool<{toAgent:string;reason:string; },JSONValue|Promise<JSONValue>, () =>AgentWorkflowState>
定义于:.build/typescript/packages/workflow/src/agent/agent-workflow.ts:696
Map<string, BaseWorkflowAgent>
FunctionTool<{ toAgent: string; reason: string; }, JSONValue | Promise<JSONValue>, () => AgentWorkflowState>