AI 聊天
每个 Jamdesk 文档站点都内置 AI 聊天助手,访客可提问并获取附有文档引用的回答。
每个 Jamdesk 站点都内置聊天助手,可根据文档回答访客的问题。它会找到相关章节并将其发送给 Claude。回答会以流式方式返回,并附上源页面链接。所有套餐默认启用聊天功能,无需额外付费。
聊天助手的实际效果如下:
使用场景
集成 API 的开发者询问 “如何对请求进行身份验证?”,即可获得准确的操作步骤和代码示例,以及源页面链接。
工作原理
每次构建期间,Jamdesk 都会将页面拆分为多个章节,并将其存储为可搜索的嵌入向量。
点击“Ask AI”按钮(或按 Cmd+I / Ctrl+I)即可在任意页面打开聊天面板。
Jamdesk 会检索相关章节,并将其作为上下文发送给 Claude。回答会以流式方式返回,并附上指向源页面的引用链接。
功能
| 功能 | 详情 |
|---|---|
| 流式响应 | 实时显示回答 |
| 引用链接 | 每条回答都链接到所依据的文档页面 |
| 消歧 | 问题对应多个主题时,AI 会询问访客指的是哪个主题 |
| 对话上下文 | 保留 10 条消息的历史记录,并按浏览器标签页分别保存 |
| 推荐问题 | 根据文档自动生成,也可以在 docs.json 中自行设置 |
| 键盘快捷键 | 按 Cmd+I / Ctrl+I 切换,按 Escape 关闭 |
| Markdown 渲染 | 在回答中渲染代码块、表格和列表 |

屏幕截图显示的是英文界面。
配置
聊天功能无需配置。只有在需要更改推荐问题、重命名按钮、更改图标或关闭聊天功能时,才需要在 docs.json 中添加 chat 配置块。所有设置都有默认值。
{
"chat": {
"enabled": true,
"starterQuestions": [
"How do I get started?",
"What API endpoints are available?"
]
}
}| 字段 | 类型 | 默认值 | 说明 |
|---|---|---|---|
enabled | boolean | true | 设为 false 可从站点移除 Ask AI 按钮、聊天面板和键盘快捷键 |
starterQuestions | string[] | 自动生成 | 面板打开时显示的最多 4 个问题(每个问题 5–200 个字符)。省略时会根据文档自动生成;设为 [] 则不显示问题 |
label | string | 页面所用语言中的 "Ask AI" | 替换聊天按钮、面板标题和搜索快捷入口中的 "Ask AI"。最多 40 个字符。适用于所有语言。 |
icon | string | sparkles | Font Awesome 图标名称、图片 URL 或项目中的图片路径。Font Awesome 图标会采用强调色。图片则按原样显示。请选择在深色背景上清晰可见的图标。 |
推荐问题
推荐问题是在访客输入内容前显示在聊天面板中的一键提示。如果 docs.json 中没有 starterQuestions,Jamdesk 会在每次构建时根据文档生成推荐问题。文档内容更新时,推荐问题也会随之更新。
在 starterQuestions 数组中列出自定义问题。你可以借此优先展示支持团队经常收到的问题:
{
"chat": {
"starterQuestions": [
"How do notifications work?",
"Tell me more about analytics"
]
}
}最多可设置 4 个推荐问题,每个问题为 5 至 200 个字符。将 starterQuestions 设为空数组([])即可不显示问题。
自定义名称和图标
聊天按钮、面板标题和搜索快捷入口默认显示“Ask AI”,并使用闪光图标。设置 label 和 icon 即可根据产品自定义:
{
"chat": {
"label": "Acme Assistant",
"icon": "/images/assistant.svg"
}
}站点的所有语言都会使用相同的标签。像 robot 这样的 icon 值是 Font Awesome 图标名称。以 http://、https:// 或 / 开头,或以图片扩展名结尾的值会被视为图片。
关闭聊天
所有套餐默认启用聊天功能。将 enabled 设为 false 即可关闭。此设置会移除 Ask AI 按钮、聊天面板以及 Cmd+I / Ctrl+I 快捷键:
{
"chat": {
"enabled": false
}
}关闭聊天功能不会影响搜索。AI 聊天和搜索是彼此独立的功能。
限制
| 限制 | 值 |
|---|---|
| 消息长度上限 | 2,000 个字符 |
| 响应长度上限 | 2,048 个 token |
| 速率限制 | 每位访客在每个站点每 60 秒最多 10 个请求 |
| 对话历史 | 每个标签页保留 10 条消息 |
| 推荐问题 | 最多 4 个 |
聊天功能可用于自定义域名。/_chat 端点与站点同源,适用于任何提供文档内容的域名。
Jamdesk 会在每次构建期间将页面拆分为多个章节,并为每个章节存储一个向量嵌入。访客提问后,系统会在文档中执行混合搜索(结合关键词匹配和语义相似度),找出最相关的章节。Jamdesk 会将这些章节作为上下文发送给 Claude,并指示其仅根据提供的文档作答。Jamdesk 会将 Claude 回答中的页面引用与检索到的章节进行匹配,从而提取引用。
