助手会在 Pro 与 Custom 方案 中自动启用。
关于助手
- 搜索并检索 文档中的相关内容,提供准确答案。
- 引用来源 并提供可跳转的链接,将用户直接带到被引用页面。
- 生成可复制的代码示例,帮助用户基于文档实现解决方案。
- 需要更充分覆盖的常见问题。
- 用户难以找到答案的内容缺口。
- 值得通过新增内容加以强化的热门主题。
配置助手
助手状态
助手分流
搜索站点
站点搜索目前为测试版。要在你的文档站点启用它,请联系销售团队。
- 站点必须对公众开放访问。
- 不支持依赖 JavaScript 才能加载内容的站点。
- 域级过滤
example.com
:仅搜索example.com
域docs.example.com
:仅搜索docs.example.com
子域*.example.com
:搜索example.com
的所有子域
- 路径级过滤
docs.example.com/api
:搜索/api
子路径下的所有页面
- 多重模式
- 可添加多个条目以覆盖站点的不同部分
支出上限
使用助手
- 键盘快捷键:? 或 Command + I(Windows 上为 Ctrl + I)
- 搜索栏旁的助手按钮
- 在 URL 末尾追加
?assistant=open
,页面加载时将自动打开助手。例如,https://mintlify.com/docs?assistant=open。
让内容便于 AI 理解与索引
结构与组织
- 使用语义化标记。
- 为各部分撰写具描述性的标题。
- 建立合乎逻辑的信息层级。
- 在整个文档中保持一致的格式。
- 在页面 frontmatter 中包含完整的元数据。
- 将长文本拆分为更短的段落。
上下文
- 首次出现时定义专有术语和首字母缩略词。
- 提供关于功能与流程的充分概念性内容。
- 包含示例和使用场景。
- 交叉引用相关主题。
- 添加用户不必阅读、但助手可引用的隐藏页面,以补充上下文。
导出并分析查询
- 识别内容空白,即高频查询却缺乏充分解答的部分。
- 从查询的主题与模式中洞察用户行为与常见信息需求。
- 优先优化高流量页面的准确性与质量。
CSV
文件,使用你常用的 AI 工具进行分析。
- 在仪表盘中前往助手页面。
- 选择 Export to CSV。
- 使用你常用的工具分析导出的数据。
示例分析提示
- 概括查询中最常见的主题。
- 列出未引用来源的查询。
- 发现不成功交互中的模式。