Chat SDK 概述

扣子编程Chat SDK 是一个 JavaScript 库，集成了扣子编程 OpenAPI 的对话、文件上传等能力，便于开发者高效、便捷、快速地搭建一个聊天应用。集成扣子编程 Chat SDK 之后，用户可通过网页悬浮窗方式与 AI 应用对话。

版本说明

自 1.0.0-beta.4 版本开始，扣子编程提供全新的 Chat SDK 供开发者使用，改版后，Chat SDK 支持扣子编程 OpenAPI 的鉴权能力，开发者可按需选择是否鉴权及鉴权方式，例如指定个人访问令牌或 OAuth 访问密钥完成 Chat SDK 的鉴权。如果选择鉴权，开发者使用 Chat SDK 需传入访问密钥，扣子编程会识别不同用户身份，并保存各个用户的消息记录，即使用户更换终端设备或浏览器，仍可以通过访问关联的账户查看历史记录。全新版本的 Chat SDK 安装及使用方式，可查看安装并使用 Chat SDK。
1.0.0-beta.4 版本之前的 Chat SDK 为历史版本，开发者无需鉴权即可集成 SDK。历史版本 Chat SDK 仅提供基础的对话能力，安全性及扩展性较低，后续将不再维护和更新。历史版本的 Chat SDK 安装及使用方式，可查看（历史版本）Chat SDK。

效果预览

对应的示例代码可参考示例。

功能特性

除了基础的对话能力之外，Chat SDK 还提供多种定制化能力，支持多种鉴权模式，可调整聊天框的显示效果等多种配置。

说明

详细的功能点列表及配置方式可参考步骤五：自定义聊天界面与交互。

功能	说明
多形态支持	通过 Chat SDK，可以在你的应用程序中和扣子应用、智能体实时对话。
鉴权能力	通过扣子编程访问令牌进行 OpenAPI 的鉴权，支持个人访问密钥（PAT）、普通 OAuth 访问密钥及入驻渠道的 OAuth 访问密钥。
用户识别	和 AI 应用对话的用户身份是用户在开发者网站上的身份。开发者可以向 Chat SDK 提供 AI 应用用户的身份信息，也可以在 Chat SDK 的 UI 中显示不同的用户信息，包括头像、用户名、ID 等。
交互能力	Chat SDK 为开发者提供了以下两种打开聊天窗的方式。完全由 Chat SDK 接管，页面中会自动加载一个悬浮球，用户点击悬浮球会展示出聊天框。为开发者提供显示隐藏聊天框的能力，开发者可根据情况自主决定聊天框的显示和隐藏。
展示效果	支持调整聊天框中展示的用户信息、UI 效果、悬浮球效果、底部文案等配置，例如对话窗口的应用图标、悬浮球的展示或隐藏、自定义底部文案、开启或关闭上传能力等。
会话隔离	Chat SDK 支持会话隔离，使每个用户只能看到自己和智能体的对话历史。使用扣子 OAuth JWT 鉴权方式获取密钥时设置 session_name 即可，详细说明可参考如何实现会话隔离。

使用限制

Chat SDK 暂不支持触发器、文件盒子、卡片部分功能（按钮唤起插件或工作流）等能力。
Chat SDK 暂不支持问答节点的卡片效果，用户需要手动复制问答节点的选项，并发送给智能体。

费用说明

扣子不同版本账号的 Chat SDK 使用限额存在差异。

个人免费版：Chat SDK 的免费额度为每个账号 100 次对话。一旦累计对话次数超过免费额度，此账号将无法继续使用扣子 Chat SDK。免费额度不适用于通过扣子编程、其他发布渠道或直接通过 API 发起的请求。
个人付费版（进阶版、高阶版、旗舰版）、企业版（企业标准版、企业旗舰版）：不限制通过 Chat SDK 发起对话的频率和次数。通过 Chat SDK 发起对话，本质上是调用发起对话 API，根据输入和输出的 Token 数量扣减套餐中的积分，具体请参见计费概述。如果企业版中调用了方舟模型，会根据方舟模型 Token 消耗收取费用。