反馈功能需要 Pro 或 Enterprise 套餐。
- Page ratings:用户的点赞和点踩评分,按页面分组。
- Detailed feedback:包含书面内容的反馈,例如评论、代码片段反馈和智能体反馈。
- 识别成功的内容:获得最多正面反馈的页面显示了您文档中效果良好的部分。
- 确定改进优先级:获得最多负面反馈的页面表明哪些内容可能需要关注。
- 采取行动:根据用户的直接反馈进行文档更新。
启用反馈
如果您在
docs.json 文件中禁用了遥测,则无法启用反馈功能。- 导航到 General 设置页面。
- 在 Feedback 部分,启用您想要的反馈类型。
- Thumbs rating:简单的点赞/点踩投票,用于评估用户对页面的整体满意度。
- Edit suggestions:允许用户对您的文档提出编辑建议。仅适用于公开的仓库。
- Raise issues:允许用户直接从您的网站创建 issue。仅适用于公开的仓库。
- Contextual feedback:关于页面内容的自由格式反馈。可以选择启用电子邮件收集,允许用户在提交反馈时提供其电子邮件地址。
- Code snippet feedback:专门针对代码片段的反馈。
查看反馈
页面评分
详细反馈
- Sentiment:显示正面、负面或两者兼有的反馈。
- Type:显示 Comments、Agent feedback、Code blocks 或其任意组合。
忽略反馈
智能体反馈
智能体反馈处于测试版,可能会发生变化。
智能体反馈的工作原理
submit_feedback 工具,该工具需要页面路径和问题描述。
网页搜索和网页获取工具不会将智能体连接到 Search MCP 服务器。智能体必须连接到该服务器,才能发现并调用
submit_feedback 工具。.md 和 .mdx 扩展名以及您站点的基础路径不会影响匹配。如果没有匹配的页面，submit_feedback 工具会返回错误，且该提交不会被记录。
Mintlify 会将每次被接受的提交记录为指定页面的负面反馈。反馈将与人类反馈一起显示在仪表板中。
通过 API 获取智能体反馈
source=agent 进行筛选,仅返回智能体反馈。
智能体反馈响应包括:
comment:智能体提交的反馈文本。path:反馈所针对页面的路径。