UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Comentarios de seguimientos de UIP

Sintaxis y opciones para `comentarios de seguimientos de UIP`, que crea y gestiona comentarios de observabilidad de LLM adjuntos a un seguimiento o intervalo.

uip traces feedback gestiona los comentarios de observabilidad de LLM: una calificación positiva/negativa, un comentario y etiquetas de categoría adjuntas a un seguimiento o intervalo. Úsalo para registrar la revisión humana de la salida de un agente, o para extraer comentarios grabados para informar.

Esta página forma parte de la herramienta uip traces — consulta esa página para spans get.

Sinopsis​

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
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

Todos los verbos respetan las opciones globales y los códigos de salida estándar.

creación de comentarios de seguimientos de uip​

Crear comentarios para un seguimiento (o un intervalo específico dentro de él).

Opciones​

MarcaDescripción
--trace-id <id>Obligatorio. ID de seguimiento (32 caracteres hexadecimales o GUID).
--positive / --negativeObligatorio: exactamente uno. Sentimiento de los comentarios.
--folder-key <guid>Obligatorio. Clave de carpeta de Orchestrator.
--span-id <id>ID de intervalo. Cuando se omite, se establece de forma predeterminada en el intervalo raíz del seguimiento.
--comment <text>Anotación de texto libre (máx. 1 048 576 caracteres). Mutuamente exclusivo con --comment-file.
--comment-file <path>Leer el comentario de un archivo; pasar - para leer desde la entrada estándar. Mutuamente exclusivo con --comment.
--category <tag>Etiqueta de categoría. Repetible. La plataforma reconoce etiquetas integradas como Output, Agent Error y Agent Plan Execution, pero se acepta cualquier cadena.
--agent-id <guid>ID de referencia del agente.
--agent-version <str>Versión del agente (máx. 100 caracteres).

Ejemplo​

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

Forma de datos​

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

Data es una transferencia no modificada de lo que devuelve la API de comentarios: la CLI no lo proyecta en un conjunto de campos fijos, por lo que la respuesta real puede contener más campos de los que se muestran aquí.

Obtener comentarios de seguimientos de UIP​

Obtenga un único registro de comentarios por ID.

Argumentos​

  • <id> obligatorio) : ID de registro de comentarios (GUID). Falla en el lado del cliente con "Formato de ID de comentarios no válido" si no es un GUID.

Opciones​

MarcaDescripción
--folder-key <guid>Clave de carpeta de Orchestrator. El servidor generalmente requiere esto para autorizar la lectura, aunque la CLI no falla sin ella en el lado del cliente.

Ejemplo​

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

Forma de datos​

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

Al igual que create, Data es una transferencia sin procesar: la respuesta real suele contener más campos (comentario, metadatos, categorías, marcas de tiempo) de los que muestra este ejemplo mínimo.

lista de comentarios de seguimientos de uip​

Enumerar entradas de comentarios, filtradas por seguimiento, intervalo, agente, estado o opinión.

Opciones​

MarcaDescripción
--agent-id <guid>Filtrar por ID de agente.
--agent-version <str>Filtrar por versión de agente.
--trace-id <id>Filtrar por ID de seguimiento.
--span-id <id>Filtrar por ID de intervalo.
--status <value>Filtrar por estado: Pending, Approved, Dismissed. Repetible.
--positive / --negativeDevolver solo comentarios positivos o solo negativos. Mutuamente excluyentes.
--limit <n>Resultados máximos. El valor predeterminado es 20, con un límite de 100.
--offset <n>Resultados para omitir. El valor predeterminado es 0.
--folder-key <guid>Clave de carpeta de Orchestrator.

Ejemplo​

uip traces feedback list --trace-id 4bf92f3577b34da6a3ce929d0e0e4736
uip traces feedback list --trace-id 4bf92f3577b34da6a3ce929d0e0e4736

Forma de datos​

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

Un resultado vacío imprime "No se encontraron comentarios. Utilice 'uip traces feedback create' para añadir comentarios."

lista de comentarios de seguimientos de uip detallada​

Enumerar comentarios con filtros extendidos (ventana de tiempo, categoría, ordenación) y contexto de intervalo. Este es un subcomando de list, no un verbo de nivel superior: la invocación es uip traces feedback list detailed, con el espacio, no list-detailed.

Opciones​

MarcaDescripción
--agent-id <guid>Filtrar por ID de agente.
--agent-version <str>Filtrar por versión de agente.
--trace-id <id>Filtrar por ID de seguimiento.
--span-id <id>Filtrar por ID de intervalo.
--status <value>Filtrar por estado: Pending, Approved, Dismissed. Repetible.
--positive / --negativeDevolver solo comentarios positivos o solo negativos. Mutuamente excluyentes.
--category-id <guid>Filtrar por ID de categoría. Repetible.
--after <iso>Creado después de esta marca de tiempo ISO 8601.
--before <iso>Creado antes de esta marca de tiempo ISO 8601.
--since <duration>Abreviatura relativa para --after — por ejemplo, 1h, 24h, 7d. Solo se aceptan unidades de h (horas) y d (días).
--sort-by <field>Ordenar campo: createdAt o updatedAt. El valor predeterminado es createdAt.
--sort-order <dir>Dirección de ordenación: asc o desc. El valor predeterminado es desc.
--limit <n>Resultados máximos. El valor predeterminado es 20, con un límite de 200 (más alto que el límite simple de list de 100).
--offset <n>Resultados para omitir. El valor predeterminado es 0.
--folder-key <guid>Clave de carpeta de Orchestrator.
Nota:

--since y --after establecen el mismo filtro de hora de inicio subyacente: --since se evalúa en relación con "ahora" en el momento en que se ejecuta el comando.

Ejemplo​

uip traces feedback list detailed --since 24h
uip traces feedback list detailed --since 24h

Forma de datos​

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

La respuesta de la API subyacente está paginada ({ items, totalCount }), pero la CLI solo emite la matriz items como Data: el recuento total de coincidencias (totalCount) no se muestra. Para saber si existen más resultados más allá de --limit, compara el recuento devuelto con --limit en lugar de confiar en un total.

Actualización de comentarios de seguimientos de UIP​

Actualizar la opinión, el comentario, los metadatos o las categorías de un registro de comentarios existente.

Importante:

La API reemplaza todo el registro en lugar de parchearlo, por lo que la CLI lee primero el registro existente y transfiere cualquier campo que no se haya aprobado, excepto --category: omitirlo deja intactas las categorías existentes, pero esta lectura y escritura es no atómico. Un aterrizaje de edición concurrente entre la lectura y la escritura se pierde silenciosamente.

Argumentos​

  • <id> obligatorio) : ID de registro de comentarios (GUID).

Opciones​

MarcaDescripción
--positive / --negativeObligatorio: exactamente uno. Nuevo sentimiento.
--folder-key <guid>Obligatorio. Clave de carpeta de Orchestrator.
--comment <text>Comentario actualizado (máx. 1 048 576 caracteres). Mutuamente exclusivo con --comment-file. Omitir para mantener el comentario existente.
--comment-file <path>Leer el comentario actualizado de un archivo; pasar - para la entrada estándar. Mutuamente exclusivo con --comment.
--metadata <json>Metadatos actualizados; debe ser un JSON válido (máx. 1 048 576 caracteres). Mutuamente exclusivo con --metadata-file. Omitir para mantener los metadatos existentes.
--metadata-file <path>Leer metadatos actualizados de un archivo; pasar - para la entrada estándar. Mutuamente exclusivo con --metadata.
--category <tag>Etiquetas de categoría de reemplazo. Repetible. Omitir por completo para dejar las categorías existentes como están: pasarlo reemplaza el conjunto completo, no se fusiona.

Ejemplos​

# 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
# 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

Forma de datos​

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

eliminación de comentarios de seguimientos de uip​

Eliminar un registro de comentarios por ID. Esta es una operación destructiva : requiere -y, --yes; la CLI nunca solicita.

Argumentos​

  • <id> obligatorio) : ID de registro de comentarios (GUID).

Opciones​

MarcaDescripción
--folder-key <guid>Obligatorio. Clave de carpeta de Orchestrator.
-y, --yesConfirme esta operación irreversible. Obligatorio: la CLI nunca solicita.

Ejemplo​

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

Forma de datos​

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

Comportamiento de error​

  • 401 de la API de comentarios: 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 nombrando el ID de comentario que falta.
  • Un ID que no es un GUID (get, update, delete): Failure: "Invalid feedback ID format: <id>", comprobado en el lado del cliente antes de cualquier llamada de red.

Ver también​

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado