# GitBook Assistant

<figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2FlzOUuOwM4Vffctmf3VHC%2F25_03_31_gitbook_assistant%402x.png?alt=media&#x26;token=914e435f-6305-41d8-b05c-23884ceba4e7" alt="GitBook Assistant"><figcaption><p>GitBook 助手</p></figcaption></figure>

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

可以把它看作一位产品专家，在用户最需要的地方和时间随时可用，服务于您所有的用户。

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

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

<p align="center"><button type="button" class="button primary" data-action="ask" data-icon="gitbook-assistant">提一个问题...</button></p>

## 启用 GitBook 助手 <a href="#how-do-i-use-gitbook-ai" id="how-do-i-use-gitbook-ai"></a>

要启用 GitBook 助手，请打开您网站的仪表板，导航到 **设置** 页面并从左侧菜单中选择 **AI 与 MCP** 。在这里，您可以从可用选项中启用 GitBook 助手。

### 添加建议问题

建议问题是在助手打开且没有活跃对话时显示的预写提示。它们帮助用户了解可以问什么，也可以帮助您引导用户找到有用的答案或工作流程。

您可以在您网站的 **设置**中添加建议问题，位于 **AI 与 MCP** 部分。

#### **建议问题的最佳实践：**

* 从真实的用户目标开始（设置、排查故障、集成）。
* 使用您的用户所使用的词语（避免内部代号）。
* 保持具体。“我该如何……？”比“告诉我关于……”更好。
* 涵盖不同意图：快速入门、操作指南、故障排查和参考。

{% hint style="info" %}
如果您要将助手嵌入到您的产品中，也可以在嵌入配置中动态设置建议。请参阅 [自定义嵌入](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/docs-site/embedding/configuration/customizing-docs-embed#adding-suggestions).
{% endhint %}

## 在已发布文档中使用 GitBook 助手 <a href="#how-do-i-use-gitbook-ai" id="how-do-i-use-gitbook-ai"></a>

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

* 按下 <kbd>⌘</kbd> + <kbd>I</kbd> 在 Mac 上，或 <kbd>Ctrl</kbd> + <kbd>I</kbd> 在电脑上
* 点击 **GitBook Assistant** <picture><source srcset="broken-reference" media="(prefers-color-scheme: dark)"><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2FRPCVZqnhQlwvRJbvEgM9%2Fgitbook-assistant.svg?alt=media&#x26;token=0506ce84-b363-481b-aefb-e0fa47357226" alt=""></picture> 按钮，位于 **提问或搜索……** 栏
* 在 **提问或搜索……** 栏中输入问题，并在菜单顶部选择“提问……”选项

## 将 GitBook 助手嵌入到您的产品中

您可以将 GitBook 助手直接嵌入到您的产品或网站中，让用户无需离开您的应用即可立即获得由 AI 驱动的帮助。助手可以作为 [Docs Embed](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/docs-site/embedding)的一部分进行嵌入，其中包括用于 AI 驱动聊天的 Assistant 选项卡、用于范围限定发现的 Search 选项卡，以及用于浏览文档的 Docs 选项卡。

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

* [**独立 script 标签**](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/docs-site/embedding/implementation/script) – 使用 `<script>` 标签快速设置
* [**Node.js/NPM**](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/docs-site/embedding/implementation/nodejs) – 服务端或构建时集成
* [**React 组件**](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/docs-site/embedding/implementation/react) – 预构建的 React 组件

### 其他助手嵌入指南：

* [在已验证身份的文档中使用嵌入式助手](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/docs-site/embedding/using-with-authenticated-docs) – 如果您的文档需要登录，这是必需的
* [自定义助手嵌入](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/docs-site/embedding/configuration/customizing-docs-embed) – 欢迎消息、操作和建议
* [创建自定义嵌入工具](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/docs-site/embedding/configuration/creating-custom-tools) – 将助手连接到您的 API
* [API 参考](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/docs-site/embedding/configuration/reference) – 所有可用的方法和事件

## 扩展 GitBook 助手的知识

GitBook 助手可以通过 [连接](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/ai-yu-sou-suo/connections) 并 [MCP 服务器](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/ai-yu-sou-suo/mcp-servers-for-published-docs).

如果您希望 GitBook 同步记录到您的站点中，可以使用连接；如果您想将 GitBook 助手接入自定义工具，则可以使用 MCP 服务器。

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th>最适合</th></tr></thead><tbody><tr><td><strong>连接</strong></td><td><p>连接最适合内容丰富的来源：</p><ul><li>GitHub 问题和讨论</li><li>Slack 或 Discord 对话</li><li>支持内容</li><li>外部文档、帮助中心和网站</li></ul></td></tr><tr><td><strong>MCP 服务器</strong></td><td><p>MCP 服务器最适合实时工具和数据：</p><ul><li>当前账户或产品状态</li><li>经常变动的内部系统</li><li>创建工单或提交错误等操作</li><li>您不想同步到 GitBook 的来源</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="添加连接" %}
{% stepper %}
{% step %}
**打开您网站的设置**

打开您网站的仪表板。然后选择 **设置** → **连接**.
{% endstep %}

{% step %}
**连接来源**

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

{% step %}
**向 GitBook 助手公开记录**

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

然后 GitBook 就可以在搜索和 GitBook 助手中使用这些记录。
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="添加 MCP 服务器" %}
{% stepper %}
{% step %}
**打开您网站的设置**

打开您网站的仪表板。然后选择 **设置** → **AI 与 MCP**.
{% endstep %}

{% step %}
**添加新服务器**

在 MCP 服务器表中，点击 **添加 MCP 服务器**.
{% endstep %}

{% step %}
**输入服务器详细信息**

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

然后配置 GitBook 必须在每次请求中发送的任何 HTTP 标头。
{% endstep %}
{% endstepper %}
{% endtab %}
{% endtabs %}