跳转到主要内容
AI 助手可在 Pro 和 Enterprise 计划中使用,并在这些计划中默认启用。

关于 AI 助手

AI 助手通过自然语言查询回答有关你文档的问题。用户可以在你的文档站点上使用 AI 助手,快速找到答案,即使不知道在哪里查找也能成功使用你的产品。 AI 助手使用带工具调用的 Agentic RAG(检索增强生成)。当用户提问时,AI 助手会:
  • 搜索并检索文档中的相关内容,提供准确的答案。
  • 构建上下文,基于用户提问时正在查看的页面。
  • 引用来源并提供可导航的链接,将用户直接带到引用的页面。
  • 返回详细的 API 信息,在回答有关 API 的问题时提供方法、参数、请求体和来自 OpenAPI 规范的响应 schema。
  • 生成可复制的代码示例,帮助用户根据文档实现解决方案。
  • 支持多种模态,允许用户添加文本、图片和其他文件作为上下文。

索引工作原理

AI 助手索引你发布的文档和 API 规范,以准确回答问题。当你发布更改时,AI 助手会立即索引新增、更新或删除的内容。AI 助手不会索引草稿分支或预览部署。 默认情况下,AI 助手不会索引隐藏页面。要在 AI 助手的索引中包含隐藏页面,请在 docs.json 中设置 seo.indexing: "all"。更多信息请参见隐藏页面

AI 助手如何处理未知问题

AI 助手仅基于你文档中的信息回答问题。如果搜索后找不到相关信息,它会回复没有足够的信息来回答。 你可以设置转接邮箱,让 AI 助手在无法回答用户问题时提供你的支持邮箱。即使文档没有涵盖用户的特定问题,这也能为用户提供一条出路。

AI 助手数据洞察

使用 AI 助手数据洞察来了解用户如何与你的文档交互,并发现改进机会。 AI 助手页面显示本月至今的使用趋势。在分析页面查看更详细的洞察。

使内容适合 AI 处理

合理组织你的文档结构,帮助 AI 助手提供准确、相关的答案。清晰的组织和全面的上下文既有利于人类读者,也有利于 AI 理解。

结构与组织

  • 使用语义化标记。
  • 为章节编写描述性标题。
  • 创建合理的信息层级。
  • 在文档中使用一致的格式。
  • 在页面 frontmatter 中包含完整的元数据。
  • 将长段落拆分为较短的段落。

上下文

  • 在首次出现时定义专业术语和缩写。
  • 提供关于功能和流程的充分概念性内容。
  • 包含示例和使用场景。
  • 交叉引用相关主题。
  • 添加隐藏页面,提供用户不需要但 AI 助手可以参考的额外上下文。