For the complete documentation index, see llms.txt. This page is also available as Markdown.

AI 助手

AI 助手可为用户提供准确、具上下文关联的答案,这些答案来自您的整个知识库,而不仅仅是您的文档

GitBook Assistant
GitBook 助手

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

可以把它看作是一位产品专家,在用户最需要的时间和地点随时可供所有用户使用。

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

AI 助手使用 AI 额度。您只会为相关答案扣除积分。

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

GitBook Assistant

配置 AI 助手

要配置 AI 助手,请打开 自定义 网站侧边栏中的 AI 助手。在这里,你可以启用助手,并自定义其说明、欢迎消息和建议问题。

添加自定义说明

自定义说明可调整助手的语气,并添加产品特定的知识或术语,从而让其回答始终与你的整体风格一致。

自定义说明可优化助手的语气和知识。它们不能覆盖其内置的安全护栏。

自定义欢迎消息

欢迎消息是访客在没有活动对话时打开助手时看到的第一条内容。可用它来设定预期,或引导用户进入特定工作流程。

添加建议问题

建议问题是在助手以无活动对话状态打开时显示的预写提示。它们可帮助用户了解自己可以问什么,并帮助你将用户引导到有用的答案或工作流程。

建议问题的最佳实践:

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

  • 使用你的用户会使用的词语(避免内部代号)。

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

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

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

选择助手的显示位置

下方 外观,设置 位置 以选择读者访问助手的方式:

  • 侧边栏 (默认):AI 助手聊天,完整的聊天体验。适用于 Ultimate 网站方案。

  • 搜索框:AI 助手问答,与关键词搜索结果并排显示的行内答案。适用于 Essential 和 Ultimate 网站方案。

助手问候语仅适用于侧边栏位置,因此在以下情况下会隐藏: 位置 设置为 搜索框.

在已发布文档中使用 AI 助手

读者如何访问助手取决于其显示位置。

侧边栏位置

用户可以通过三种方式访问 GitBook 助手:

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

  • 点击 GitBook 助手 按钮旁边的 “提问或搜索…” 栏

  • 在以下栏中输入问题: “提问或搜索…” 栏,然后在菜单顶部选择“提问…”选项

搜索框位置

当 位置 设置为 搜索框时,用户可以直接在 “提问或搜索…” 页面顶部的栏中,与关键词结果并列提问。

他们可以直接点击打开它,或者按下 ⌘ + K 在 Mac 上,或 Ctrl + K 在电脑上。

除了汇总答案外,用户还会看到一个可展开的部分,其中显示助手用于生成答案的来源,以及他们可以点击的相关问题作为后续提问。

助手会根据你的文档站点内容,以及你通过 连接.

搜索已发布文档

无论是否启用助手,每个站点都会自动启用关键词搜索。

你的用户可以在文档站点内搜索关键词,并快速跳转到整个站点中的特定页面或页面部分。

将 AI 助手嵌入到你的产品中

你可以将 GitBook 助手直接嵌入到产品或网站中,让用户无需离开应用即可立即获得 AI 驱动的帮助。助手可以作为以下内容的一部分嵌入: 文档嵌入,其中包括用于 AI 聊天的“助手”选项卡、用于限定范围搜索的“搜索”选项卡,以及用于浏览文档的“文档”选项卡。

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

其他助手嵌入指南:

扩展 AI 助手的知识

AI 助手可以通过以下方式使用外部知识: 连接 和 MCP 服务器.

当你希望 GitBook 将记录同步到你的网站时,可以使用连接;当你希望将 AI 助手接入自定义工具时,可以使用 MCP 服务器。

连接

最适合

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

  • GitHub 问题和讨论

  • Slack 或 Discord 对话

  • 支持内容

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

MCP 服务器

最适合

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

  • 当前账户或产品状态

  • 经常变化的内部系统

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

  • 你不想同步到 GitBook 的来源

1

打开你网站的设置

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

2

连接一个来源

选择一种来源类型。然后对其进行授权,或输入要导入的 URL。

3

向 AI 助手公开记录

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

GitBook 随后可以在搜索和 AI 助手中使用这些记录。

1

打开你网站的设置

打开你的网站仪表板。然后选择 设置 → AI 与 MCP.

2

添加新服务器

在 MCP 服务器表中,点击 添加 MCP 服务器.

3

输入服务器详情

为服务器命名。添加其 URL。

然后配置 GitBook 必须在每个请求中发送的任何 HTTP 标头。

最后更新于

这有帮助吗?