SuperAPI AI 工具集

workflow-best-practices

办公与效率

查看项目

更新于 10-15 16:49

技能介绍

用途:该技能用于构建持久化(durable)工作流,覆盖步骤(steps)、流式输出(streaming)、Agent 运行、元数据与持久化,适用于编写、启动、恢复等场景。使用前需先完成 Workflow Development Kit Setup 等前置配置。

主要能力与目录结构:每个工作流位于 src/workflows/ 下的子文件夹。index.ts 负责编排(标注 "use workflow");steps/ 存放持久化检查点(标注 "use step");共享步骤放在顶层的 steps/ 下,例如 stream.ts。

创建流程:编排函数带 "use workflow" 并调用各步骤。运行 Agent 时必须先用 startStream(messageId) 包裹,结束后调用 finishStream(),因为 WorkflowChatTransport 需要 start/finish 帧来解析响应。startStream 写入 { type: "start", messageId },finishStream 写入 { type: "finish", finishReason: "stop" } 并关闭可写流。

步骤:步骤是可持久化结果的检查点,需标注 "use step"。由于工作流运行时无法导入 Node 模块,需将日志调用包装成一个步骤。

启动与恢复:使用 workflow/api 的 start 启动,用 getRun 重连进行中或已完成的运行;run.runId 是本次运行的唯一 id,run.readable 是 UI 消息块流;恢复时用 resumed.getReadable({ startIndex })。

持久化结果:在步骤中保存 Agent 输出,先通过 assertChatAgentParts 将通用 UIMessage["parts"] 收窄为应用的工具/数据类型,再进行插入。

参考资料:Workflow Development Kit、Workflow API Reference。其余细节(如具体收费、平台、效果)暂未提供。