UiPath Documentation
uipath-cli
latest
false
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.

Guía del usuario de UiPath CLI

Agente de UIP

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:

  1. Aplica andamios a un proyecto en el disco con uip agent init.
  2. Autor: actualiza agent.json directamente o a través de los verbos de gestión de recursos (tool, context, escalation, input, output, eval).
  3. Validar el proyecto (uip agent validate): ejecuta comprobaciones estáticas y el proceso de migración de esquema.
  4. 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).
  5. Publica el agente empaquetado en Orchestrator como una versión del paquete de solución (uip agent publish).
  6. 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.
  7. Ejecuta el agente implementado como un trabajo (uip agent run start) y supervísalo (uip agent run status, uip agent run list).
  8. 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

ComandoPropósito
InitAndamiar un nuevo proyecto de agente en el disco (independiente o en línea dentro de un proyecto de flujo).
ConfiguraciónLeer o actualizar las claves en agent.json (model, name, systemPrompt, etc.).
ValidarEstático: comprueba el proyecto y ejecuta el proceso de migración de esquema; escribir de nuevo los archivos migrados.
HerramientaAñadir, descubrir, conectar, enumerar o eliminar herramientas de agente (Integration Service/proceso/flujo de trabajo de API/etc.).
ContextoAñadir, enumerar o eliminar recursos de contexto RAG vinculados a fuentes de índice.
EscalaAñadir, enumerar o eliminar recursos HITL/escalada.
entrada / salidaGestiona los parámetros de esquema de entrada y salida del agente.
EvaluaciónGestiona evaluadores, conjuntos de evaluación, casos de prueba y ejecuciones de evaluación.
PaqueteEmpaqueta el proyecto en un archivo .uis .
PublicarEmpaqueta y envía el agente a Orchestrator como una versión del paquete de solución.
ImplementarInstala y activa una versión de paquete publicada en una carpeta de Orchestrator.
IniciarIniciar, inspeccionar y enumerar trabajos de agente en Orchestrator.
ListaEnumerar las soluciones visibles para el usuario actual en Studio Web.
IncorporarDescarga una solución de Studio Web como archivo .uis .
InsertarImporta un proyecto local a Studio Web.
.xmlEnumerar, descargar y cargar archivos dentro de un proyecto de Studio Web.
CompartirConceder, 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

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado