- Información general
- Comience ya
- Conceptos
- Uso de UiPath CLI
- UiPath para agentes de codificación
- Guías prácticas
- Recetas de CI/CD
- Referencia de los comandos
- Información general
- Códigos de salida
- Opciones globales
- agente de código UIP
- UIP Docsai
- añadir-entidad-de-datos-de-prueba
- añadir-cola-de-datos-de-prueba
- añadir-variación-de-datos-de-prueba
- Analizar
- Crear
- Crear proyecto
- Diferencia
- Buscar actividades
- obtener-reglas-del-analizador
- obtener-predeterminado-actividad-xaml
- obtener-errores
- obtener-casos-de-prueba-manual
- obtener-pasos-de-prueba-manual
- obtener versiones
- get-workflow-example
- indicar-aplicación
- indicar-elemento
- inspeccionar-paquete
- install-data-fabric-entities
- instalar-o-actualizar-paquetes
- enumerar-data-fabric-entities
- ejemplos-de-flujo-de-trabajo-de-lista
- Paquete
- restore
- archivo de ejecución
- plantillas-de-búsqueda
- iniciar-studio
- detener la ejecución
- UIA
- Seguimientos de UIP
- Migración
- Referencia y soporte
Guía del usuario de UiPath CLI
uip agent es la herramienta Agente: andamia, configura, valida, empaqueta y opera agentes de bajo código : los proyectos impulsados por agent.jsoncreados en Agent Builder/Studio Web. Instálalo con uip tools install agent o invoca uip agent … y deja que se ejecute la instalación automática. Consulta Herramientas (complementos) para el modelo de instalación y herramientas uip para el comando que gestiona la instalación de herramientas.
Esta herramienta es distinta de la herramienta de agente codificada (uip codedagent), que se dirige a agentes Python creados con agentes LangGraph/LlamaIndex/OpenAI. uip agent solo funciona en proyectos de agente de código bajo: un directorio que contiene agent.json, entry-points.json, project.uiproj, un árbol evals/ y carpetas features/ / resources/ .
Qué es un agente de UiPath
Un agente de código bajo se describe de forma declarativa mediante un único archivo agent.json : modelo, solicitudes, esquemas de entrada/salida, herramientas, contextos, escaladas y configuración. Los archivos compatibles describen los puntos de entrada que Studio Web utiliza para invocar el agente, el conjunto de evaluación predeterminado y cualquier recurso RAG/HITL.
El ciclo de vida típico cubierto por uip agent es:
- Aplica andamios a un proyecto en el disco con
uip agent init. - Autor: actualiza
agent.jsondirectamente o a través de los verbos de gestión de recursos (tool,context,escalation,input,output,eval). - Validar el proyecto (
uip agent validate): ejecuta comprobaciones estáticas y el proceso de migración de esquema. - Inserta el proyecto en Studio Web para que aparezca en la IU de Agent Builder (
uip agent push), o sigue editándolo localmente y empaquetándolo en un archivo.uis(uip agent pack). - Publica el agente empaquetado en Orchestrator como una versión del paquete de solución (
uip agent publish). - Implementar el paquete publicado en una carpeta (
uip agent deploy): esto crea la carpeta, instala el proceso, aprovisiona una máquina sin servidor y un usuario de robot, y activa la implementación. - Ejecuta el agente implementado como un trabajo (
uip agent run start) y supervísalo (uip agent run status,uip agent run list). - Evalúa el agente en comparación con un conjunto de evaluación (
uip agent eval run start), revisa los resultados (uip agent eval run results) y compara con una base de referencia (uip agent eval run compare).
Las operaciones que realizan el viaje de ida y vuelta de un proyecto hacia y desde Studio Web utilizan el par push / pull y los verbos de uso compartido list / share . Las operaciones a nivel de archivo dentro de un proyecto de Studio Web se exponen a través de uip agent file.
Verbos
| Comando | Propósito |
|---|---|
| Init | Andamiar un nuevo proyecto de agente en el disco (independiente o en línea dentro de un proyecto de flujo). |
| Configuración | Leer o actualizar las claves en agent.json (model, name, systemPrompt, etc.). |
| Validar | Estático: comprueba el proyecto y ejecuta el proceso de migración de esquema; escribir de nuevo los archivos migrados. |
| Herramienta | Añadir, descubrir, conectar, enumerar o eliminar herramientas de agente (Integration Service/proceso/flujo de trabajo de API/etc.). |
| Contexto | Añadir, enumerar o eliminar recursos de contexto RAG vinculados a fuentes de índice. |
| Escala | Añadir, enumerar o eliminar recursos HITL/escalada. |
| entrada / salida | Gestiona los parámetros de esquema de entrada y salida del agente. |
| Evaluación | Gestiona evaluadores, conjuntos de evaluación, casos de prueba y ejecuciones de evaluación. |
| Paquete | Empaqueta el proyecto en un archivo .uis . |
| Publicar | Empaqueta y envía el agente a Orchestrator como una versión del paquete de solución. |
| Implementar | Instala y activa una versión de paquete publicada en una carpeta de Orchestrator. |
| Iniciar | Iniciar, inspeccionar y enumerar trabajos de agente en Orchestrator. |
| Lista | Enumerar las soluciones visibles para el usuario actual en Studio Web. |
| Incorporar | Descarga una solución de Studio Web como archivo .uis . |
| Insertar | Importa un proyecto local a Studio Web. |
| .xml | Enumerar, descargar y cargar archivos dentro de un proyecto de Studio Web. |
| Compartir | Conceder, enumerar o revocar el acceso de usuario/grupo a una solución de Studio Web. |
Sinopsis
uip agent <verb> [subverb] [arguments] [options]
uip agent <verb> [subverb] [arguments] [options]
Siempre uip agent, nunca uip agents o uip a. agent es el commandPrefix de la herramienta (ver uip tools list).
Todos los verbos uip agent respetan las cuatro opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato compartido.
Flujo de extremo a extremo
El flujo mínimo esperado de cero a un agente implementado en ejecución:
# 1. Scaffold
uip agent init ./my-agent --model gpt-4o-2024-11-20
# 2. Validate (run after any edit to agent.json)
uip agent validate ./my-agent
# 3a. Iterate in Studio Web (optional)
uip agent push ./my-agent
# …edit in Studio Web, then pull back:
uip agent pull <solutionId> -d ./downloads --extract
# 3b. Or pack locally for inspection
uip agent pack ./my-agent -d ./dist
# 4. Publish to Orchestrator
uip agent publish ./my-agent --package-version 1.0.0
# → captures PackageVersionKey
# 5. Deploy to a folder (auto-creates folder + provisions machine and user)
uip agent deploy <PackageVersionKey> --name invoice-agent
# 6. Find the release, then run
uip agent run list --folder-id <FolderId>
uip agent run start <ReleaseKey> -i '{"input":"hello"}'
uip agent run status <JobId>
# 7. Evaluate (push must have happened first — eval runs against the cloud project)
uip agent eval run start --set default --path ./my-agent --wait
# 1. Scaffold
uip agent init ./my-agent --model gpt-4o-2024-11-20
# 2. Validate (run after any edit to agent.json)
uip agent validate ./my-agent
# 3a. Iterate in Studio Web (optional)
uip agent push ./my-agent
# …edit in Studio Web, then pull back:
uip agent pull <solutionId> -d ./downloads --extract
# 3b. Or pack locally for inspection
uip agent pack ./my-agent -d ./dist
# 4. Publish to Orchestrator
uip agent publish ./my-agent --package-version 1.0.0
# → captures PackageVersionKey
# 5. Deploy to a folder (auto-creates folder + provisions machine and user)
uip agent deploy <PackageVersionKey> --name invoice-agent
# 6. Find the release, then run
uip agent run list --folder-id <FolderId>
uip agent run start <ReleaseKey> -i '{"input":"hello"}'
uip agent run status <JobId>
# 7. Evaluate (push must have happened first — eval runs against the cloud project)
uip agent eval run start --set default --path ./my-agent --wait
Autenticación
Cada verbo que se comunica con Studio Web u Orchestrator (push, pull, list, share, publish, deploy, run *, eval run *, file *) requiere una CLI válida sesión. Ejecuta uip login primero. Consulta Autenticación para el modelo de sesión y el comportamiento --login-validity .
Verbos solo locales (init, config, validate, pack, tool, context, escalation, input, output, eval add / eval set / eval evaluator) operan exclusivamente en archivos y no requieren una sesión.
Ver también
- Conceptos: herramientas (complementos) : el modelo de complemento y la fijación de versiones.
- Conceptos: habilidades : cómo los agentes emergen como habilidades y cómo las habilidades se relacionan con los recursos de herramientas.
- Autenticación : sesiones, tenants y carpetas.
- Orchestrator: trabajos : las API de trabajo subyacentes en las que
uip agent rundelega.