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

​
关于 AI 助手

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

​
配置 AI 助手

AI 助手在 Pro 和 Custom 方案中默认启用。 在你的控制台管理 AI 助手。点击Configuration以启用或禁用 AI 助手、配置响应处理、添加默认问题，并设置费用上限。
控制台中的 AI 助手工具栏。以橙色矩形突出显示 Configuration 按钮。

​
启用或停用 AI 助手

在文档站点上切换 AI 助手的状态，以启用或停用 AI 助手。
控制台中的 AI 助手状态开关。

​
设置分流邮箱

在响应处理部分，启用 AI 助手将未解答的问题转交给你的支持团队。指定一个电子邮箱地址，当 AI 助手无法回答用户的问题时会提供给用户。
控制台中的 AI 助手分流面板。助手分流已开启，且将 support@mintlify.com 设为分流邮箱。

​
搜索站点

站点搜索目前处于测试阶段。要为你的文档站点启用该功能，请联系销售团队。
在“响应处理”部分，配置 AI 助手在回答问题时可检索的站点，以获取更多上下文。
  • 站点必须对公众可访问。
  • 需要依赖 JavaScript 加载的站点暂不支持。
控制台中的 AI 助手“搜索站点”面板。AI 助手被配置为搜索 mintlify.com 和 mintlify.com/blog。
使用以下过滤语法，以更精细地控制 AI 助手的可检索范围：
  • 域级过滤
    • example.com: 仅搜索 example.com domain
    • docs.example.com: 仅搜索 docs.example.com 子域
    • *.example.com: 搜索 example.com 的所有子域
  • 路径级过滤
    • docs.example.com/api: 搜索 /api 子路径下的所有页面
  • 多模式
    • 可添加多个条目以覆盖站点的不同部分

​
添加示例问题

通过添加示例问题，帮助用户借助 AI 助手开始提问。在“搜索建议”部分，最多可添加三个示例问题。
控制台中的搜索建议面板。已将“What is an OpenAPI spec?”配置为示例问题。

​
设定支出上限

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

​
使用 AI 助手

用户可以通过三种方式使用 AI 助手：
  • 键盘快捷键：Command + I（Windows 为 Ctrl + I）
  • 搜索栏旁的 Assistant 按钮 浅色模式下的搜索栏与助手按钮。
  • 在 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. 使用你常用的工具分析导出的数据。

示例分析提示

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

​
故障排查

如果在特定浏览器中看不到 AI 助手的界面，您可能需要向 EasyList 提交误判报告。使用 EasyList Cookies List 的浏览器（如 Brave 和 Comet）有时会屏蔽 AI 助手或其他界面元素。EasyList Cookies List 包含一条按域名生效的规则，会在特定域名上隐藏固定元素以拦截 Cookie 横幅，而该规则会误伤合法的界面组件。请向 EasyList 提交误判报告，请求移除该规则。过滤列表更新后，问题将对所有用户一并解决。
⌘I