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

关于 AI 助手

AI 助手通过自然语言查询回答与文档相关的问题。它直接嵌入在你的文档站点中,用户可以快速找到答案,更顺利地使用你的产品。 AI 助手使用由 Claude Opus 4.5 驱动的 agentic RAG(检索增强生成)和工具调用功能。当用户提问时,AI 助手会:
  • 搜索和检索 文档中的相关内容,以提供准确的回答。
  • 引用来源 并提供可点击的链接,将用户直接带到被引用的页面。
  • 生成可复制的代码示例,帮助用户基于你的文档实现解决方案。
每条发送给 AI 助手的消息都会计入你当前套餐的消息额度。如果超出额度,额外消息将产生超额费用。你可以设置支出上限,或在达到消息额度时禁用 AI 助手。 你可以在控制台查看 AI 助手的使用情况,以了解用户行为和文档效果。你还可以导出并分析查询数据,以帮助识别:
  • 可能需要更好覆盖的常见问题。
  • 用户难以找到答案的内容空白。
  • 可以通过补充内容获益的热门主题。

配置 AI 助手

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

启用或停用 AI 助手

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

控件位置

选择 AI 助手在你的文档站点上的出现位置。可在页面底部的悬浮聊天气泡或搜索栏旁的按钮之间进行选择。
控制台中的 AI 助手位置设置面板,已选择“页面底部”选项。

设置分流邮箱

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

搜索站点

站点搜索功能当前处于测试版(beta)。要为你的文档站点启用该功能,请联系我们的销售团队
在响应处理部分中,配置 AI 助手在回答问题时可以搜索的站点,以获取更多上下文。
  • 站点必须是公开可访问的。
  • 依赖 JavaScript 才能加载内容的站点不受支持。
控制台中的 AI 助手搜索站点面板。AI 助手被配置为搜索 mintlify.com 和 mintlify.com/blog 这两个域名。
使用以下过滤语法,可以更精细地控制 AI 助手可以搜索的内容:
  • 域级过滤
    • example.com:仅搜索 example.com 这个域名
    • 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 助手开始对话。每种方式都会在文档页面右侧打开一个聊天面板。用户可以提出任何问题,AI 助手会在你的文档中搜索答案。如果找不到相关信息,AI 助手会告知无法回答该问题。

UI 放置方式

取决于你如何配置 AI 助手的展示方式,AI 助手可以显示为搜索栏旁边的按钮,或页面底部的工具栏。
亮色模式下的搜索栏和 AI 助手按钮。

搜索栏旁边的 AI 助手按钮。

亮色模式下的 AI 助手工具栏。

页面底部的 AI 助手按钮。

键盘快捷键

在 macOS 上使用快捷键 Command + I,在 Windows 上使用 Ctrl + I 打开 AI 助手对话面板。

高亮文本

在页面上选中一段文本,然后点击弹出的 Add to assistant 按钮,打开 AI 助手聊天面板,并将选中文本添加为 context。你可以将多个文本片段或代码块添加到 AI 助手的 context 中。
浅色模式下,高亮文本上方的 Add to assistant 按钮。

代码块

点击代码块中的 Ask AI 按钮,打开 AI 助手聊天面板,并将该代码块作为上下文添加。你可以将多个代码块或文本片段添加到 AI 助手的上下文中。
浅色模式下代码块中的 Ask AI 按钮。

URL

在 URL 末尾追加 ?assistant=open,即可在页面加载时打开 AI 助手。例如:https://mintlify.com/docs?assistant=open

让内容便于 AI 读取与理解

合理组织文档结构,以帮助 AI 助手提供准确、相关的答案。清晰的组织和完整的上下文信息既有利于人工读者,也能提升 AI 的理解。

结构与组织

  • 使用语义化标记。
  • 为各个部分撰写有描述性的标题。
  • 建立合理的信息层级结构。
  • 在整个文档中使用一致的格式。
  • 在页面 frontmatter 中包含完整的 metadata。
  • 使用语义化标记。

上下文

  • 在术语和缩写首次出现时进行明确定义。
  • 提供足够的功能和流程概念性介绍内容。
  • 包含示例和使用场景。
  • 交叉引用相关主题。
  • 添加带有额外 context 的隐藏页面,这些内容用户不需要查看,但 AI 助手可以引用。

导出并分析查询

从控制台中查看和导出查询,以了解人们如何与你的文档交互,并识别改进机会。通过分析查询,你可以从以下方面改进文档:
  • 识别内容空白,即高频查询未获得充分解答的地方。
  • 从查询中的主题和模式中发现用户行为模式和常见信息需求。
  • 为高流量页面的准确性和质量改进设定优先级。
你可以在控制台中查看查询,但为了获得更深入的洞察,我们建议导出包含查询、回答和来源的 CSV 文件,然后使用你常用的 AI 工具进行分析。
  1. 在控制台中访问 AI 助手页面
  2. 点击 Chat history
  3. 点击 Export to CSV
  4. 使用你常用的工具分析导出的数据。

示例分析提示

  • 概括查询中最常见的主题。
  • 列出没有引用任何来源的查询。
  • 概括查询中最常见的主题。

AI 助手洞察

通过“类别”和“聊天记录”两个视图,使用 AI 助手洞察来了解用户如何与您的文档交互。

类别

“Categories” 标签页使用 LLM 自动为会话归类。类别会显示话题或主题的摘要、上一次有人就该类别提问的时间,以及一段时间内关于该类别累计提出了多少个问题。 使用类别来识别常见话题、用户需求和行为模式,以及文档可能需要扩展或澄清的部分。 点击某个类别可查看与该类别相关的具体会话。然后你可以点击单个会话查看完整的聊天记录,包括用户的问题、AI 助手的回答以及引用的所有来源。

聊天记录

“聊天记录”标签页按时间顺序显示所有与 AI 助手的对话记录。点击任意消息即可查看完整对话,包括用户的问题、AI 助手的回答以及引用的所有来源。

故障排查

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