mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
83476f17a8
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
105 lines
4.9 KiB
Plaintext
105 lines
4.9 KiB
Plaintext
---
|
||
title: "Agent 建议"
|
||
description: "监控 Git 仓库中的变更，并接收文档更新建议。"
|
||
keywords: ["自动化", "文档缺口", "自我更新", "自我更新", "自动更新", "自动驾驶"]
|
||
---
|
||
|
||
<Note>
|
||
Agent 建议适用于 [Enterprise 方案](https://mintlify.com/pricing?ref=autopilot)。如需为你的组织启用该功能，请[联系我们的销售团队](mailto:gtm@mintlify.com)。
|
||
</Note>
|
||
|
||
你可以让 Agent 基于两个来源提出文档更新建议。
|
||
|
||
* **Pull Request 变更**：监控选定的 Git 仓库中的代码变更，这些变更可能需要更新文档。
|
||
* **AI 助手对话**：分析用户在你的文档站点中向 AI 助手提出的问题，以识别内容缺口。
|
||
|
||
当 Agent 识别出潜在的文档更新时，它会在你的控制台中创建一个建议，并附上创建拉取请求（PR；亦称“合并请求”/Merge Request）所需的上下文信息。
|
||
|
||
使用这些建议，可以在新功能发布时主动保持文档最新，或用来解决常见的用户问题。
|
||
|
||
<div id="prerequisites">
|
||
## 前置条件
|
||
</div>
|
||
|
||
在使用建议功能之前，你必须在你的组织中安装 [Mintlify GitHub 应用](/zh/deploy/github)。该应用必须能够访问你的文档存储库，以及至少一个在代码更改时需要更新文档的其他存储库。
|
||
|
||
<div id="configure-suggestions">
|
||
## 配置建议
|
||
</div>
|
||
|
||
在代理设置中配置代理需要监控哪些代码仓库，以及你希望如何接收通知。设置页面会显示代理正在监控的所有 GitHub 组织和代码仓库。
|
||
|
||
要打开代理设置：
|
||
|
||
1. 在控制台中点击 **Ask agent** 按钮以打开代理面板。
|
||
2. 点击 **Settings** 按钮。
|
||
<Frame>
|
||
<img src="/images/agent/dashboard-settings-light.png" alt="浅色模式下的设置按钮。" className="block dark:hidden" />
|
||
|
||
<img src="/images/agent/dashboard-settings-dark.png" alt="深色模式下的设置按钮。" className="hidden dark:block" />
|
||
</Frame>
|
||
|
||
<div id="monitor-repositories">
|
||
### 监控存储库
|
||
</div>
|
||
|
||
无论合并到哪个 branch，只要你为某个存储库启用了监控，智能体就会监控该存储库中所有已合并的拉取请求（PR）。名为 **Mintlify Autopilot** 的 GitHub 检查会在受监控存储库中的拉取请求上运行，分析这些拉取请求是否需要更新文档。当你合并了需要更新文档的拉取请求时，智能体会在你的控制台中创建一条建议。
|
||
|
||
<Note>
|
||
当你首次为某个存储库启用监控时，智能体会为过去 7 天内已合并的拉取请求创建建议。只有在该存储库还不存在任何建议时，才会进行这次回填操作。启用监控后，你可能会立即看到多条建议出现。
|
||
</Note>
|
||
|
||
如果你禁用监控，智能体会立即停止监控该存储库。该存储库已有的任何建议会继续保留在你的控制台中，直到你将其关闭。
|
||
|
||
<div id="conversation-insights">
|
||
### 对话洞察
|
||
</div>
|
||
|
||
如果你同时拥有 agent 和 AI 助手的访问权限，agent 会根据用户与 AI 助手的对话生成建议。
|
||
|
||
agent 会定期分析这些对话，当识别出表明文档内容缺失或不够清晰的问题模式时，就会生成相应的建议。
|
||
|
||
<div id="notifications">
|
||
### 通知
|
||
</div>
|
||
|
||
Agent 的建议始终显示在你的控制台中。你可以配置通知，在 Agent 创建新建议时通过电子邮件或 Slack 私信接收提醒。
|
||
|
||
<Tip>
|
||
如果你没有收到与建议相关的电子邮件通知，请检查垃圾邮件文件夹，并将邮箱地址 `notifications@mintlify.com` 添加到你的安全发件人列表中。
|
||
</Tip>
|
||
|
||
<div id="review-suggestions">
|
||
## 审阅建议
|
||
</div>
|
||
|
||
智能代理会在你的控制台中创建建议。每条建议都会显示触发该建议的拉取请求（PR；亦称“合并请求”/Merge Request）或 AI 助手对话主题、创建日期，以及建议的文档更新内容。
|
||
|
||
控制台中的 **Ask agent** 按钮会显示等待你审阅的建议数量。
|
||
|
||
<Frame>
|
||
<img src="/images/suggestions/count-light.png" alt="Ask agent 按钮在浅色模式下显示四条建议。" className="block dark:hidden" />
|
||
|
||
<img src="/images/suggestions/count-dark.png" alt="Ask agent 按钮在深色模式下显示四条建议。" className="hidden dark:block" />
|
||
</Frame>
|
||
|
||
<div id="create-pull-requests">
|
||
### 创建拉取请求
|
||
</div>
|
||
|
||
将这些建议作为 context 提供给 agent，以便其创建拉取请求。
|
||
|
||
1. 在控制台中点击 **Ask agent** 按钮以打开 agent 面板。
|
||
2. 点击 **Add to chat**。
|
||
3. 向 agent 提交该提示，以创建拉取请求。
|
||
|
||
<div id="dismiss-suggestions">
|
||
### 忽略建议
|
||
</div>
|
||
|
||
如果某条建议不需要更新文档，或者你已经根据它完成了相关更改，可以忽略它，将其从控制台中移除。
|
||
|
||
1. 在控制台中点击 **Ask agent** 按钮以打开 agent 面板。
|
||
2. 点击你想忽略的任意建议旁边的 **Dismiss** 按钮。
|
||
|
||
该建议会立即从你的控制台中移除，且无法恢复。 |