第七部分，开放 API 与 Chat SDK

Chat SDK 调试、构建与嵌入

配置 Coze Studio Chat SDK，运行调试、二次开发、构建发布，并通过 WebChatClient 嵌入网页。

高级 / 13 分钟 / 第 48 篇

核心认识

Coze Studio Chat SDK 包含调试工程、状态管理和聊天核心。生产嵌入时令牌应由后端短期签发，浏览器不能长期持有 Personal Access Token。

  • Agent 和应用模式使用不同标识。
  • 调试配置放入本地环境文件且不提交。
  • 构建产物发布到自有静态资源服务或受控 npm 包。
  • 开源版不一定支持商业版所有语音能力。

操作方法

  1. 发布 Agent 或应用到 Chat SDK 渠道。
  2. 配置本地测试标识和令牌。
  3. 运行开发服务器并验证聊天。
  4. 构建 libs，配置安全鉴权并嵌入目标页面。
bash
cd frontend/packages/studio/open-platform/chat-app-sdk
npm run dev
npm run build
javascript
new CozeWebSDK.WebChatClient({
  config: { type: 'bot', bot_id: 'BOT_ID', isIframe: false },
  auth: {
    type: 'token',
    token: window.runtimeToken,
    onRefreshToken: async () => fetchShortLivedToken(),
  },
  userInfo: { id: 'CURRENT_USER', nickname: 'User' },
})

验收与边界

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

官方资料

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

内容授权与来源

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

Apache License 2.0，来源和变更说明