Commentaires sur les traces UIP

Syntaxe et options pour `uip traces commentaires`, qui crée et gère les commentaires d'observabilité LLM associés à une trace ou à une plage.

uip traces feedback gère les commentaires d'observabilité LLM - une évaluation positive/négative, un commentaire et des balises de catégorie associées à une trace ou à une plage. Utilisez-le pour enregistrer l'examen humain de la sortie d'un agent ou pour extraire les commentaires enregistrés à des fins de rapport.

Cette page fait partie de l’outil uip traces — consultez cette page pour spans get.

Synthèse

uip traces feedback create --trace-id <id> (--positive | --negative) --folder-key <guid> [--span-id <id>] [--comment <text> | --comment-file <path>] [--category <tag>...] [--agent-id <guid>] [--agent-version <str>]
uip traces feedback get <id> [--folder-key <guid>]
uip traces feedback list [--agent-id <guid>] [--agent-version <str>] [--trace-id <id>] [--span-id <id>] [--status <value>...] [--positive | --negative] [--limit <n>] [--offset <n>] [--folder-key <guid>]
uip traces feedback list detailed [--agent-id <guid>] [--agent-version <str>] [--trace-id <id>] [--span-id <id>] [--status <value>...] [--positive | --negative] [--category-id <guid>...] [--after <iso> | --since <duration>] [--before <iso>] [--sort-by <field>] [--sort-order <dir>] [--limit <n>] [--offset <n>] [--folder-key <guid>]
uip traces feedback update <id> (--positive | --negative) --folder-key <guid> [--comment <text> | --comment-file <path>] [--metadata <json> | --metadata-file <path>] [--category <tag>...]
uip traces feedback delete <id> --folder-key <guid> -y

Tous les verbes respectent les options globales et les codes de sortie standard.

création de commentaires sur les traçages uip

Créez des commentaires pour un traçage (ou une plage spécifique au sein de celui-ci).

Options

Drapeau	Description
--trace-id <id>	Requis. ID de traçage (32 caractères hexadécimaux ou GUID).
--positive / --negative	Requis: exactement un. Sentiment des commentaires.
--folder-key <guid>	Requis. Clé de dossier Orchestrator.
--span-id <id>	ID d’étendue. Par défaut, l'étendue de la racine du traçage lorsqu'elle est omise.
--comment <text>	Annotation en texte libre (max 1 048 576 caractères). Capture mutuellement exclusive avec --comment-file.
--comment-file <path>	Lire le commentaire d'un fichier; transmettez - pour lire à partir de stbin. Capture mutuellement exclusive avec --comment.
--category <tag>	Balise de catégorie. Répétable. La plate-forme reconnaît les balises intégrées telles que Output, Agent Error et Agent Plan Execution, mais toute chaîne est acceptée.
--agent-id <guid>	ID de référence de l’agent.
--agent-version <str>	Version de l’agent (100 caractères maximum).

Exemple

uip traces feedback create \
  --trace-id 4bf92f3577b34da6a3ce929d0e0e4736 \
  --positive \
  --folder-key a1b2c3d4-0000-0000-0000-000000000001

Format des données

{
  "Code": "FeedbackCreate",
  "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000002" }
}

Data est une transmission non modifiée de ce que renvoie l'API de commentaires — la CLI ne la projette pas dans un ensemble de champs fixe, de sorte que la réponse réelle peut comporter plus de champs que ce qui est indiqué ici.

Obtenir des commentaires sur les traçages uip

Obtenez un enregistrement de commentaires unique par ID.

Arguments

• <id> (requis) : ID d'enregistrement de commentaires. Échoue côté client avec « Format d’ID de commentaires non valide» s'il ne s'agit pas d'un GUID.

Options

Drapeau	Description
--folder-key <guid>	Clé de dossier Orchestrator. Le serveur l'exige généralement pour autoriser la lecture, même si la CLI n'échoue pas définitivement sans cela côté client.

Exemple

uip traces feedback get a1b2c3d4-0000-0000-0000-000000000002 \
  --folder-key a1b2c3d4-0000-0000-0000-000000000001

Format des données

{
  "Code": "FeedbackGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000002",
    "IsPositive": true
  }
}

Comme create, Data est une transmission brute - la réponse réelle comporte généralement plus de champs (commentaires, métadonnées, catégories, horodatages) que cet exemple minimal n'affiche.

liste de commentaires des traces UiP

Répertoriez les entrées de commentaires, filtrées par traçage, étendue, agent, statut ou sentiment.

Options

Drapeau	Description
--agent-id <guid>	Filtrer par ID d'agent.
--agent-version <str>	Filtrez par version d’agent.
--trace-id <id>	Filtrer par ID de traçage.
--span-id <id>	Filtrer par ID d'étendue.
--status <value>	Filtrer par statut: Pending, Approved, Dismissed. Répétable.
--positive / --negative	Renvoyez uniquement les commentaires positifs ou uniquement négatifs. Captures mutuellement exclusives.
--limit <n>	Nombre max. de résultats. La valeur par défaut est 20, limitée à 100.
--offset <n>	Résultats à ignorer. La valeur par défaut est 0.
--folder-key <guid>	Clé de dossier Orchestrator.

Exemple

uip traces feedback list --trace-id 4bf92f3577b34da6a3ce929d0e0e4736

Format des données

{
  "Code": "FeedbackList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000002",
      "IsPositive": true
    }
  ]
}

Un résultat vide s’imprime sur « Aucun commentaire trouvé ». Utilisez « uip Traces Commentaires Créer » pour ajouter des commentaires.

liste de commentaires des traçages uip détaillée

Répertoriez les commentaires avec des filtres étendus (fenêtre horaire, catégorie, tri) et le contexte de la période. Il s'agit d'une sous-commande de list, et non d'un verbe de niveau supérieur — l'invocation est uip traces feedback list detailed, avec l'espace, et non list-detailed.

Options

Drapeau	Description
--agent-id <guid>	Filtrer par ID d'agent.
--agent-version <str>	Filtrez par version d’agent.
--trace-id <id>	Filtrer par ID de traçage.
--span-id <id>	Filtrer par ID d'étendue.
--status <value>	Filtrer par statut: Pending, Approved, Dismissed. Répétable.
--positive / --negative	Renvoyez uniquement les commentaires positifs ou uniquement négatifs. Captures mutuellement exclusives.
--category-id <guid>	Filtrer par ID de catégorie. Répétable.
--after <iso>	Créé après cet horodatage ISO 8601.
--before <iso>	Créé avant cet horodatage ISO 8601.
--since <duration>	Raccourci relatif de --after — par exemple 1h, 24h, 7d. Seules les unités h (heures) et d (jours) sont acceptées.
--sort-by <field>	Champ de tri: createdAt ou updatedAt. La valeur par défaut est createdAt.
--sort-order <dir>	Sens du tri: asc ou desc. La valeur par défaut est desc.
--limit <n>	Nombre max. de résultats. La valeur par défaut est 20, limitée à 200 (plus élevé que la limite de 100 de list simple).
--offset <n>	Résultats à ignorer. La valeur par défaut est 0.
--folder-key <guid>	Clé de dossier Orchestrator.

Remarque :

--since et --after définissent tous deux le même filtre d'heure de début sous-jacent — --since est évalué par rapport à " maintenant" au moment où la commande s’exécute.

Exemple

uip traces feedback list detailed --since 24h

Format des données

{
  "Code": "FeedbackListDetailed",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000002",
      "IsPositive": true,
      "TraceId": "4bf92f3577b34da6a3ce929d0e0e4736"
    }
  ]
}

La réponse de l'API sous-jacente est paginée ({ items, totalCount }), mais la CLI émet uniquement le tableau items en tant que Data — le nombre total de correspondances (totalCount) n'est pas réaffiché. Pour savoir s’il existe davantage de résultats au-delà de --limit, comparez le nombre renvoyé à --limit plutôt que de vous appuyer sur un total.

mise à jour des commentaires des traçages uip

Mettez à jour le sentiment, le commentaire, les métadonnées ou les catégories d'un enregistrement de commentaires existant.

Important :

L'API remplace l'enregistrement entier plutôt que de le corriger, de sorte que la CLI lit d'abord l'enregistrement existant et reporte tout champ que vous n'avez pas transmis - à l'exception de --category: le fait d'omettre laisse les catégories existantes inchangées, mais cette lecture-puis-écriture est non forme atomique. Un arrivée de modification simultanée entre la lecture et l’écriture est perdue en mode silencieux.

Arguments

• <id> (requis) : ID d'enregistrement de commentaires.

Options

Drapeau	Description
--positive / --negative	Requis: exactement un. Nouveau sentiment.
--folder-key <guid>	Requis. Clé de dossier Orchestrator.
--comment <text>	Commentaire mis à jour (max 1 048 576 caractères). Capture mutuellement exclusive avec --comment-file. Omettez le commentaire existant pour le conserver.
--comment-file <path>	Lire le commentaire mis à jour d'un fichier; transmettez - pour stbin. Capture mutuellement exclusive avec --comment.
--metadata <json>	Métadonnées mises à jour; doit être un JSON valide (max 1 048 576 caractères). Capture mutuellement exclusive avec --metadata-file. Omettez afin de conserver les métadonnées existantes.
--metadata-file <path>	Lire les métadonnées mises à jour d'un fichier; transmettez - pour stbin. Capture mutuellement exclusive avec --metadata.
--category <tag>	Balises de catégorie de remplacement. Répétable. Omettez entièrement pour laisser les catégories existantes telles quelles - la transmettre remplace l'ensemble complet, elle ne fusionne pas.

Exemples

# change sentiment and add a comment
uip traces feedback update a1b2c3d4-0000-0000-0000-000000000002 \
  --negative \
  --comment "Wrong output" \
  --folder-key a1b2c3d4-0000-0000-0000-000000000001

# attach metadata read from a file
uip traces feedback update a1b2c3d4-0000-0000-0000-000000000002 \
  --positive \
  --metadata-file review.json \
  --folder-key a1b2c3d4-0000-0000-0000-000000000001

Format des données

{
  "Code": "FeedbackUpdate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000002",
    "IsPositive": false
  }
}

suppression des commentaires des traçages uip

Supprimez un enregistrement de commentaires par ID. Il s'agit d'une opération irréversible , qui nécessite -y, --yes; la CLI ne s'affiche jamais.

Arguments

• <id> (requis) : ID d'enregistrement de commentaires.

Options

Drapeau	Description
--folder-key <guid>	Requis. Clé de dossier Orchestrator.
-y, --yes	Confirmez cette opération irréversible. Requis — la CLI ne s'affiche jamais.

Exemple

uip traces feedback delete a1b2c3d4-0000-0000-0000-000000000002 \
  --folder-key a1b2c3d4-0000-0000-0000-000000000001 \
  --yes

Format des données

{
  "Code": "FeedbackDelete",
  "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000002" }
}

Comportement des erreurs

• 401 de l’API de commentaires: Failure: "Not authenticated. Run 'uip auth login' first.".
• 403 : Failure: "Insufficient permissions. Ensure you have Logs.View / Logs.Create / Logs.Delete on this folder.".
• 404: Failure attribuant l'ID de commentaire manquant.
• Un identifiant qui n'est pas un GUID (get, update, delete): Failure: "Invalid feedback ID format: <id>", vérifié côté client avant tout appel réseau.

Associé

• uip traces spans get — source des valeurs --trace-id/--span-id utilisées ci-dessus.
• Outils (extensions) : installez, mettez à jour, désinstallez le package traces-tool .
• uip login — session utilisée pour authentifier chaque verbe sur cette page.

Voir également

• uip traces