Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions analytics.openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,18 @@
],
"description": "Auto-assigned category grouping for the conversation, if applicable."
},
"feedback": {
"type": [
"string",
"null"
],
"enum": [
"positive",
"negative",
null
],
"description": "The user's thumbs rating on the assistant's response. `positive` for thumbs up, `negative` for thumbs down, or `null` if the user did not rate the response. If a user regenerates an answer and rates it again, the latest rating is used."
},
"pageUrl": {
"type": [
"string",
Expand All @@ -368,6 +380,7 @@
"sources",
"resolutionStatus",
"queryCategory",
"feedback",
"pageUrl"
]
}
Expand Down
5 changes: 4 additions & 1 deletion analytics/export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,10 @@

## Interpret assistant exports

Assistant exports include the queries, responses, sources, and a `resolutionStatus` column. The column indicates whether the assistant successfully answered each question with a value of `answered` or `unanswered`. Use it to identify documentation gaps surfaced by questions the assistant could not resolve.
Assistant exports include the queries, responses, sources, a `resolutionStatus` column, and a `feedback` column.

- `resolutionStatus` indicates whether the assistant successfully answered each question with a value of `answered` or `unanswered`. Use it to identify documentation gaps surfaced by questions the assistant could not resolve.
- `feedback` records the user's thumbs rating on the assistant's response as `positive` or `negative`. The column is empty for responses the user did not rate. When a user regenerates an answer and rates it again, the latest rating is used.

Check warning on line 56 in analytics/export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/export.mdx#L56

In general, use active voice instead of passive voice ('is used').

<Tip>
Sample analysis prompts for assistant exports:
Expand Down
1 change: 1 addition & 0 deletions api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@
Each row includes:
- **query**: The user's question.
- **response**: The assistant's answer. For clarifying-question turns, this is the follow-up question the assistant asked the user.
- **responseType**: Either `answer` or `clarifying_question`. `clarifying_question` means the assistant asked the user a follow-up question instead of answering. Defaults to `answer` when not present.

Check warning on line 25 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L25

Did you really mean 'responseType'?
- **sources**: Pages referenced in the response, with title and URL.
- **resolutionStatus**: Whether the assistant successfully answered this turn. Either `answered` or `unanswered`. Computed per row, so a single conversation can contain both statuses. Use this field to track and analyze documentation gaps surfaced by user questions the assistant could not resolve.
- **timestamp**: When the user sent the message that started this turn. Rows in the same conversation have different timestamps.
- **queryCategory**: Classification of the query type, if available.
- **feedback**: The user's thumbs rating on the assistant's response. Either `positive`, `negative`, or `null` if the user did not rate the response. When a user regenerates an answer and rates it again, the latest rating is used.

Check warning on line 30 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L30

In general, use active voice instead of passive voice ('is used').
- **pageUrl**: Full URL of the documentation page where the conversation started, or `null` if no page path is available. Use this field to attribute conversations to a specific page.

## Rate limits
Expand Down
13 changes: 13 additions & 0 deletions es/analytics.openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,18 @@
],
"description": "Categoría de agrupación asignada automáticamente a la conversación, si corresponde."
},
"feedback": {
"type": [
"string",
"null"
],
"enum": [
"positive",
"negative",
null
],
"description": "Valoración con pulgar del usuario sobre la respuesta del assistant. `positive` para pulgar arriba, `negative` para pulgar abajo, o `null` si el usuario no valoró la respuesta. Si el usuario regenera una respuesta y la vuelve a valorar, se usa la valoración más reciente."
},
"pageUrl": {
"type": [
"string",
Expand All @@ -427,6 +439,7 @@
"response",
"sources",
"queryCategory",
"feedback",
"pageUrl"
]
}
Expand Down
5 changes: 4 additions & 1 deletion es/analytics/export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,10 @@ Mintlify clasifica cada vista utilizando patrones conocidos de user-agent para c
## Interpretar las exportaciones del assistant
</div>

Las exportaciones del assistant incluyen las consultas, las respuestas, las fuentes y una columna `resolutionStatus`. La columna indica si el assistant respondió con éxito a cada pregunta con un valor de `answered` o `unanswered`. Úsala para identificar brechas en la documentación reveladas por preguntas que el assistant no pudo resolver.
Las exportaciones del assistant incluyen las consultas, las respuestas, las fuentes, una columna `resolutionStatus` y una columna `feedback`.

- `resolutionStatus` indica si el assistant respondió con éxito a cada pregunta con un valor de `answered` o `unanswered`. Úsala para identificar brechas en la documentación reveladas por preguntas que el assistant no pudo resolver.
- `feedback` registra la valoración con pulgar del usuario sobre la respuesta del assistant como `positive` o `negative`. La columna queda vacía para las respuestas que el usuario no valoró. Si el usuario regenera una respuesta y la vuelve a valorar, se usa la valoración más reciente.

<Tip>
Prompts de análisis de ejemplo para las exportaciones del assistant:
Expand Down
1 change: 1 addition & 0 deletions es/api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Cada fila incluye:
- **resolutionStatus**: Indica si el assistant respondió correctamente a este turno. Puede ser `answered` o `unanswered`. Se calcula por fila, por lo que una misma conversación puede contener ambos estados. Usa este campo para identificar y analizar lagunas en la documentación detectadas a partir de preguntas de usuarios que el assistant no pudo resolver.
- **timestamp**: Cuándo el usuario envió el mensaje que inició este turno. Las filas de la misma conversación tienen marcas de tiempo distintas.
- **queryCategory**: Clasificación del tipo de búsqueda, si está disponible.
- **feedback**: Valoración con pulgar del usuario sobre la respuesta del assistant. Puede ser `positive`, `negative` o `null` si el usuario no valoró la respuesta. Si el usuario regenera una respuesta y la vuelve a valorar, se usa la valoración más reciente.
- **pageUrl**: URL completa de la página de documentación donde se inició la conversación, o `null` si no hay ninguna ruta de página disponible. Usa este campo para atribuir conversaciones a una página específica.

## Límites de uso
Expand Down
13 changes: 13 additions & 0 deletions fr/analytics.openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,18 @@
],
"description": "Catégorie de regroupement automatiquement attribuée à la conversation, le cas échéant."
},
"feedback": {
"type": [
"string",
"null"
],
"enum": [
"positive",
"negative",
null
],
"description": "Évaluation par pouce de l'utilisateur sur la réponse de l'Assistant. `positive` pour un pouce en l'air, `negative` pour un pouce vers le bas, ou `null` si l'utilisateur n'a pas évalué la réponse. Si l'utilisateur régénère une réponse et la réévalue, l'évaluation la plus récente est utilisée."
},
"pageUrl": {
"type": [
"string",
Expand All @@ -439,6 +451,7 @@
"response",
"sources",
"queryCategory",
"feedback",
"pageUrl"
]
}
Expand Down
5 changes: 4 additions & 1 deletion fr/analytics/export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,10 @@ Mintlify classe chaque vue à l'aide de schémas connus de user-agents pour les
## Interpréter les exports de l'assistant
</div>

Les exports de l'assistant incluent les requêtes, les réponses, les sources et une colonne `resolutionStatus`. Cette colonne indique si l'assistant a répondu avec succès à chaque question avec la valeur `answered` ou `unanswered`. Utilisez-la pour identifier les lacunes de la documentation révélées par les questions que l'assistant n'a pas pu résoudre.
Les exports de l'assistant incluent les requêtes, les réponses, les sources, une colonne `resolutionStatus` et une colonne `feedback`.

- `resolutionStatus` indique si l'assistant a répondu avec succès à chaque question avec la valeur `answered` ou `unanswered`. Utilisez-la pour identifier les lacunes de la documentation révélées par les questions que l'assistant n'a pas pu résoudre.
- `feedback` enregistre l'évaluation par pouce de l'utilisateur sur la réponse de l'assistant avec la valeur `positive` ou `negative`. La colonne est vide pour les réponses que l'utilisateur n'a pas évaluées. Si l'utilisateur régénère une réponse et la réévalue, l'évaluation la plus récente est utilisée.

<Tip>
Exemples de prompts d'analyse pour les exports de l'assistant :
Expand Down
1 change: 1 addition & 0 deletions fr/api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Chaque ligne comprend :
- **resolutionStatus** : indique si l’Assistant a répondu correctement à ce tour. La valeur est `answered` ou `unanswered`. Elle est calculée par ligne, une même conversation peut donc contenir les deux statuts. Utilisez ce champ pour suivre et analyser les lacunes de la documentation mises en évidence par les questions des utilisateurs auxquelles l’Assistant n’a pas pu répondre.
- **timestamp** : le moment où l’utilisateur a envoyé le message qui a lancé ce tour. Les lignes d’une même conversation ont des horodatages différents.
- **queryCategory** : la classification du type de requête, si disponible.
- **feedback** : l'évaluation par pouce de l'utilisateur sur la réponse de l'Assistant. La valeur est `positive`, `negative` ou `null` si l'utilisateur n'a pas évalué la réponse. Si l'utilisateur régénère une réponse et la réévalue, l'évaluation la plus récente est utilisée.
- **pageUrl** : URL complète de la page de documentation où la conversation a démarré, ou `null` si aucun chemin de page n'est disponible. Utilisez ce champ pour attribuer les conversations à une page spécifique.

<div id="rate-limits">
Expand Down
13 changes: 13 additions & 0 deletions zh/analytics.openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,18 @@
],
"description": "会话自动分配的分类分组(如适用)。"
},
"feedback": {
"type": [
"string",
"null"
],
"enum": [
"positive",
"negative",
null
],
"description": "用户对 AI 助手响应的点赞或点踩评价。`positive` 表示点赞,`negative` 表示点踩,`null` 表示用户未评价该响应。如果用户重新生成回答并再次评价,则使用最新的评价。"
},
"pageUrl": {
"type": [
"string",
Expand All @@ -439,6 +451,7 @@
"response",
"sources",
"queryCategory",
"feedback",
"pageUrl"
]
}
Expand Down
5 changes: 4 additions & 1 deletion zh/analytics/export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,10 @@ Mintlify 使用已知的 user-agent 模式对搜索爬虫、训练爬虫和 AI
## 解读助手导出数据
</div>

助手导出包含查询、响应、来源以及 `resolutionStatus` 列。该列表示助手是否成功回答了每个问题,其值为 `answered` 或 `unanswered`。可利用它识别助手无法解决的问题所暴露出的文档缺口。
助手导出包含查询、响应、来源、`resolutionStatus` 列以及 `feedback` 列。

- `resolutionStatus` 表示助手是否成功回答了每个问题,其值为 `answered` 或 `unanswered`。可利用它识别助手无法解决的问题所暴露出的文档缺口。
- `feedback` 记录用户对助手响应的点赞或点踩评价,值为 `positive` 或 `negative`。用户未评价的响应此列为空。如果用户重新生成回答并再次评价,则使用最新的评价。

<Tip>
助手导出的示例分析提示词:
Expand Down
1 change: 1 addition & 0 deletions zh/api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ keywords: [ "analytics", "assistant", "conversations", "export", "AI" ]
- **resolutionStatus**: AI 助手是否成功回答了该轮次。值为 `answered` 或 `unanswered`。按行计算,因此同一个会话可能同时包含这两种状态。使用此字段可跟踪并分析 AI 助手无法解答的用户问题所暴露出的文档缺口。
- **timestamp**: 用户发送开启该轮次消息的时间。同一会话中的各行具有不同的时间戳。
- **queryCategory**: query 的类型分类(如果可用)。
- **feedback**: 用户对 AI 助手响应的点赞或点踩评价。值为 `positive`、`negative`,或 `null`(如果用户未评价该响应)。如果用户重新生成回答并再次评价,则使用最新的评价。
- **pageUrl**: 会话开始时所在文档页面的完整 URL;如果没有可用的页面路径,则为 `null`。使用此字段可将会话归因到具体页面。

<div id="rate-limits">
Expand Down