GitBook Assistant

GitBook Assistant 为用户提供来自整个知识库的准确、具上下文的信息回答——不只是你的文档

此功能适用于 终极网站方案.

GitBook 助手

GitBook Assistant 使用自然语言为你的用户提供关于文档的快速、准确答案。它会根据你的用户进行个性化设置，可以嵌入到你的网站或产品中，并可在已发布文档的侧边栏中使用。

可以把它看作一个面向所有用户的产品专家，在他们最需要的地点和时间随时提供帮助。

该助手使用代理式检索，基于用户当前页面、之前阅读的页面以及之前的对话来理解查询上下文。

试着在下面的框中向助手提问：

启用 GitBook Assistant

要启用 GitBook Assistant，请打开你站点的仪表板，进入 设置 页面并选择 AI & MCP 在左侧菜单中。你可以在这里从可用选项中启用 GitBook Assistant。

添加推荐问题

推荐问题是在助手打开且没有活动对话时显示的预写提示。它们可以帮助用户了解自己可以问什么，也可以帮助你将用户引导到有用的答案或工作流。

你可以在你站点的 设置中添加推荐问题，位于 AI & MCP 部分。

推荐问题的最佳实践：

• 从真实的用户目标开始（设置、故障排除、集成）。

• 使用用户常用的词语（避免内部代号）。

• 保持具体。“我该如何……？”比“告诉我关于……？”更好。

• 覆盖不同意图：快速入门、操作指南、故障排除和参考。

如果你要将助手嵌入到你的产品中，你也可以在嵌入配置中动态设置建议。参见 自定义嵌入.

在已发布文档中使用 GitBook Assistant

用户可以通过三种方式访问 GitBook Assistant：

• 按 ⌘ + I 在 Mac 上，或 Ctrl + I 在 PC 上

• 点击 GitBook Assistant 按钮，位于 提问或搜索… 栏旁边

• 在 提问或搜索… 栏中输入问题，并在菜单顶部选择“Ask…”选项

在你的产品中嵌入 GitBook Assistant

你可以将 GitBook Assistant 直接嵌入到你的产品或网站中，让用户无需离开你的应用即可即时获得由 AI 驱动的帮助。该助手可以作为 文档嵌入的一部分进行嵌入，其中包含用于 AI 聊天的 Assistant 选项卡、用于范围化发现的 Search 选项卡，以及用于浏览文档的 Docs 选项卡。

选择适合你技术栈的嵌入方式：

• 独立 script 标签 – 使用 <script> 标签快速设置

• Node.js/NPM – 服务端或构建时集成

• React 组件 – 预构建的 React 组件

其他 Assistant 嵌入指南：

• 在已认证文档中使用嵌入式 Assistant – 如果你的文档需要登录，这是必需的

• 自定义 Assistant 嵌入 – 欢迎消息、操作和建议

• 创建自定义嵌入工具 – 将 Assistant 连接到你的 API

• API 参考 – 所有可用的方法和事件

扩展 GitBook Assistant 的知识

GitBook Assistant 可以通过以下方式使用外部知识： 连接 和 MCP 服务器.

当你希望 GitBook 同步记录到你的站点时，可以使用连接；当你希望把 GitBook Assistant 接到自定义工具时，可以使用 MCP 服务器。

连接

最适合

连接最适合内容密集型来源：

• GitHub issues 和 discussions

• Slack 或 Discord 对话

• 支持内容

• 外部文档、帮助中心和网站

MCP 服务器

最适合

MCP 服务器最适合实时工具和数据：

• 当前账户或产品状态

• 经常变化的内部系统

• 创建工单或提交 bug 等操作

• 你不想同步到 GitBook 的来源

添加连接

1

打开你站点的设置

打开你的网站仪表板。然后选择 设置 → 连接.

2

连接来源

选择一种来源类型。然后授权它，或输入要导入的 URL。

3

向 GitBook Assistant 公开记录

开启 在搜索 / 助手中公开 为该连接。

然后 GitBook 就可以在搜索和 GitBook Assistant 中使用这些记录。

添加 MCP 服务器