概述

以 Markdown 格式查看

Ask Fern 是 Fern 的 AI 搜索功能,由 Claude 4.6 SonnetClaude 4.5 Haiku 提供支持,采用检索增强生成 (RAG) 技术。Ask Fern 会索引您的文档并为您的最终用户提供一个界面来提问和获取答案。响应中包含直接链接到源页面的引用。

Ask Fern 以侧面板的形式出现,适用于所有 Fern Docs 布局,并在用户在页面间导航时保持打开状态。响应会按版本、产品和角色进行过滤。

快速入门

1

在控制台中启用

打开 Fern Dashboard。导航至 Settings 选项卡,并在 Ask AI 卡片上点击 Enable

启用 Ask Fern 会触发内容的自动重新索引。这通常需要几分钟,但包含大量自定义组件的站点可能需要更长时间。此过程完成后,Ask Fern 侧面板将出现在您的站点上。

2

连接 Slack

将 Ask Fern 连接到 Slack,以便您的用户可以直接从聊天中提问。

功能

Ask Fern 内置了工具,帮助您了解用户如何与文档交互,并确保答案准确可信。

Fern Dashboard 中查看每日对话数量,深入了解单个对话,并导出为 CSV 格式。

控制台还会报告过去一周、一个月或一年的解决率——Ask Fern 返回带引用响应的对话百分比。助手无法找到相关信息的对话被计为未解决。

您可以使用查询参数直接从 URL 打开 Ask Fern(示例)或搜索对话框(示例)。这对于从帮助聊天组件、支持门户或入门流程进行链接非常有用。

# 使用提示打开 Ask Fern 侧面板
https://{{PAGE_URL}}?searchType={{SEARCH_TYPE}}&query={{QUERY1}}
# 使用查询打开搜索
https://{{PAGE_URL}}?query={{QUERY2}}
参数描述
query搜索查询或提示,URL 编码。
searchType可选。设置为 ai 以打开 Ask AI 面板,或省略以打开常规搜索。

Ask Fern 自动遵守在您的文档中配置的基于角色的访问控制 (RBAC) 设置。当用户查询 Ask Fern 时,他们只会从根据其分配角色有权访问的文档中获得答案。

这适用于所有级别,从整个部分到单个页面以及页面内的条件内容。