UIP conversacional

Sintaxis y opciones para `uip conversacional`, que chatea con agentes conversacionales de UiPath implementados y gestiona las conversaciones resultantes: chat, agentes y conversaciones.

uip conversational con agentes conversacionales implementados: procesos implementados por Orchestrator expuestos como una interfaz de chat, creados en el runtime de agente conversacional de UiPath. Esta página cubre el descubrimiento de versiones de agentes (agents), el inicio/gestión de las conversaciones que tienes con ellos (conversations) y el chat en tiempo real (chat). Para obtener el historial de conversaciones, los comentarios, el enrutamiento del canal de voz y la configuración del perfil, consulta Conversacional: intercambios, mensajes, troncales y configuración de usuario.

Conceptos

• Versión de agente : una versión del proceso de Orchestrator implementada que tiene la capacidad de conversación habilitada, identificada por un ID de versión más la carpeta en la que se encuentra. Descubre versiones con agents list.
• Conversación : una sesión persistente contra una versión de agente, creada con conversations create, identificada por un UUID. Toda la actividad de chat ocurre dentro de una conversación.
• Chat frente a conversaciones : conversations create/list/get gestiona el propio registro de conversación (metadatos, etiqueta, entrada del agente); chat es la interacción en vivo y en tiempo real con una conversación existente : primero creas una conversación y luego chat en ella.
• --agent-input en conversations create/update es una cadena JSON que inicializa o actualiza la entrada inicial del agente para la conversación; se envuelve como { inline: <parsed JSON> } antes de enviarse.

Sinopsis

uip conversational chat <conversation-id> [-m, --message <text>]
uip conversational agents list [--folder-id <id>]
uip conversational agents get --release-id <id> --folder-id <id>
uip conversational conversations create --release-id <id> --folder-id <id> [--label <label>] [--autogenerate-label | --no-autogenerate-label] [--agent-input <json>]
uip conversational conversations list [--limit <n>] [--sort-order <order>] [--cursor <token>] [--agent-id <id>] [--agent-key <guid>] [--label <substring>]
uip conversational conversations get <conversation-id>
uip conversational conversations update <conversation-id> [--label <label>] [--autogenerate-label | --no-autogenerate-label] [--agent-input <json>]
uip conversational conversations delete <conversation-id> -y
uip conversational conversations attachments upload <conversation-id> --file <path>
uip conversational conversations attachments get-uri <conversation-id> --file-name <name>

chat conversacional de uip

Interactuar con una conversación existente en tiempo real, ya sea un mensaje de un solo disparo (--message) o un REPL interactivo (omitir --message).

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación (de conversations create/list).

Opciones

Largo	Valor	Descripción
-m, --message <text>	String	Envía un solo mensaje y sale después de que se complete el intercambio (no interactivo). Omitir para iniciar el REPL interactivo en su lugar.

Sin --message, chat requiere un terminal con capacidad de solicitud: falla rápidamente en un entorno no interactivo (CI, salida canalizada) con instrucciones para utilizar --message en su lugar. En REPL, escribe /exit o /quit para finalizar la sesión, o presiona Ctrl+C. Las respuestas de UiPath Assistant se transmiten a stdout token por token; los marcadores de cita en línea ([1], [2], ...) se representan como los flujos de respuesta, y un bloque de nota al pie --- Citations --- con títulos/URL se imprime después de que se complete cada intercambio, deduplicado en toda la sesión.

Ejemplos

# Single-shot message
uip conversational chat b2c3d4e5-0000-0000-0000-000000000001 --message "What's the status of order 4471?"

# Interactive REPL
uip conversational chat b2c3d4e5-0000-0000-0000-000000000001

Este comando transmite texto legible por humanos a stdout en lugar de emitir el sobre --output json habitual de CLI: está diseñado para uso interactivo, no para scripts. Un error de inicio o de mitad de sesión se sigue informando a través del sobre OutputFormatter.error estándar antes de que el proceso salga con un valor distinto de cero.

agentes conversacionales de uip

Inspeccionar las versiones de agente conversacional.

lista de agentes conversacionales de uip

Opciones

Largo	Valor	Descripción
--folder-id <id>	entero positivo	Filtrar agentes conversacionales por carpeta.

Ejemplo

uip conversational agents list --folder-id 123456

Forma de datos (--json de salida)

{
  "Result": "Success",
  "Code": "ConversationalAgentList",
  "Data": [
    {
      "id": 42,
      "releaseKey": "b2c3d4e5-0000-0000-0000-000000000001",
      "name": "Support Assistant",
      "description": "Handles tier-1 support conversations",
      "processVersion": "1.0.0",
      "processKey": "SupportAssistant",
      "folderId": 123456,
      "feedId": "c3d4e5f6-0000-0000-0000-000000000001",
      "createdTime": "2026-08-01T10:00:00Z"
    }
  ]
}

Las claves se mantienen en CamelCase nativo (preserveDataKeys: true), no en PascalCased.

agentes conversacionales de uip get

Opciones

Largo	Valor	Obligatorio	Descripción
--release-id <id>	entero positivo	Sí	ID de versión del agente.
--folder-id <id>	entero positivo	Sí	ID de carpeta que contiene el agente.

Ejemplo

uip conversational agents get --release-id 42 --folder-id 123456

Forma de datos (--json de salida)

{
  "Result": "Success",
  "Code": "ConversationalAgent",
  "Data": {
    "id": 42,
    "releaseKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "name": "Support Assistant",
    "description": "Handles tier-1 support conversations",
    "processVersion": "1.0.0",
    "processKey": "SupportAssistant",
    "folderId": 123456,
    "feedId": "c3d4e5f6-0000-0000-0000-000000000001",
    "createdTime": "2026-08-01T10:00:00Z",
    "appearance": { "...": "agent chat-widget appearance config" }
  }
}

appearance es el único campo que get devuelve más allá de lo que list ya muestra.

conversaciones conversacionales de uip

Crear, enumerar, inspeccionar, actualizar y eliminar conversaciones, además de gestionar sus archivos adjuntos.

creación de conversaciones conversacionales de uip

Opciones

Largo	Valor	Obligatorio	Descripción
--release-id <id>	entero positivo	Sí	ID de una versión habilitada para conversación.
--folder-id <id>	entero positivo	Sí	ID de carpeta que contiene la versión.
--label <label>	String	No	Etiqueta de conversación.
--autogenerate-label	Marca	No	Habilite la generación automática de etiquetas después de que se produzcan intercambios.
--no-autogenerate-label	Marca	No	Deshabilitar la generación automática de etiquetas.
--agent-input <json>	CadenaJson	No	Entrada inicial para el agente: analizada y envuelta como { inline: <value> }. Falla rápidamente en JSON no válido.

Ejemplo

uip conversational conversations create --release-id 42 --folder-id 123456 --label "Order 4471"

Forma de datos (--json de salida)

{
  "Result": "Success",
  "Code": "ConversationCreated",
  "Data": {
    "id": "b2c3d4e5-0000-0000-0000-000000000001",
    "label": "Order 4471",
    "autogenerateLabel": false,
    "agentId": 42,
    "folderId": 123456,
    "agentInput": { "inline": {} },
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001",
    "spanId": "e5f6a7b8",
    "createdTime": "2026-08-01T10:00:00Z",
    "lastActivityTime": "2026-08-01T10:00:00Z"
  }
}

lista de conversaciones conversacionales de uip

Opciones

Largo	Valor	Descripción
--limit <number>	entero positivo	Conversaciones por página.
--sort-order <order>	ascending|descending	Orden de clasificación.
--cursor <token>	String	Cursor de paginación para la página siguiente.
--agent-id <id>	entero positivo	Filtrar por ID de versión de agente.
--agent-key <guid>	String	Filtrar por clave de versión de agente.
--label <substring>	String	Filtrar por subcadena de etiqueta, no distingue entre mayúsculas y minúsculas, 1-100 caracteres.

Ejemplo

uip conversational conversations list --agent-id 42 --limit 20

Forma de datos (--json de salida)

{
  "Result": "Success",
  "Code": "ConversationList",
  "Data": {
    "items": [{ "id": "b2c3d4e5-0000-0000-0000-000000000001", "label": "Order 4471" }],
    "nextCursor": null
  }
}

uip conversaciones conversacionales get

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación.

Ejemplo

uip conversational conversations get b2c3d4e5-0000-0000-0000-000000000001

Forma de datos (--json de salida)

La misma forma que la respuesta de create, Code: "Conversation".

actualización de conversaciones conversacionales de uip

Se requiere al menos una opción: omitir los cuatro falla en el lado del cliente antes de cualquier llamada de red.

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación.

Opciones

Largo	Valor	Descripción
--label <label>	String	Nueva etiqueta de conversación.
--autogenerate-label	Marca	Habilitar la generación automática de etiquetas.
--no-autogenerate-label	Marca	Deshabilitar la generación automática de etiquetas.
--agent-input <json>	CadenaJson	Entrada de agente actualizada: reemplaza el valor completo, envuelto como { inline: <value> }.

Ejemplo

uip conversational conversations update b2c3d4e5-0000-0000-0000-000000000001 --label "Order 4471 (resolved)"

Forma de datos (--json de salida)

La misma forma que la respuesta de create, Code: "ConversationUpdated".

eliminar conversaciones conversacionales de uip

Destructivo: requiere -y/--yes; la CLI nunca solicita.

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación.

Opciones

Largo	Descripción
-y, --yes	Confirme esta operación irreversible. Obligatorio: omitirlo falla antes de cualquier llamada de red.

Ejemplo

uip conversational conversations delete b2c3d4e5-0000-0000-0000-000000000001 -y

Forma de datos (--json de salida)

La misma forma que la respuesta de create, Code: "ConversationDeleted": el último estado conocido de la conversación eliminada.

carga de archivos adjuntos de conversaciones conversacionales de uip

Carga un archivo local como archivo adjunto de conversación.

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación.

Opciones

Largo	Valor	Obligatorio	Descripción
--file <path>	Ruta	Sí	Ruta al archivo local que se va a cargar.

Ejemplo

uip conversational conversations attachments upload b2c3d4e5-0000-0000-0000-000000000001 --file ./invoice.pdf

Forma de datos (--json de salida)

{ "Result": "Success", "Code": "AttachmentUploaded", "Data": { "...": "raw upload result from the conversational-agent SDK" } }

uip conversaciones conversacionales archivos adjuntos get-uri

Obtén un URI de carga prefirmado para un archivo adjunto, sin cargar un archivo local (para cargas fuera de banda).

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación.

Opciones

Largo	Valor	Obligatorio	Descripción
--file-name <name>	String	Sí	Nombre del archivo que aceptará el URI.

Ejemplo

uip conversational conversations attachments get-uri b2c3d4e5-0000-0000-0000-000000000001 --file-name invoice.pdf

Forma de datos (--json de salida)

{ "Result": "Success", "Code": "AttachmentUri", "Data": { "...": "pre-signed URI payload" } }

Relacionado

• Conversacional: intercambios, mensajes, troncales y configuración de usuario : historial de conversación, comentarios, enrutamiento de canal de voz y configuración de perfil.

Ver también

• Opciones globales
• Códigos de salida