diff --git a/ai/markdown-export.mdx b/ai/markdown-export.mdx index 7d284da7b..c46aa63a2 100644 --- a/ai/markdown-export.mdx +++ b/ai/markdown-export.mdx @@ -54,11 +54,9 @@ If you prefer to omit the spec from Markdown output, set `markdown.schema` to `f ## Agent feedback -If you enable [agent feedback](/optimize/feedback#agent-feedback), Mintlify appends an `` block to each page's Markdown export that tells agents how to submit feedback about the page's content. +If you enable [agent feedback](/optimize/feedback#agent-feedback), agents can submit structured feedback about a page by posting to your documentation's `/feedback` endpoint with the page path and feedback text. -Agents submit feedback by posting to the endpoint with the page path and feedback text. - -Use agent feedback to improve your pages for agents based on what they find incorrect, outdated, or confusing. +Prompt agents to submit feedback in your own instructions or system prompts. Use agent feedback to improve your pages for agents based on what they find incorrect, outdated, or confusing. ## Keyboard shortcut diff --git a/es/ai/markdown-export.mdx b/es/ai/markdown-export.mdx index e067a1881..701c2c3f9 100644 --- a/es/ai/markdown-export.mdx +++ b/es/ai/markdown-export.mdx @@ -65,11 +65,9 @@ Si prefieres omitir la especificación de la salida en Markdown, establece `mark ## Comentarios de agentes -Si habilitas los [comentarios de agentes](/es/optimize/feedback#agent-feedback), Mintlify añade un bloque `` a la exportación Markdown de cada página que indica a los agentes cómo enviar comentarios sobre el contenido de la página. +Si habilitas los [comentarios de agentes](/es/optimize/feedback#agent-feedback), los agentes pueden enviar comentarios estructurados sobre una página publicando en el endpoint `/feedback` de tu documentación con la ruta de la página y el texto del comentario. -Los agentes envían comentarios publicando en el endpoint con la ruta de la página y el texto del comentario. - -Usa los comentarios de agentes para mejorar tus páginas para agentes en función de lo que encuentren incorrecto, desactualizado o confuso. +Indica a los agentes que envíen comentarios en tus propias instrucciones o prompts del sistema. Usa los comentarios de agentes para mejorar tus páginas en función de lo que encuentren incorrecto, desactualizado o confuso.
## Atajo de teclado diff --git a/es/optimize/feedback.mdx b/es/optimize/feedback.mdx index 7a1b6f3ce..cd307c929 100644 --- a/es/optimize/feedback.mdx +++ b/es/optimize/feedback.mdx @@ -126,11 +126,20 @@ Estos comentarios aparecen en el [dashboard de comentarios](https://dashboard.mi Debes habilitar los comentarios de agentes en tu dashboard para recopilarlos. -Una vez habilitados, Mintlify añade un bloque `` con instrucciones y el endpoint para enviar comentarios cuando un agente obtiene una página mediante la exportación Markdown. +Una vez habilitados, los agentes pueden enviar comentarios mediante una solicitud `POST` al endpoint de comentarios de tu documentación en `https://tu-dominio.com/feedback`. Los comentarios aparecen en el dashboard junto a los comentarios humanos. -Los agentes envían comentarios al endpoint con la ruta de la página y el texto del comentario. Los comentarios aparecen en el dashboard junto a los comentarios humanos. +Indica a los agentes que envíen comentarios incluyendo el endpoint y el formato del payload en tus propias instrucciones o prompts del sistema. Por ejemplo: -El endpoint de comentarios siempre está disponible en `https://tu-dominio.com/feedback` como una solicitud `POST`, incluso si no añades las instrucciones a la exportación Markdown, por lo que puedes indicar a los agentes que envíen comentarios manualmente publicando en el endpoint. +```text +Si encuentras documentación incorrecta, desactualizada o confusa en esta página, +envía comentarios mediante una solicitud POST a https://tu-dominio.com/feedback +con el siguiente payload JSON: + +{ + "path": "/ruta/de/la/pagina", + "feedback": "Descripción del problema" +} +```
### Habilitar comentarios de agentes diff --git a/fr/ai/markdown-export.mdx b/fr/ai/markdown-export.mdx index dfa4672b1..0deb41858 100644 --- a/fr/ai/markdown-export.mdx +++ b/fr/ai/markdown-export.mdx @@ -65,11 +65,9 @@ Si vous préférez omettre la spécification de la sortie Markdown, définissez ## Retours des agents
-Si vous activez les [retours des agents](/fr/optimize/feedback#agent-feedback), Mintlify ajoute un bloc `` à l'export Markdown de chaque page indiquant aux agents comment soumettre des retours sur le contenu de la page. +Si vous activez les [retours des agents](/fr/optimize/feedback#agent-feedback), les agents peuvent soumettre des retours structurés sur une page en envoyant une requête à l'endpoint `/feedback` de votre documentation avec le chemin de la page et le texte du retour. -Les agents soumettent des retours en envoyant une requête au endpoint avec le chemin de la page et le texte du retour. - -Utilisez les retours des agents pour améliorer vos pages en fonction de ce que les agents trouvent incorrect, obsolète ou confus. +Invitez les agents à soumettre des retours dans vos propres instructions ou prompts système. Utilisez les retours des agents pour améliorer vos pages en fonction de ce que les agents trouvent incorrect, obsolète ou confus.
## Raccourci clavier diff --git a/fr/optimize/feedback.mdx b/fr/optimize/feedback.mdx index 382acab47..76eb86d3e 100644 --- a/fr/optimize/feedback.mdx +++ b/fr/optimize/feedback.mdx @@ -127,11 +127,20 @@ Ces retours apparaissent dans le [dashboard de feedback](https://dashboard.mintl Vous devez activer les retours des agents dans votre dashboard pour les collecter. -Une fois activé, Mintlify ajoute un bloc `` contenant les instructions et l'endpoint pour soumettre des retours lorsqu'un agent récupère une page via l'export Markdown. +Une fois activé, les agents peuvent soumettre des retours en envoyant une requête `POST` à l'endpoint de retours de votre documentation à l'adresse `https://votre-domaine.com/feedback`. Les retours apparaissent dans le dashboard aux côtés des retours humains. -Les agents envoient des retours à l'endpoint avec le chemin de la page et le texte du retour. Les retours apparaissent dans le dashboard aux côtés des retours humains. +Invitez les agents à soumettre des retours en incluant l'endpoint et le format de la charge utile dans vos propres instructions ou prompts système. Par exemple : -L'endpoint de retours est toujours disponible à l'adresse `https://votre-domaine.com/feedback` en tant que requête `POST`, même si vous n'ajoutez pas les instructions à l'export Markdown. Vous pouvez donc inviter les agents à soumettre des retours manuellement en envoyant une requête à l'endpoint. +```text +Si vous rencontrez une documentation incorrecte, obsolète ou confuse sur cette page, +soumettez un retour en envoyant une requête POST à https://votre-domaine.com/feedback +avec la charge utile JSON suivante : + +{ + "path": "/chemin/vers/la/page", + "feedback": "Description du problème" +} +```
### Activer les retours des agents diff --git a/optimize/feedback.mdx b/optimize/feedback.mdx index 53f150464..b2a73f56d 100644 --- a/optimize/feedback.mdx +++ b/optimize/feedback.mdx @@ -117,11 +117,20 @@ This feedback appears in the [feedback dashboard](https://dashboard.mintlify.com You must enable agent feedback in your dashboard to collect it. -Once enabled, Mintlify appends an `` block with instructions and the endpoint for submitting feedback when an agent fetches a page using Markdown export. +Once enabled, agents can submit feedback by sending a `POST` request to your documentation's feedback endpoint at `https://your-domain.com/feedback`. The feedback appears in the dashboard alongside human feedback. -Agents post feedback to the endpoint with the page path and feedback text. The feedback appears in the dashboard alongside human feedback. +Prompt agents to submit feedback by including the endpoint and payload format in your own instructions or system prompts. For example: -The feedback endpoint is always available at `https://your-domain.com/feedback` as a `POST` request, even if you don't add the instructions to the Markdown export. You can prompt agents to submit feedback manually by posting to the endpoint. +```text +If you encounter incorrect, outdated, or confusing documentation on this page, +submit feedback by sending a POST request to https://your-domain.com/feedback +with the following JSON payload: + +{ + "path": "/path/to/page", + "feedback": "Description of the issue" +} +``` ### Enable agent feedback diff --git a/zh/ai/markdown-export.mdx b/zh/ai/markdown-export.mdx index 004a73eac..63d6b6c86 100644 --- a/zh/ai/markdown-export.mdx +++ b/zh/ai/markdown-export.mdx @@ -65,11 +65,9 @@ curl -L -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export ## Agent 反馈
-如果你启用了 [Agent 反馈](/zh/optimize/feedback#agent-feedback),Mintlify 会在每个页面的 Markdown 导出中附加一个 `` 块,告知 Agent 如何提交关于页面内容的反馈。 +如果你启用了 [Agent 反馈](/zh/optimize/feedback#agent-feedback),Agent 可以通过向你文档的 `/feedback` 端点发送页面路径和反馈文本来提交关于页面的结构化反馈。 -Agent 通过向端点发送页面路径和反馈文本来提交反馈。 - -使用 Agent 反馈根据 Agent 发现的不正确、过时或令人困惑的内容来改进你的页面。 +在你自己的指令或系统提示中提示 Agent 提交反馈。使用 Agent 反馈根据 Agent 发现的不正确、过时或令人困惑的内容来改进你的页面。
## 键盘快捷键 diff --git a/zh/optimize/feedback.mdx b/zh/optimize/feedback.mdx index 26a86dbd2..a26b4bc88 100644 --- a/zh/optimize/feedback.mdx +++ b/zh/optimize/feedback.mdx @@ -127,11 +127,19 @@ boost: 3 你必须在控制台中启用 Agent 反馈功能才能收集此类反馈。 -启用后,当 Agent 通过 Markdown 导出获取页面时,Mintlify 会附加一个包含指令和提交反馈端点的 `` 块。 +启用后,Agent 可以通过向你文档的反馈端点 `https://你的域名.com/feedback` 发送 `POST` 请求来提交反馈。反馈会与人工反馈一同显示在控制台中。 -Agent 通过向端点发送页面路径和反馈文本来提交反馈。反馈会与人工反馈一同显示在控制台中。 +在你自己的指令或系统提示中包含端点和载荷格式,以提示 Agent 提交反馈。例如: -反馈端点始终以 `POST` 请求的形式在 `https://你的域名.com/feedback` 上可用,即使你没有将指令添加到 Markdown 导出中。因此你可以提示 Agent 通过直接向端点发送请求来手动提交反馈。 +```text +如果你在此页面上发现不正确、过时或令人困惑的文档, +请向 https://你的域名.com/feedback 发送 POST 请求并提交以下 JSON 载荷: + +{ + "path": "/path/to/page", + "feedback": "问题描述" +} +```
### 启用 Agent 反馈