第七部分,开放 API 与 Chat SDK

会话与消息 API

创建会话、列出会话、查看消息和清除上下文,并理解会话生命周期与分页。

核心认识

会话保存连续交互上下文,消息记录具体输入输出。服务端应保存自己的用户到 conversation_id 映射,并校验用户只能访问所属会话。

  • 创建会话后持久化标识和所属用户。
  • 列表接口设置分页和最大页大小。
  • 消息内容按隐私要求控制保留时间。
  • 清除上下文是业务动作,需要权限和确认。

操作方法

  1. 调用创建会话接口并保存返回标识。
  2. 发送测试对话后列出消息。
  3. 验证另一个用户无法读取该会话。
  4. 测试清除上下文和重复请求。
text
POST /v1/conversation/create
GET /v1/conversations
POST /v1/conversation/message/list
POST /v1/conversations/:conversation_id/clear

验收与边界

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

官方资料

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

内容授权与来源

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

Apache License 2.0来源和变更说明