跳转到主要内容
AI 助手会在 Pro 和 Custom 方案 上自动启用。

关于 AI 助手

AI 助手通过自然语言 query 回答与你的文档相关的问题。它直接嵌入你的文档站点,为用户提供即时的上下文帮助。 该助手基于由 Claude Sonnet 4 驱动、支持工具调用的代理式 RAG(检索增强生成)。当用户提问时,助手会:
  • 搜索并检索 你的文档中相关内容,提供准确答案。
  • 引用来源 并提供可跳转链接,将用户直接带到被引用页面。
  • 生成可复制的代码示例,帮助用户依据你的文档实现解决方案。
每条发送给助手的消息都会计入你的套餐消息额度。若超出额度,额外消息将产生超量费用。你可以设置支出上限,或在达到消息额度时禁用助手。 你可以在控制台查看助手的使用情况,以了解用户行为和文档成效。导出并分析 query 数据,以帮助识别:
  • 可能需要更好覆盖的常见问题。
  • 用户难以找到答案的内容缺口。
  • 适合补充更多内容的热门主题。

配置 AI 助手

AI 助手在 Pro 和 Custom 方案中默认启用。你可以在控制台管理 AI 助手,包括启用或禁用、配置回复处理方式,以及设置费用上限。

AI 助手状态

切换 AI 助手状态,在你的文档站点上启用或停用 AI 助手。

AI 助手分流

启用 AI 助手在无法解答时将问题转交给你的支持团队。提供一个电子邮箱地址,AI 助手会在无法回答用户提问时把该地址提供给用户。

搜索站点

站点搜索目前为测试版。要为你的文档站点启用此功能,请联系销售团队
配置 AI 助手在回答问题时可搜索的站点,以获取更多 context。
  • 站点必须可公开访问。
  • 依赖 JavaScript 才能加载的站点不受支持。
在配置外部站点时,你可以使用以下过滤语法:
  • 域级过滤
    • example.com:仅搜索 example.com domain
    • docs.example.com:仅搜索 docs.example.com 子域
    • *.example.com:搜索 example.com 的所有子域
  • 路径级过滤
    • docs.example.com/api:搜索 /api 子路径下的所有页面
  • 多个模式
    • 添加多个条目以覆盖站点的不同部分

支出上限

设置支出上限,以控制在用完消息配额后的处理方式。默认情况下,即使你用完消息配额,AI 助手仍会继续回答用户问题,从而产生超额费用。 Assistant Configurations 页面的 Billing 标签页中,你可以为超出配额的 AI 助手消息设置支出上限。达到支出上限后,AI 助手将被禁用,直至你的消息配额重置。 你还可以设置用量提醒,在达到支出上限的一定百分比时接收电子邮件通知。

使用 AI 助手

用户可以通过三种方式使用 AI 助手:
  • 使用键盘快捷键Command + I(Windows 为 Ctrl + I
  • 点击搜索栏旁的助手按钮 浅色模式下的搜索栏和助手按钮。
  • URL 末尾追加 ?assistant=open,页面加载时会打开 AI 助手。例如,https://mintlify.com/docs?assistant=open
上述方式都会在文档右侧打开聊天面板。用户可以提出任何问题,AI 助手会在你的文档中搜索答案。如果未找到相关信息,AI 助手会回复其无法回答该问题。

让内容便于 AI 处理

合理组织文档,帮助 AI 助手提供准确、相关的答案。清晰的结构与充分的上下文既利于读者,也便于 AI 理解。

结构与组织

  • 使用语义化标记。
  • 为各部分撰写描述性标题。
  • 建立清晰、合乎逻辑的信息层级。
  • 在整个文档中保持一致的格式。
  • 在页面 frontmatter 中包含完善的 metadata。
  • 将长段文字拆分为更短的段落。

Context

  • 首次出现时定义特定术语和首字母缩略词。
  • 提供关于功能和流程的充分概念性内容。
  • 包含示例和用例。
  • 交叉引用相关主题。
  • 添加包含额外上下文的隐藏页面,这些内容用户不需要,但 AI 助手可以引用。

导出并分析查询

在你的控制台中审阅并导出查询,了解用户如何与文档交互并发现改进机会。分析查询可以帮助改进文档的方式包括:
  • 识别内容缺口,即高频查询得到的答案不充分。
  • 从查询的主题与模式中发现用户行为与常见信息需求。
  • 为高流量页面的准确性与质量改进设定优先级。
你可以在控制台中查看查询,但若想获得更深入的洞察,我们建议导出包含查询、回复和来源的 CSV 文件,并使用你常用的 AI 工具进行分析。
  1. 前往控制台中的assistant 页面
  2. 选择 Export to CSV
  3. 使用你常用的工具分析导出的数据。

示例分析提示

  • 概括查询中最常见的主题。
  • 列出未引用来源的查询。
  • 查找不成功交互中的模式。
I