文档中心

AgentKit

ChatKit 参考

ChatKit 概述

什么是 ChatKit

ChatKit 是面向 React 18 或 React 19 应用的 Agent 对话界面开发套件，以 npm 包 @volcengine/chatkit 发布。它主要为您提供对话界面、会话运行时和后端协议适配器，适用于在业务页面中嵌入单个 Agent 助手，或构建带会话列表的完整对话应用。

请求地址、鉴权方式、会话目录及历史持久化由接入方根据后端能力实现。ChatKit 仅在页面运行期间将当前对话保存在内存中，不会将其持久化到浏览器存储，也不会在未配置上报通道时主动发送业务数据。了解更多

适用场景

场景	推荐方式	说明
完整对话应用	使用 useChatSessions 管理多个会话，并单独渲染 SessionList。	适合独立的 Agent 产品，需要新建、切换和管理多个会话。
页面内嵌助手	使用 useChatRuntime 管理单个会话。	适合工单、文档、运营后台等页面中的侧边栏助手。
自有协议后端	基于 @volcengine/chatkit/core 实现适配器。	适合后端协议不属于内置协议，但希望复用 ChatKit 界面与运行时。

核心概念

接入 ChatKit 时，您主要需要理解适配器、配置、插槽与渲染器等概念。它们分别解决后端协议、内置功能配置和业务内容扩展问题。了解更多

概念	说明	使用方式
适配器（adapter）	内置多种协议的适配器，用于在后端协议与 ChatKit 运行时之间转换请求和事件。	创建一个稳定实例，交给 useChatSessions 或 useChatRuntime。
配置（settings）	设置语言、占位文字、欢迎语等配置值。	只包含配置值，不放函数或界面组件。
功能（features）	开启、关闭或实现附件、赞踩、语音等内置功能。	可传 false 关闭功能，或传入业务函数启用功能。
插槽（slots）	在顶栏、消息区、输入区等固定位置加入业务组件。	按界面位置选择插槽。
渲染器（renderers）	自定义某类内容的展示方式，例如业务卡片、工具调用结果。	按数据类型、工具名称或错误码注册渲染器。

内置适配器

ChatKit 内置 ADK、A2A、OpenAI 兼容接口、Hermes 和 Mock 适配器。后端使用其他协议时，可以基于 ChatKit 的适配器契约自行实现，并通过一致性测试验证行为，详情可参考写一个新的适配器。

协议	引入路径	说明
OpenAI 兼容接口	@volcengine/chatkit/adapters/openai	OpenAI 兼容的 Chat Completions 接口，适用于提供流式 Chat Completions API 的模型服务。
ADK	@volcengine/chatkit/adapters/adk	Agent Development Kit（ADK）run_sse 接口，适用于通过 SSE 事件流返回 Agent 执行过程的 ADK 服务。
A2A	@volcengine/chatkit/adapters/a2a	A2A（JSON-RPC over SSE）接口，适用于提供 A2A 流式 Agent 接口的服务。
Hermes	@volcengine/chatkit/adapters/hermes	Hermes 后端 API，适用于提供 Hermes 后端 API 的 Agent 服务。
Hermes Dashboard	@volcengine/chatkit/adapters/hermes-gateway	Hermes Dashboard 协议接口，适用于支持审批与追问的 Hermes Dashboard 服务。
DeepSeek Harness（DSH）	@volcengine/chatkit/adapters/dsh	DSH Web 远程协议，适用于支持审批与追问的 DeepSeek Harness 服务。
Codex	@volcengine/chatkit/adapters/codex	Codex app-server 接口，适用于支持审批与追问的 Codex 服务。
OpenCode	@volcengine/chatkit/adapters/opencode	OpenCode server 接口，适用于支持审批与追问的 OpenCode 服务。

内置功能

ChatKit 内置了 Agent 对话应用常用的交互能力。了解更多

说明

功能入口会根据适配器能力、features 配置和当前运行状态按需显示。后端未实现对应能力时，界面不会提供无法执行的操作。

功能分类	内置功能	作用
回答生成	流式输出、思考过程、工具调用	回答边生成边显示，并将思考过程和工具调用展示为可折叠步骤，便于用户了解执行进度。
回答操作	停止生成、复制、重新生成、编辑后重发	允许用户中止运行、复用回答，或从指定消息重新发起一轮执行。
会话管理	多会话并行、会话切换、SessionList	用户切换会话后，其他已打开会话仍可继续接收回答；应用可使用内置组件展示会话目录。
消息输入	附件、语音输入、@ 提及、/ 指令、划词追问、推荐问题	支持上传业务文件、语音转文字、引用对象，通过指令快速触发预设能力，并在合适场景下发起划词追问或展示推荐问题。
审批与追问	HITL 审批、用户追问	当 Agent 执行需要人工确认或补充信息时，引导用户在界面内完成审批和继续追问。
按需导入	OpenUI、Artifact Preview	用于按需展示结构化界面片段或产物预览，方便在聊天过程中查看扩展结果。
主题样式	亮色主题、暗色主题、样式变量	适配不同页面背景和品牌视觉，并保持消息、输入框和运行状态的一致样式。

环境与限制

接入 ChatKit 前，请确保您的环境满足其版本与兼容性要求。了解更多

说明

若您的项目未显式安装 React，安装 ChatKit 时会自动安装 React 19。

最近更新时间：2026.10.23 09:23:31

这个页面对您有帮助吗？

有用

无用