AI 助手可在 Pro 和 Enterprise 计划中使用,并在这些计划中默认启用。
关于 AI 助手
- 搜索并检索文档中的相关内容,提供准确的答案。
- 构建上下文,基于用户提问时正在查看的页面。
- 引用来源并提供可导航的链接,将用户直接带到引用的页面。
- 返回详细的 API 信息,在回答有关 API 的问题时提供方法、参数、请求体和来自 OpenAPI 规范的响应 schema。
- 生成可复制的代码示例,帮助用户根据文档实现解决方案。
- 支持多种模态,允许用户添加文本、图片和其他文件作为上下文。
索引工作原理
docs.json 中设置 seo.indexing: "all"。更多信息请参见隐藏页面。
AI 助手如何处理未知问题
AI 助手数据洞察
使内容适合 AI 处理
结构与组织
- 使用语义化标记。
- 为章节编写描述性标题。
- 创建合理的信息层级。
- 在文档中使用一致的格式。
- 在页面 frontmatter 中包含完整的元数据。
- 将长段落拆分为较短的段落。
上下文
- 在首次出现时定义专业术语和缩写。
- 提供关于功能和流程的充分概念性内容。
- 包含示例和使用场景。
- 交叉引用相关主题。
- 添加隐藏页面,提供用户不需要但 AI 助手可以参考的额外上下文。