> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/zh/ai-for-your-readers/connections.md).

# 连接

将外部来源连接到 AI 助手和 GitBook Agent

连接可将外部内容引入你的文档站点。

已连接的内容可以显示在 [AI 助手](https://gitbook.com/docs/documentation/zh/ai-for-your-readers/gitbook-ai-assistant.md)中，让访客能够根据你发布的所有内容而不仅仅是文档获得解答。某些连接还可以帮助 GitBook 生成变更请求并找出 [内容缺口](https://gitbook.com/docs/documentation/zh/analytics/content-gaps.md)。此外，连接 MCP 服务器后，访客还可以直接在文档中执行任务。

在站点侧边栏中，前往 **设置 → 连接**.

### 可用连接

你可以连接支持平台、开发者社区和其他内容来源：

* Intercom、Zendesk、Freshdesk、Front、HubSpot、Zoho Desk 和 Pylon
* GitHub Discussions 和 GitHub Issues
* YouTube、一个网站或一个 MCP 服务器

### 连接如何运作

{% stepper %}
{% step %}

#### 连接一个来源

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

{% hint style="info" %}
如果你连接的是 YouTube，请输入频道 ID，而不是频道名称。

频道名称不适用于此来源。

在 YouTube Studio 中，打开 **设置** → **频道** → **高级设置**.

复制 **频道 ID**.

如果你的频道 URL 中包含 `/channel/`，请复制其后的部分 `/channel/`.
{% endhint %}

每个连接都会从该来源创建一个记录流，例如问题、讨论、工单、对话、页面或视频。
{% endstep %}

{% step %}

#### GitBook 会同步记录

保存连接后，GitBook 会开始同步该来源中的记录。

在连接列表中，你可以查看同步状态、记录数量和上次同步时间。

已连接的 URL 默认每天刷新一次。你也可以从网站的 **设置** → **连接**.
{% endstep %}

{% step %}

#### 选择记录的使用方式

对于每个连接，你都可以选择其记录是否显示在搜索和 AI Assistant 中，以及是否帮助 GitBook 生成变更请求。

你还可以调整该连接的搜索排名，以提高或降低其记录的优先级。
{% endstep %}
{% endstepper %}

### 检查你的连接

“连接”页面分为三个部分： **连接数据源** 以添加连接器， **连接** 以管理已有连接器，以及 **记录** 以浏览 GitBook 已摄取的内容。

#### 连接表

每个已连接来源都有一行：

| 列    | 显示内容                            |
| ---- | ------------------------------- |
| 来源   | 连接器，以及它所指向的账户、频道或 URL。          |
| 状态   | 最近一次同步是否完成。                     |
| 记录   | 按该来源自身的单位计算的贡献项数量——页面、视频、讨论或对话。 |
| 搜索   | 连接的搜索排名提升值。当 **在搜索/助手中显示** 已关闭。 |
| 上次同步 | 该连接上次刷新的时间距今多久。                 |

#### 记录

“ **记录** ”列表按时间倒序显示 GitBook 通过所有连接导入的各个条目。每条记录都包含标题、来源连接、GitBook 处理时间，以及指向原始内容的链接。

大型网站会积累数千条记录，因此列表采用分页显示。启用 **在搜索和助手中显示**之前，可先用它确认来源导入的内容是否符合预期：例如，网站连接导入的是博客文章，而你想要的是产品页面，这里会最先显示这一问题。

### 连接设置

编辑连接时，你可以配置以下选项：

#### 标签

使用 **“标签”** 为连接设置一个清晰易懂的名称。

这会让来源在连接列表中更容易识别，尤其是在你连接了多个仓库、网站或频道时。

#### 自动生成变更请求

{% hint style="warning" %}
自动生成变更请求处于 Beta 阶段。

请参阅 [内容缺口](https://gitbook.com/docs/documentation/zh/analytics/content-gaps.md) 了解 GitBook 如何识别文档中的缺漏。
{% endhint %}

开启 **自动生成变更请求** 让 GitBook 从此连接的记录中学习，并建议文档更新。

GitBook 可以使用这些记录来创建变更请求，并附上建议的更改，供你的团队审阅。

#### 在搜索 / 助手中公开

开启 **在搜索/助手中显示** 让访客能够搜索此连接中的记录，并使用这些记录回答问题。

这使已连接的内容能够出现在你网站的 AI 驱动搜索体验以及 AI Assistant 的回复中。

{% hint style="warning" %}
启用 **在搜索/助手中显示** 使任何能够访问该站点的人都可以访问此连接中的记录——如果该站点对外共享，外部访客也能访问。
{% endhint %}

#### 搜索排名提升

使用 **搜索排名提升** ，在搜索中提高或降低此连接中记录的优先级。

如果此来源应更频繁地出现，请提高该值。如果此来源应比你的主要文档权重更低，请降低该值。

### 连接器详情

本部分中的所有连接器都可以为 [AI 助手](https://gitbook.com/docs/documentation/zh/ai-for-your-readers/gitbook-ai-assistant.md)提供上下文。GitBook Agent 可以使用已解析的记录来识别 [内容缺口](https://gitbook.com/docs/documentation/zh/analytics/content-gaps.md) 并建议更新文档。

#### Intercom

GitBook 会索引已解决的对话，这些对话至少有一条来自人工或 AI 支持代理的回复。它不会索引未关闭、未解决或垃圾对话。

要连接 Intercom，请使用具有对对话读取权限的 API 密钥。你可以控制其权限范围和到期时间。

#### Zendesk

GitBook 会索引已解决的对话，这些对话至少有一条来自人工或 AI 支持代理的回复。它不会索引未关闭、未解决或垃圾对话。

要连接 Zendesk，请输入您的 Zendesk 子域名，例如 `gitbook.zendesk.com`。您还需要一个具有对话读取权限的 API 密钥。您可以控制其权限范围和有效期。

#### Pylon

GitBook 会索引已解决的对话，这些对话至少有一条来自人工或 AI 支持代理的回复。它不会索引未关闭、未解决或垃圾对话。

要连接 Pylon，请使用具有对对话读取权限的凭据。

#### GitHub Discussions

GitBook 会索引已解决的讨论，这些讨论至少有一条回复。它不会索引未解决或垃圾讨论。

要连接 GitHub Discussions，请使用具有对讨论读取权限的凭据。

#### GitHub Issues

GitBook 会索引已解决的问题。它不会索引打开的、未解决的或垃圾问题。

要连接 GitHub Issues，请使用具有对问题读取权限的凭据。

#### 这些连接器存储的数据

GitBook 仅存储对话、讨论或问题。我们不存储元数据或个人信息。

GitBook 在存储前会删除敏感信息。我们不会在索引记录中存储敏感信息。

### 数据保留和隐私

#### GitBook 会索引什么？

GitBook 会为连接中的内容建立索引，并将其用于搜索、变更请求及其他内容驱动型功能。我们从连接中索引的每个项目都称为 **记录。** 记录包括 Intercom 工单、Freshdesk 工单、网站页面等。

我们使用记录来建议内容更改，并为在 GitBook 中运行的代理提供额外上下文。

只要来源保持连接，我们就会保留这些记录。如果你移除连接，我们会删除所有存储的记录。我们不会删除任何使用这些记录作为上下文生成的内容，也不会从任何已存储的 AI 对话日志中移除记录内容。

例如，你可能连接了 Intercom，而 GitBook 会根据一张已关闭的 Intercom 支持工单建议一项文档修改。如果随后你移除 Intercom 连接，我们所有针对 Intercom 存储的数据都会被删除，但这些变更请求仍会保留。

#### 常见问题

<details>

<summary>你们关于 PII 的政策是什么？</summary>

通常，GitBook 只请求那些可用作上下文的源字段（有关每个来源的更多具体信息，请参见连接器页面）。

当我们摄取一条记录时，会先经过 PII 遮盖流程。第一步是在内存中遮盖任何电子邮件、电话号码、地址和其他个人信息。

随后，我们使用第三方 LLM 对该记录进行第二步 PII 处理。这是一项符合 ZDR 的不存储请求，不会存储在我们的第三方服务器上，也不会用于任何训练。

在进行此预处理期间，PII 可能会在我们的服务器上保留几分钟，但我们只会存储经过后处理的记录。

</details>

<details>

<summary>你们会将数据发送给任何第三方吗？</summary>

在完成最初的内部 PII 遮盖后，我们会使用第三方来遮盖 PII。

在创建变更请求和回复用户问题时，我们也会在第三方提供商中使用已脱敏的记录内容。

例如，在使用 GitBook Agent 编写内容时，代理可能会将外部记录中的内容作为额外上下文。

</details>

<details>

<summary>GitBook 是否会将数据用于任何模型训练，无论是自行训练还是通过第三方？</summary>

不会，我们不会使用记录数据进行训练，并且会与我们的第三方提供商核实，确保他们也不会这样做。

</details>

<details>

<summary>我可以限制 GitBook 拉取哪些记录吗？</summary>

连接器的具体要求和已建立索引的记录列于 [连接器详情](#connector-details).

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/documentation/zh/ai-for-your-readers/connections.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
