第七部分,开放 API 与 Chat SDK

流式工作流、恢复运行与对话流

处理 /v1/workflow/stream_run、stream_resume 和 /v1/workflows/chat 的事件、暂停与恢复。

核心认识

流式工作流在长任务和交互节点中持续返回事件。requires_action 表示流程等待外部输入,调用方要保存恢复所需标识,并防止同一暂停点重复恢复。

  • 事件消费者按节点和序号去重。
  • 暂停状态持久化到可靠存储。
  • 恢复请求校验用户和原任务归属。
  • 终止、超时和失败都释放客户端资源。

操作方法

  1. 调用 stream_run 并记录完整事件。
  2. 识别 requires_action 和恢复参数。
  3. 调用 stream_resume 并验证只恢复一次。
  4. 测试对话流、取消和断线重连。
text
POST /v1/workflow/stream_run
POST /v1/workflow/stream_resume
POST /v1/workflows/chat

验收与边界

  • 能说明本功能的输入、输出和权限边界。
  • 能用一个最小示例验证配置生效。
  • 真实生产数据和凭据未写入页面、仓库或日志。

官方资料

本页基于 Coze Studio 官方仓库和 Wiki 整理。原项目采用 Apache License 2.0,本站保留许可证、来源和修改说明。

内容授权与来源

本页含基于 coze-dev/coze-studio 官方文档的中文重组、翻译或说明,原资料采用 Apache License 2.0。本站已标记修改,不代表原作者背书。

Apache License 2.0来源和变更说明