diff --git a/ai/markdown-export.mdx b/ai/markdown-export.mdx index 7d284da7b..9670fd227 100644 --- a/ai/markdown-export.mdx +++ b/ai/markdown-export.mdx @@ -52,14 +52,6 @@ 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. - -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. - ## Keyboard shortcut Press Command + C (Ctrl + C on Windows) to copy a page as Markdown to your clipboard. diff --git a/es/ai/markdown-export.mdx b/es/ai/markdown-export.mdx index e067a1881..6261ab3a3 100644 --- a/es/ai/markdown-export.mdx +++ b/es/ai/markdown-export.mdx @@ -61,16 +61,6 @@ 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. - -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. -
## Atajo de teclado
diff --git a/es/optimize/feedback.mdx b/es/optimize/feedback.mdx index 7a1b6f3ce..fe8fb8eda 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` a `https://tu-dominio.com/feedback` con la ruta de la página y el texto del comentario. 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 compartiendo con ellos el endpoint y el formato del payload. 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 Ejemplo de prompt +Si encuentras documentación incorrecta, desactualizada o confusa en este sitio, +envía comentarios mediante una solicitud POST a https://tu-dominio.com/feedback +con el siguiente cuerpo JSON: + +{ + "path": "/current-page-path", + "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..92190ea48 100644 --- a/fr/ai/markdown-export.mdx +++ b/fr/ai/markdown-export.mdx @@ -61,16 +61,6 @@ 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. - -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. -
## Raccourci clavier
diff --git a/fr/optimize/feedback.mdx b/fr/optimize/feedback.mdx index 382acab47..4fe6fd789 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` à `https://votre-domaine.com/feedback` avec le chemin de la page et le texte du retour. 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 leur communiquant l'endpoint et le format de la charge utile. 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 Exemple d'invite +Si vous trouvez sur ce site une documentation incorrecte, obsolète ou confuse, +envoyez un retour via une requête POST à https://votre-domaine.com/feedback +avec le corps JSON suivant : + +{ + "path": "/current-page-path", + "feedback": "Description du problème" +} +```
### Activer les retours des agents diff --git a/optimize/feedback.mdx b/optimize/feedback.mdx index 53f150464..92108cf62 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 `https://your-domain.com/feedback` with the page path and feedback text. 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 sharing the endpoint and payload format with them. 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 Prompt example +If you find documentation on this site that is incorrect, outdated, or confusing, +submit feedback by sending a POST request to https://your-domain.com/feedback +with the following JSON body: + +{ + "path": "/current-page-path", + "feedback": "Description of the issue" +} +``` ### Enable agent feedback diff --git a/zh/ai/markdown-export.mdx b/zh/ai/markdown-export.mdx index 004a73eac..02096cb47 100644 --- a/zh/ai/markdown-export.mdx +++ b/zh/ai/markdown-export.mdx @@ -61,16 +61,6 @@ curl -L -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export } ``` -
- ## Agent 反馈 -
- -如果你启用了 [Agent 反馈](/zh/optimize/feedback#agent-feedback),Mintlify 会在每个页面的 Markdown 导出中附加一个 `` 块,告知 Agent 如何提交关于页面内容的反馈。 - -Agent 通过向端点发送页面路径和反馈文本来提交反馈。 - -使用 Agent 反馈根据 Agent 发现的不正确、过时或令人困惑的内容来改进你的页面。 -
## 键盘快捷键
diff --git a/zh/optimize/feedback.mdx b/zh/optimize/feedback.mdx index 26a86dbd2..d73056306 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 发送包含以下 JSON 主体的 POST 请求来提交反馈: + +{ + "path": "/current-page-path", + "feedback": "问题描述" +} +```
### 启用 Agent 反馈