第七部分,开放 API 与 Chat SDK

Chat API 与流式事件

调用 /v3/chat,处理 created、in_progress、message 和 completed 等流式事件。

核心认识

Chat API 可以返回流式事件。客户端必须按事件类型维护状态,处理网络中断、重复事件和最终完成,并在服务端验证用户身份和参数。

  • 请求明确 bot_id、user_id 和 additional_messages。
  • 流式解析按事件边界处理,不能假设一个网络块就是一个事件。
  • 以 completed 或明确错误作为结束。
  • 使用请求标识避免网络重试导致重复任务。

操作方法

  1. 从非流式最小请求验证参数。
  2. 切换流式模式并记录事件序列。
  3. 实现取消、超时和断线处理。
  4. 统计输入输出用量和最终状态。
bash
curl --request POST "$COZE_API_HOST/v3/chat" \
  --header "Authorization: Bearer $COZE_ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"bot_id":"BOT_ID","user_id":"USER_ID","stream":true,"additional_messages":[{"role":"user","content":"你好","content_type":"text"}]}'

验收与边界

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

官方资料

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

内容授权与来源

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

Apache License 2.0来源和变更说明