> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-mintlify-add-hello-world-quickstart-48843.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 文档助手

> 帮助用户更快找到答案，顺利使用你的产品

<Info>
  文档助手会在[Pro 和 Custom 计划](https://mintlify.com/pricing?ref=assistant)中自动启用。
</Info>

<div id="about-the-assistant">
  ## 关于文档助手
</div>

文档助手通过自然语言查询回答与你的文档相关的问题。它直接嵌入在你的文档站点中，为用户提供即时的上下文帮助。

文档助手采用由 Claude Sonnet 4 驱动、支持工具调用的智能型 RAG（检索增强生成）。当用户提问时，文档助手会：

* **搜索并检索** 你的文档中的相关内容，提供准确答案。
* **引用来源** 并提供可导航的链接，直达被引用的页面。
* **生成可复制的代码示例**，帮助用户基于你的文档实现解决方案。

发送给文档助手的每条消息都会计入你的套餐消息额度。超出额度的消息将产生超额费用。你可以设置支出上限，或在达到消息额度时禁用文档助手。

你可以在控制台查看文档助手的使用情况，以了解用户行为和文档效果。还可导出并分析查询数据，以识别：

* 需要更充分覆盖的常见问题。
* 用户难以找到答案的内容缺口。
* 适合补充内容的热门主题。

<div id="configuring-the-assistant">
  ## 配置文档助手
</div>

文档助手在 Pro 和 Custom 方案中默认启用。你可以在[控制台](https://dashboard.mintlify.com/products/assistant/settings)管理文档助手，包括启用或禁用、配置回复处理方式，以及设置花费上限。

<div id="assistant-status">
  ### 文档助手状态
</div>

通过切换状态，在你的文档站点上启用或禁用文档助手。

<div id="assistant-deflection">
  ### 文档助手分流
</div>

启用文档助手在无法回答时将用户引导至你的支持团队。提供一个电子邮箱地址，供文档助手在无法作答的问题场景下告知用户联系。

<div id="search-sites">
  ### 搜索站点
</div>

<Note>
  站内搜索目前为测试版。要为你的文档站点启用该功能，请[联系销售团队](mailto:gtm@mintlify.com)。
</Note>

配置文档助手在回答问题时可检索的站点，以获取额外上下文。

* 站点必须可公开访问。
* 不支持依赖 JavaScript 才能加载内容的站点。

在配置外部站点时，你可以使用以下过滤语法：

* **域级过滤**
  * `example.com`：仅搜索 `example.com` 域
  * `docs.example.com`：仅搜索 `docs.example.com` 子域
  * `*.example.com`：搜索 `example.com` 的所有子域
* **路径级过滤**
  * `docs.example.com/api`：搜索 `/api` 子路径下的所有页面
* **多个匹配规则**
  * 添加多条规则以覆盖站点的不同部分

<div id="spend-limit">
  ### 支出上限
</div>

设置支出上限以控制在达到消息配额后将采取的措施。默认情况下，即使你已用尽消息配额，文档助手仍会继续回答用户问题，这将产生超额费用。

在 [Assistant Configurations](https://dashboard.mintlify.com/products/assistant/settings) 页面中的 **Billing** 选项卡，你可以为超出配额的助手消息设置支出上限。达到支出上限后，文档助手将被禁用，直至你的消息配额重置。

你也可以设置用量提醒，在达到支出上限的特定百分比时通过电子邮件接收通知。

<div id="using-the-assistant">
  ## 使用文档助手
</div>

用户可以通过三种方式使用文档助手：

* **键盘快捷键**：<kbd>?</kbd> 或 <kbd>Command</kbd> + <kbd>I</kbd>（Windows 为 <kbd>Ctrl</kbd> + <kbd>I</kbd>）
* 搜索栏旁的**文档助手按钮**
  <img
    src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/K9uomxeMDdJnUp_m/images/assistant/assistant-button-light.png?fit=max&auto=format&n=K9uomxeMDdJnUp_m&q=85&s=41376849ae410ef7dbb1a9ef8fd2a2ab"
    className="block dark:hidden rounded-2xl border border-gray-100 shadow-lg"
    style={{
  width: '268px',
  height: 'auto',
  }}
    alt="浅色模式下的搜索栏和文档助手按钮。"
    width="1806"
    height="322"
    data-path="images/assistant/assistant-button-light.png"
  />
  <img
    src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/K9uomxeMDdJnUp_m/images/assistant/assistant-button-dark.png?fit=max&auto=format&n=K9uomxeMDdJnUp_m&q=85&s=a8d025b59d044d539b4296e46504bcbd"
    className="hidden dark:block rounded-2xl border border-white/10 shadow-lg"
    style={{
  width: '268px',
  height: 'auto',
  }}
    alt="深色模式下的搜索栏和文档助手按钮。"
    width="1806"
    height="324"
    data-path="images/assistant/assistant-button-dark.png"
  />
* 在 **URL** 后追加 `?assistant=open`，页面加载时会自动打开文档助手。例如，[https://mintlify.com/docs?assistant=open](https://mintlify.com/docs?assistant=open)。

以上任一方式都会在文档右侧打开聊天面板。用户可以提出任何问题，文档助手会在你的文档中检索答案；如果未找到相关信息，文档助手会提示无法回答该问题。

<div id="making-content-ai-ingestible">
  ## 让内容便于 AI 理解与摄取
</div>

组织你的文档，帮助文档助手提供准确且相关的答案。清晰的结构与完整的上下文既利于人类读者，也有助于 AI 理解。

<Card title="结构与组织">
  * 使用语义化标记。
  * 为各部分撰写有描述性的标题。
  * 建立清晰合理的信息层级。
  * 在文档中保持一致的格式。
  * 在页面前置区块中包含完整的元数据。
  * 将长段文字拆分为更短的段落。
</Card>

<Card title="上下文">
  * 首次出现时定义专有术语和首字母缩略词。
  * 提供足够的功能与流程的概念性说明。
  * 包含示例和使用场景。
  * 交叉引用相关主题。
  * 添加[隐藏页面](/zh/guides/hidden-pages)，提供用户不必查看、但文档助手可参考的补充上下文。
</Card>

<div id="exporting-and-analyzing-queries">
  ## 导出与分析查询
</div>

在仪表盘中审阅并导出查询，以了解用户如何与文档交互并识别改进机会。以下是查询分析可帮助改进文档的方式：

* 识别内容空白：找出高频查询却缺乏充分答案的领域。
* 从查询的主题与模式中洞察用户行为与常见信息需求。
* 优先对高流量页面进行准确性与质量优化。

你可以在[仪表盘](https://dashboard.mintlify.com/products/assistant)中查看查询，但为获得更深入的洞察，我们建议导出包含查询、回复与来源的 `CSV` 文件，并使用你偏好的 AI 工具进行分析。

1. 在仪表盘中前往 [assistant 页面](https://dashboard.mintlify.com/products/assistant)。
2. 选择 **Export to CSV**。
3. 使用你偏好的工具分析导出的数据。

<Card title="示例分析提示">
  * 概括查询中最常见的主题。
  * 列出所有未引用来源的查询。
  * 查找不成功交互的模式。
</Card>