diff --git a/ai/markdown-export.mdx b/ai/markdown-export.mdx index 7d284da7b1..9670fd2276 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/analytics.openapi.json b/analytics.openapi.json index 3e8e91192f..b0db5b9cb5 100644 --- a/analytics.openapi.json +++ b/analytics.openapi.json @@ -63,10 +63,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `agent` is feedback submitted by a third-party AI agent, `thumbs_only` is a thumbs up/down vote." + "description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `thumbs_only` is a thumbs up/down vote." }, "status": { "type": "string", @@ -132,10 +131,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `agent` is feedback submitted by a third-party AI agent, `thumbs_only` is a thumbs up/down vote." + "description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `thumbs_only` is a thumbs up/down vote." }, "status": { "type": "string", @@ -179,7 +177,7 @@ ] }, { - "description": "Returned when source is `agent` or `thumbs_only`. Contains base feedback fields only.", + "description": "Returned when source is `thumbs_only`. Contains base feedback fields only.", "type": "object", "properties": { "id": { @@ -209,10 +207,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `agent` is feedback submitted by a third-party AI agent, `thumbs_only` is a thumbs up/down vote." + "description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `thumbs_only` is a thumbs up/down vote." }, "status": { "type": "string", @@ -500,7 +497,11 @@ "description": "Site-wide content view events." } }, - "required": ["human", "ai", "total"] + "required": [ + "human", + "ai", + "total" + ] }, "ViewsByPageResponse": { "type": "object", @@ -532,7 +533,12 @@ "description": "Total content view events on this path." } }, - "required": ["path", "human", "ai", "total"] + "required": [ + "path", + "human", + "ai", + "total" + ] } }, "hasMore": { @@ -540,7 +546,11 @@ "description": "Whether additional results are available beyond this page." } }, - "required": ["totals", "views", "hasMore"] + "required": [ + "totals", + "views", + "hasMore" + ] }, "AssistantCallerStatsResponse": { "type": "object", @@ -562,7 +572,12 @@ "description": "Total assistant queries across all caller types." } }, - "required": ["web", "api", "other", "total"] + "required": [ + "web", + "api", + "other", + "total" + ] }, "VisitorsTrafficTotals": { "type": "object", @@ -580,7 +595,11 @@ "description": "Site-wide approximate distinct visitors with any qualifying view (deduplicated across human and AI)." } }, - "required": ["human", "ai", "total"] + "required": [ + "human", + "ai", + "total" + ] }, "VisitorsByPageResponse": { "type": "object", @@ -612,7 +631,12 @@ "description": "Approximate distinct visitors with any qualifying view on this path (deduplicated across human and AI)." } }, - "required": ["path", "human", "ai", "total"] + "required": [ + "path", + "human", + "ai", + "total" + ] } }, "hasMore": { @@ -620,7 +644,11 @@ "description": "Whether additional results are available beyond this page." } }, - "required": ["totals", "visitors", "hasMore"] + "required": [ + "totals", + "visitors", + "hasMore" + ] } }, "parameters": { @@ -677,7 +705,6 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], "description": "Filter by feedback source" @@ -805,7 +832,6 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], "description": "Filter by feedback source" @@ -1304,4 +1330,4 @@ } }, "webhooks": {} -} \ No newline at end of file +} diff --git a/api/analytics/feedback.mdx b/api/analytics/feedback.mdx index cffca87ea6..48da8b3392 100644 --- a/api/analytics/feedback.mdx +++ b/api/analytics/feedback.mdx @@ -7,7 +7,7 @@ keywords: ["analytics", "feedback", "export", "user feedback"] ## Usage -Use this endpoint to export user feedback collected from your documentation. Feedback includes contextual feedback from page ratings, code snippet feedback, and agent feedback. +Use this endpoint to export user feedback collected from your documentation. Feedback includes contextual feedback from page ratings and code snippet feedback. Paginate through results using the `cursor` parameter returned in the response. Continue fetching while `hasMore` is `true`. @@ -15,7 +15,7 @@ Paginate through results using the `cursor` parameter returned in the response. Filter feedback by: - **Date range**: Use `dateFrom` and `dateTo` to limit results to a specific time period -- **Source**: Filter by `code_snippet`, `contextual`, or `agent` feedback types +- **Source**: Filter by `code_snippet` or `contextual` feedback types - **Status**: Filter by status values like `pending`, `in_progress`, `resolved`, or `dismissed` ## Response types @@ -24,4 +24,3 @@ The response contains different feedback types based on the source: - **Contextual feedback**: Includes `helpful` boolean and optional `contact` email - **Code snippet feedback**: Includes `code`, `filename`, and `lang` fields -- **Agent feedback**: Includes a `comment` with the agent's feedback text and the `path` of the page it relates to diff --git a/changelog.mdx b/changelog.mdx index 3f1817baad..34378faee3 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -143,16 +143,12 @@ noindex: true - + ## Visibility component The new [`Visibility`](/components/visibility) component lets you show different content to human readers and AI agents on the same page. Wrap content in `` to display it only on the web version of a page or `` to include it only in [Markdown output](/ai/markdown-export) consumed by AI tools. Useful for tailoring instructions, examples, or formatting to each audience without maintaining separate pages. - ## Agent feedback - - Enable [agent feedback](/optimize/feedback#agent-feedback) in your deployment settings to let agents submit structured feedback about your documentation. When turned on, Markdown versions of your pages include feedback instructions so agents know how to report any issues they encounter accessing your documentation. Available as a beta feature in the dashboard under deployment add-ons. - ## MCP filesystem access [MCP servers](/ai/model-context-protocol) now include a query docs filesystem tool that lets agents browse and read your documentation's file structure directly. Agents can navigate directories, read full page content, and batch-read multiple pages in a single call. This tool replaces the `get_page` tool. diff --git a/es/ai/markdown-export.mdx b/es/ai/markdown-export.mdx index e067a1881d..6261ab3a31 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/analytics.openapi.json b/es/analytics.openapi.json index ccb485c2b1..c38ee9b859 100644 --- a/es/analytics.openapi.json +++ b/es/analytics.openapi.json @@ -62,10 +62,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "Origen del comentario. `code_snippet` indica un comentario sobre un bloque de código, `contextual` indica un comentario a nivel de página, `agent` indica un comentario enviado por un agente de IA de terceros, `thumbs_only` es un voto de pulgar arriba/abajo." + "description": "Origen del comentario. `code_snippet` indica un comentario sobre un bloque de código, `contextual` indica un comentario a nivel de página, `thumbs_only` es un voto de pulgar arriba/abajo." }, "status": { "type": "string", @@ -131,10 +130,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "Origen del comentario. `code_snippet` indica un comentario sobre un bloque de código, `contextual` indica un comentario a nivel de página, `agent` indica un comentario enviado por un agente de IA de terceros, `thumbs_only` es un voto de pulgar arriba/abajo." + "description": "Origen del comentario. `code_snippet` indica un comentario sobre un bloque de código, `contextual` indica un comentario a nivel de página, `thumbs_only` es un voto de pulgar arriba/abajo." }, "status": { "type": "string", @@ -208,10 +206,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "Origen del comentario. `code_snippet` indica un comentario sobre un bloque de código, `contextual` indica un comentario a nivel de página, `agent` indica un comentario enviado por un agente de IA de terceros, `thumbs_only` es un voto de pulgar arriba/abajo." + "description": "Origen del comentario. `code_snippet` indica un comentario sobre un bloque de código, `contextual` indica un comentario a nivel de página, `thumbs_only` es un voto de pulgar arriba/abajo." }, "status": { "type": "string", @@ -232,7 +229,7 @@ "source", "status" ], - "description": "Se devuelve cuando el origen es `agent` o `thumbs_only`. Solo contiene los campos base de comentarios." + "description": "Se devuelve cuando el origen es `thumbs_only`. Solo contiene los campos base de comentarios." } ] } @@ -447,7 +444,6 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], "description": "Filtrar por el origen de los comentarios" diff --git a/es/api/analytics/feedback.mdx b/es/api/analytics/feedback.mdx index 88a165ab4a..c77bd5a5b4 100644 --- a/es/api/analytics/feedback.mdx +++ b/es/api/analytics/feedback.mdx @@ -11,7 +11,7 @@ keywords: [ "Analytics", "feedback", "exportación", "comentarios de los usuario ## Uso -Usa este endpoint para exportar los comentarios de los usuarios recopilados desde tu documentación. Los comentarios incluyen comentarios contextuales de las calificaciones de las páginas, comentarios sobre fragmentos de código y comentarios de agentes. +Usa este endpoint para exportar los comentarios de los usuarios recopilados desde tu documentación. Los comentarios incluyen comentarios contextuales de las calificaciones de las páginas y comentarios sobre fragmentos de código. Pagina los resultados usando el parámetro `cursor` devuelto en la respuesta. Continúa obteniendo resultados mientras `hasMore` sea `true`. @@ -22,7 +22,7 @@ Pagina los resultados usando el parámetro `cursor` devuelto en la respuesta. Co Filtra los comentarios por: - **Rango de fechas**: Utiliza `dateFrom` y `dateTo` para limitar los resultados a un período de tiempo específico -- **Fuente**: Filtra por tipos de feedback `code_snippet`, `contextual` o `agent` +- **Fuente**: Filtra por tipos de feedback `code_snippet` o `contextual` - **Estado**: Filtra por valores de estado como `pending`, `in_progress`, `resolved` o `dismissed`
@@ -32,5 +32,4 @@ Filtra los comentarios por: La respuesta contiene diferentes tipos de comentarios según la fuente: - **Comentarios contextuales**: Incluyen el valor booleano `helpful` y un correo electrónico opcional en `contact` -- **Comentarios sobre fragmentos de código**: Incluyen los campos `code`, `filename` y `lang` -- **Comentarios de agentes**: Incluyen un `comment` con el texto del comentario del agente y el `path` de la página a la que se refiere \ No newline at end of file +- **Comentarios sobre fragmentos de código**: Incluyen los campos `code`, `filename` y `lang` \ No newline at end of file diff --git a/es/changelog.mdx b/es/changelog.mdx index 2a114e513b..a7d840def4 100644 --- a/es/changelog.mdx +++ b/es/changelog.mdx @@ -73,7 +73,7 @@ noindex: true - +
## Componente Visibility @@ -81,12 +81,6 @@ noindex: true El nuevo componente [`Visibility`](/es/components/visibility) te permite mostrar contenido diferente a lectores humanos y agentes de IA en la misma página. Envuelve contenido en `` para mostrarlo solo en la versión web de una página o `` para incluirlo solo en la [salida Markdown](/es/ai/markdown-export) consumida por herramientas de IA. Útil para adaptar instrucciones, ejemplos o formato a cada audiencia sin mantener páginas separadas. -
- ## Feedback de agentes -
- - Activa el [feedback de agentes](/es/optimize/feedback#agent-feedback) en la configuración de tu despliegue para permitir que los agentes envíen feedback estructurado sobre tu documentación. Cuando está activado, las versiones Markdown de tus páginas incluyen instrucciones de feedback para que los agentes sepan cómo reportar cualquier problema que encuentren al acceder a tu documentación. Disponible como función beta en el dashboard en complementos de despliegue. -
## Acceso al sistema de archivos MCP
diff --git a/es/optimize/feedback.mdx b/es/optimize/feedback.mdx index 7a1b6f3ceb..bc15ad3cf5 100644 --- a/es/optimize/feedback.mdx +++ b/es/optimize/feedback.mdx @@ -1,7 +1,7 @@ --- title: "Comentarios" description: "Monitorea la satisfacción de los usuarios con widgets de retroalimentación integrados, calificaciones de páginas y reacciones de pulgar arriba/abajo para identificar áreas de mejora." -keywords: ["user feedback", "thumbs rating", "contextual", "satisfaction", "agents"] +keywords: ["user feedback", "thumbs rating", "contextual", "satisfaction"] boost: 3 --- @@ -47,7 +47,6 @@ La pestaña de comentarios muestra información según los [Add-ons de comentari - **Crear issues**: Permite que los usuarios creen issues de GitHub directamente desde tu documentación. Solo disponible para repositorios públicos de GitHub. - **Comentarios contextuales**: Comentarios abiertos sobre el contenido de una página. - **Comentarios sobre fragmentos de código**: Comentarios específicamente sobre fragmentos de código. -- **Comentarios de agentes**: Comentarios enviados por agentes de IA de terceros que acceden a tu documentación.
## Recopilar direcciones de correo electrónico @@ -108,60 +107,6 @@ Haz clic en un elemento de feedback para añadir una nota interna. Estas notas s Usa las notas para añadir información para colaborar, vincular tickets relevantes de soporte o de ingeniería, o recordar cualquier otra información útil. -
- ## Comentarios de agentes -
- - - Los comentarios de agentes están en versión beta y sujetos a cambios. - - -Cuando agentes de IA de terceros acceden a tu documentación, pueden enviar comentarios estructurados sobre páginas que encuentran incorrectas, desactualizadas o difíciles de usar. - -Estos comentarios aparecen en el [dashboard de comentarios](https://dashboard.mintlify.com/products/analytics/v2/feedback) identificados con una etiqueta **Agent**. Gestiona los comentarios de agentes de la misma forma que los comentarios humanos. Establece estados, añade notas internas y filtra los comentarios. - -
- ### Cómo funcionan los comentarios de agentes -
- -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. - -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. - -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. - -
- ### Habilitar comentarios de agentes -
- - -1. Ve a la página de [Add-ons](https://dashboard.mintlify.com/products/addons) en tu dashboard. -2. Habilita la opción **Agent feedback**. - - Opción de comentarios de agentes en la página de Add-ons. - Opción de comentarios de agentes en la página de Add-ons. - - -
- ### Recuperar comentarios de agentes por API -
- -Usa el [endpoint de feedback de analytics](/es/api/analytics/feedback) para recuperar comentarios de agentes de forma programática. Filtra por `source=agent` para obtener solo los comentarios de agentes. - -Las respuestas de comentarios de agentes incluyen: -- `comment`: El texto del comentario enviado por el agente. -- `path`: La ruta de la página a la que se refiere el comentario. -
## Usa los datos de feedback
diff --git a/fr/ai/markdown-export.mdx b/fr/ai/markdown-export.mdx index dfa4672b10..92190ea484 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/analytics.openapi.json b/fr/analytics.openapi.json index e2c3062a3c..8f93770600 100644 --- a/fr/analytics.openapi.json +++ b/fr/analytics.openapi.json @@ -62,10 +62,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "Source du retour. `code_snippet` correspond à un retour sur un bloc de code, `contextual` à un retour au niveau de la page, `agent` est un retour soumis par un agent IA tiers, `thumbs_only` est un vote pouce vers le haut/bas." + "description": "Source du retour. `code_snippet` correspond à un retour sur un bloc de code, `contextual` à un retour au niveau de la page, `thumbs_only` est un vote pouce vers le haut/bas." }, "status": { "type": "string", @@ -131,10 +130,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "Source du retour. `code_snippet` correspond à un retour sur un bloc de code, `contextual` à un retour au niveau de la page, `agent` est un retour soumis par un agent IA tiers, `thumbs_only` est un vote pouce vers le haut/bas." + "description": "Source du retour. `code_snippet` correspond à un retour sur un bloc de code, `contextual` à un retour au niveau de la page, `thumbs_only` est un vote pouce vers le haut/bas." }, "status": { "type": "string", @@ -208,10 +206,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "Source du retour. `code_snippet` correspond à un retour sur un bloc de code, `contextual` à un retour au niveau de la page, `agent` est un retour soumis par un agent IA tiers, `thumbs_only` est un vote pouce vers le haut/bas." + "description": "Source du retour. `code_snippet` correspond à un retour sur un bloc de code, `contextual` à un retour au niveau de la page, `thumbs_only` est un vote pouce vers le haut/bas." }, "status": { "type": "string", @@ -232,7 +229,7 @@ "source", "status" ], - "description": "Renvoyé lorsque la source est `agent` ou `thumbs_only`. Contient uniquement les champs de base du retour." + "description": "Renvoyé lorsque la source est `thumbs_only`. Contient uniquement les champs de base du retour." } ] } @@ -447,7 +444,6 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], "description": "Filtrer par source des retours utilisateurs" diff --git a/fr/api/analytics/feedback.mdx b/fr/api/analytics/feedback.mdx index c332c4e2f7..a8f7a89b8f 100644 --- a/fr/api/analytics/feedback.mdx +++ b/fr/api/analytics/feedback.mdx @@ -10,7 +10,7 @@ keywords: [ "analytics", "feedback", "export", "feedback utilisateur" ] ## Utilisation
-Utilisez cet endpoint pour exporter les retours utilisateurs collectés à partir de votre documentation. Les retours incluent les commentaires contextuels issus des évaluations de pages, les retours sur les extraits de code et les retours des agents. +Utilisez cet endpoint pour exporter les retours utilisateurs collectés à partir de votre documentation. Les retours incluent les commentaires contextuels issus des évaluations de pages et les retours sur les extraits de code. Parcourez les résultats à l’aide du paramètre `cursor` renvoyé dans la réponse. Continuez à effectuer des requêtes tant que `hasMore` vaut `true`. @@ -21,7 +21,7 @@ Parcourez les résultats à l’aide du paramètre `cursor` renvoyé dans la ré Filtrez les feedbacks par : - **Plage de dates** : utilisez `dateFrom` et `dateTo` pour limiter les résultats à une période donnée -- **Source** : filtrez par type de feedback, `code_snippet`, `contextual` ou `agent` +- **Source** : filtrez par type de feedback, `code_snippet` ou `contextual` - **Statut** : filtrez par des valeurs de statut comme `pending`, `in_progress`, `resolved` ou `dismissed`
@@ -30,6 +30,5 @@ Filtrez les feedbacks par : La réponse contient différents types de commentaires en fonction de la source : -- **Commentaire contextuel** : inclut le booléen `helpful` et éventuellement l’adresse e-mail `contact` -- **Commentaire sur extrait de code** : inclut les champs `code`, `filename` et `lang` -- **Retour d'agent** : inclut un `comment` avec le texte du retour de l'agent et le `path` de la page concernée +- **Commentaire contextuel** : inclut le booléen `helpful` et éventuellement l’adresse e-mail `contact` +- **Commentaire sur extrait de code** : inclut les champs `code`, `filename` et `lang` diff --git a/fr/changelog.mdx b/fr/changelog.mdx index 32e7219551..9ca64c743d 100644 --- a/fr/changelog.mdx +++ b/fr/changelog.mdx @@ -73,7 +73,7 @@ noindex: true - +
## Composant Visibility @@ -81,12 +81,6 @@ noindex: true Le nouveau composant [`Visibility`](/fr/components/visibility) vous permet d'afficher un contenu différent pour les lecteurs humains et les agents IA sur la même page. Enveloppez le contenu dans `` pour l'afficher uniquement sur la version web d'une page ou `` pour l'inclure uniquement dans la [sortie Markdown](/fr/ai/markdown-export) consommée par les outils IA. Utile pour adapter les instructions, les exemples ou le formatage à chaque audience sans maintenir des pages séparées. -
- ## Feedback des agents -
- - Activez le [feedback des agents](/fr/optimize/feedback#agent-feedback) dans les paramètres de votre déploiement pour permettre aux agents de soumettre des retours structurés sur votre documentation. Lorsqu'il est activé, les versions Markdown de vos pages incluent des instructions de feedback pour que les agents sachent comment signaler les problèmes qu'ils rencontrent en accédant à votre documentation. Disponible en tant que fonctionnalité bêta dans le tableau de bord sous les modules complémentaires de déploiement. -
## Accès au système de fichiers MCP
diff --git a/fr/optimize/feedback.mdx b/fr/optimize/feedback.mdx index 382acab47d..d915a84980 100644 --- a/fr/optimize/feedback.mdx +++ b/fr/optimize/feedback.mdx @@ -1,7 +1,7 @@ --- title: "Commentaires" description: "Surveillez la satisfaction des utilisateurs avec des widgets de feedback intégrés, des évaluations de pages et des réactions pouce haut/bas pour identifier les axes d'amélioration." -keywords: ["user feedback", "thumbs rating", "contextual", "satisfaction", "agents"] +keywords: ["user feedback", "thumbs rating", "contextual", "satisfaction"] boost: 3 --- @@ -48,7 +48,6 @@ L'onglet Feedback affiche des informations en fonction des [modules complémenta - **Création d’issues** : permettez aux utilisateurs de créer des issues GitHub directement depuis votre documentation. Disponible uniquement pour les dépôts GitHub publics. - **Feedback contextuel** : retour libre sur le contenu d’une page. - **Feedback sur les extraits de code** : retour spécifiquement sur les extraits de code. -- **Retours des agents** : retours soumis par des agents IA tiers qui accèdent à votre documentation.
## Collecte d’adresses e-mail @@ -109,60 +108,6 @@ Cliquez sur un retour pour y ajouter une note interne. Ces notes sont uniquement Utilisez les notes pour ajouter des informations afin de faciliter la collaboration, associer des tickets de support ou d’ingénierie pertinents, ou conserver toute autre information utile. -
- ## Retours des agents -
- - - Les retours des agents sont en bêta et susceptibles de changer. - - -Lorsque des agents IA tiers accèdent à votre documentation, ils peuvent soumettre des retours structurés sur les pages qu'ils trouvent incorrectes, obsolètes ou difficiles à utiliser. - -Ces retours apparaissent dans le [dashboard de feedback](https://dashboard.mintlify.com/products/analytics/v2/feedback) identifiés par un badge **Agent**. Gérez les retours des agents de la même manière que les retours humains. Définissez des statuts, ajoutez des notes internes et filtrez les retours. - -
- ### Fonctionnement des retours des agents -
- -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. - -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. - -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. - -
- ### Activer les retours des agents -
- - -1. Accédez à la page [Add-ons](https://dashboard.mintlify.com/products/addons) de votre dashboard. -2. Activez l'option **Agent feedback**. - - Option des retours des agents dans la page Add-ons. - Option des retours des agents dans la page Add-ons. - - -
- ### Récupérer les retours des agents via API -
- -Utilisez l'[endpoint de feedback analytics](/fr/api/analytics/feedback) pour récupérer les retours des agents de manière programmatique. Filtrez par `source=agent` pour ne retourner que les retours des agents. - -Les réponses de retours des agents incluent : -- `comment` : le texte du retour soumis par l'agent. -- `path` : le chemin de la page concernée par le retour. -
## Utiliser les données de feedback
diff --git a/images/analytics/agent-feedback-dark.png b/images/analytics/agent-feedback-dark.png deleted file mode 100644 index a1f6d04ffc..0000000000 Binary files a/images/analytics/agent-feedback-dark.png and /dev/null differ diff --git a/images/analytics/agent-feedback-light.png b/images/analytics/agent-feedback-light.png deleted file mode 100644 index 582c49f40e..0000000000 Binary files a/images/analytics/agent-feedback-light.png and /dev/null differ diff --git a/optimize/feedback.mdx b/optimize/feedback.mdx index 53f150464b..f7048079c5 100644 --- a/optimize/feedback.mdx +++ b/optimize/feedback.mdx @@ -1,7 +1,7 @@ --- title: "Feedback" description: "Monitor user satisfaction with built-in feedback widgets, page ratings, and thumbs up/down reactions to identify documentation improvement areas." -keywords: ["user feedback", "thumbs rating", "contextual", "satisfaction", "agents"] +keywords: ["user feedback", "thumbs rating", "contextual", "satisfaction"] boost: 3 --- @@ -54,7 +54,6 @@ The feedback tab displays information according to the [feedback add-ons](https: - **Raise issues**: Allow users to create GitHub issues directly from your documentation. Only available for public GitHub repositories. - **Contextual feedback**: Free form feedback about the content of a page. - **Code snippet feedback**: Feedback specifically on code snippets. -- **Agent feedback**: Feedback submitted by third-party AI agents that access your documentation. ## Collect email addresses @@ -103,52 +102,6 @@ Click a piece of feedback to add an internal note. These notes are only visible Use notes to add information for collaboration, link relevant support or engineering tickets, or remember any other useful information. -## Agent feedback - - - Agent feedback is in beta and subject to change. - - -When third-party AI agents fetch your documentation, they can submit structured feedback about pages they find incorrect, outdated, or difficult to use. - -This feedback appears in the [feedback dashboard](https://dashboard.mintlify.com/products/analytics/v2/feedback) identified by an **Agent** badge. Manage agent feedback the same way as human feedback. Set statuses, add internal notes, and filter feedback. - -### How agent feedback works - -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. - -Agents post feedback to the endpoint with the page path and feedback text. The feedback appears in the dashboard alongside human feedback. - -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. - -### Enable agent feedback - - -1. Navigate to the [Add-ons](https://dashboard.mintlify.com/products/addons) page in your dashboard. -2. Enable the **Agent feedback** toggle. - - Agent feedback toggle in the Add-ons page. - Agent feedback toggle in the Add-ons page. - - -### Retrieve agent feedback via API - -Use the [analytics feedback endpoint](/api/analytics/feedback) to retrieve agent feedback programmatically. Filter by `source=agent` to return only agent feedback. - -Agent feedback responses include: -- `comment`: The feedback text submitted by the agent. -- `path`: The path of the page the feedback is about. - ## Use feedback data Review your feedback data to: diff --git a/zh/ai/markdown-export.mdx b/zh/ai/markdown-export.mdx index 004a73eac5..02096cb47d 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/analytics.openapi.json b/zh/analytics.openapi.json index ce41973290..e906712cab 100644 --- a/zh/analytics.openapi.json +++ b/zh/analytics.openapi.json @@ -62,10 +62,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "反馈的来源类型。`code_snippet` 表示针对代码块的反馈，`contextual` 表示页面级别的反馈，`agent` 表示由第三方 AI Agent 提交的反馈，`thumbs_only` 表示点赞/点踩投票。" + "description": "反馈的来源类型。`code_snippet` 表示针对代码块的反馈，`contextual` 表示页面级别的反馈，`thumbs_only` 表示点赞/点踩投票。" }, "status": { "type": "string", @@ -131,10 +130,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "反馈的来源类型。`code_snippet` 表示针对代码块的反馈，`contextual` 表示页面级别的反馈，`agent` 表示由第三方 AI Agent 提交的反馈，`thumbs_only` 表示点赞/点踩投票。" + "description": "反馈的来源类型。`code_snippet` 表示针对代码块的反馈，`contextual` 表示页面级别的反馈，`thumbs_only` 表示点赞/点踩投票。" }, "status": { "type": "string", @@ -208,10 +206,9 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], - "description": "反馈的来源类型。`code_snippet` 表示针对代码块的反馈，`contextual` 表示页面级别的反馈，`agent` 表示由第三方 AI Agent 提交的反馈，`thumbs_only` 表示点赞/点踩投票。" + "description": "反馈的来源类型。`code_snippet` 表示针对代码块的反馈，`contextual` 表示页面级别的反馈，`thumbs_only` 表示点赞/点踩投票。" }, "status": { "type": "string", @@ -232,7 +229,7 @@ "source", "status" ], - "description": "当来源为 `agent` 或 `thumbs_only` 时返回。仅包含基本反馈字段。" + "description": "当来源为 `thumbs_only` 时返回。仅包含基本反馈字段。" } ] } @@ -447,7 +444,6 @@ "enum": [ "code_snippet", "contextual", - "agent", "thumbs_only" ], "description": "按反馈来源进行筛选" diff --git a/zh/api/analytics/feedback.mdx b/zh/api/analytics/feedback.mdx index d68ae21700..f8df03529c 100644 --- a/zh/api/analytics/feedback.mdx +++ b/zh/api/analytics/feedback.mdx @@ -9,7 +9,7 @@ keywords: ["Analytics", "反馈", "导出", "用户反馈"] ## 用法
-使用此端点导出从文档中收集的用户反馈。反馈包括来自页面评分的上下文反馈、代码片段反馈和 Agent 反馈。 +使用此端点导出从文档中收集的用户反馈。反馈包括来自页面评分的上下文反馈和代码片段反馈。 使用响应中返回的 `cursor` 参数对结果进行分页。当 `hasMore` 为 `true` 时继续获取数据。 @@ -20,7 +20,7 @@ keywords: ["Analytics", "反馈", "导出", "用户反馈"] 可以按以下维度筛选反馈： - **日期范围**：使用 `dateFrom` 和 `dateTo` 将结果限定在特定时间段内 -- **来源**：按 `code_snippet`、`contextual` 或 `agent` 等反馈来源类型进行筛选 +- **来源**：按 `code_snippet` 或 `contextual` 等反馈来源类型进行筛选 - **状态**：按状态值进行筛选，例如 `pending`、`in_progress`、`resolved` 或 `dismissed`
@@ -30,5 +30,4 @@ keywords: ["Analytics", "反馈", "导出", "用户反馈"] 响应会根据不同的 source 包含不同类型的反馈： - **上下文反馈**：包含 `helpful` 布尔值和可选的 `contact` 邮箱 -- **代码片段反馈**：包含 `code`、`filename` 和 `lang` 字段 -- **Agent 反馈**：包含 Agent 提交的反馈文本 `comment` 和相关页面的 `path` \ No newline at end of file +- **代码片段反馈**：包含 `code`、`filename` 和 `lang` 字段 \ No newline at end of file diff --git a/zh/changelog.mdx b/zh/changelog.mdx index decf73016b..f579f785de 100644 --- a/zh/changelog.mdx +++ b/zh/changelog.mdx @@ -73,7 +73,7 @@ noindex: true - +
## Visibility 组件 @@ -81,12 +81,6 @@ noindex: true 新的 [`Visibility`](/zh/components/visibility) 组件允许你在同一页面上为人类读者和 AI agent 显示不同的内容。将内容包裹在 `` 中以仅在页面的网页版本上显示，或使用 `` 以仅将其包含在 AI 工具使用的 [Markdown 输出](/zh/ai/markdown-export)中。适用于为每种受众定制说明、示例或格式，而无需维护单独的页面。 -
- ## Agent 反馈 -
- - 在部署设置中启用 [agent 反馈](/zh/optimize/feedback#agent-feedback)，允许 agent 提交关于你文档的结构化反馈。启用后，页面的 Markdown 版本会包含反馈说明，以便 agent 知道如何报告他们在访问你的文档时遇到的任何问题。该功能作为 beta 功能在仪表板的部署附加组件中提供。 -
## MCP 文件系统访问
diff --git a/zh/optimize/feedback.mdx b/zh/optimize/feedback.mdx index 26a86dbd22..2ce58c7069 100644 --- a/zh/optimize/feedback.mdx +++ b/zh/optimize/feedback.mdx @@ -1,7 +1,7 @@ --- title: "反馈" description: "通过内置反馈组件、页面评分和点赞/踩功能监控用户满意度，识别文档需要改进的区域。" -keywords: ["user feedback", "thumbs rating", "contextual", "satisfaction", "agents"] +keywords: ["user feedback", "thumbs rating", "contextual", "satisfaction"] boost: 3 --- @@ -48,7 +48,6 @@ boost: 3 - **提交 Issue**：允许用户直接从文档中在 GitHub 上创建 Issue。仅适用于公开的 GitHub 仓库。 - **上下文反馈**：针对页面内容的自由填写反馈。 - **代码片段反馈**：专门针对代码片段的反馈。 -- **Agent 反馈**：由访问你文档的第三方 AI Agent 提交的反馈。
## 收集邮箱地址 @@ -109,60 +108,6 @@ boost: 3 使用备注来补充协作所需的信息、关联相关的支持或工程工单，或记录任何其他有用的信息。 -
- ## Agent 反馈 -
- - - Agent 反馈目前处于测试版 (Beta)，可能会有所变化。 - - -当第三方 AI Agent 获取你的文档时，它们可以提交关于其发现不正确、过时或难以使用的页面的结构化反馈。 - -这些反馈会在[反馈控制台](https://dashboard.mintlify.com/products/analytics/v2/feedback)中显示，并以 **Agent** 标记标识。像管理人工反馈一样管理 Agent 反馈：设置状态、添加内部备注和筛选反馈。 - -
- ### Agent 反馈的工作原理 -
- -你必须在控制台中启用 Agent 反馈功能才能收集此类反馈。 - -启用后，当 Agent 通过 Markdown 导出获取页面时，Mintlify 会附加一个包含指令和提交反馈端点的 `` 块。 - -Agent 通过向端点发送页面路径和反馈文本来提交反馈。反馈会与人工反馈一同显示在控制台中。 - -反馈端点始终以 `POST` 请求的形式在 `https://你的域名.com/feedback` 上可用，即使你没有将指令添加到 Markdown 导出中。因此你可以提示 Agent 通过直接向端点发送请求来手动提交反馈。 - -
- ### 启用 Agent 反馈 -
- - -1. 前往控制台中的 [附加组件](https://dashboard.mintlify.com/products/addons) 页面。 -2. 启用 **Agent feedback** 开关。 - - 附加组件页面中的 Agent 反馈开关。 - 附加组件页面中的 Agent 反馈开关。 - - -
- ### 通过 API 获取 Agent 反馈 -
- -使用 [analytics 反馈端点](/zh/api/analytics/feedback) 以编程方式获取 Agent 反馈。按 `source=agent` 筛选以仅返回 Agent 反馈。 - -Agent 反馈响应包括： -- `comment`：Agent 提交的反馈文本。 -- `path`：反馈所涉及页面的路径。 -
## 使用反馈数据