UiPath Documentation
uipath-cli
latest
false
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

Guide de l'utilisateur de UiPath CLI

Agent UIP

uip agent est l'outil Agent: il élabore, configure, valide, empaquete et exploite des agents low-code — les projets pilotés par agent.jsoncréés dans Agent Builder/Studio Web. Installez-le avec uip tools install agent, ou invoquez uip agent … et laissez l'installation automatique s'exécuter. Voir Outils pour le modèle d'installation et Outils uip pour la commande qui gère l'installation de l'outil.

Cet outil est distinct de l'outil d'agent codé (uip codedagent), qui cible les agents Python créés avec les agents LangGraph/LlamaIndex/OpenAI. uip agent fonctionne uniquement sur les projets d'agent low-code: un répertoire contenant agent.json, entry-points.json, project.uiproj, une arborescence evals/ et des dossiers features/ / resources/ .

Qu’est-ce qu’un agent UiPath?

Un agent low-code est décrit de manière déclarative par un seul fichier agent.json — modèle, invites, schémas d'entrée/sortie, outils, contextes, escalades et paramètres. Les fichiers d'assistance décrivent les points d'entrée que Studio Web utilise pour invoquer l'agent, l'ensemble d'évaluations par défaut et toutes les ressources RAG/HITL.

Le cycle de vie type couvert par uip agent est:

  1. Élaborez un projet sur le disque avec uip agent init.
  2. Auteur: mettez à jour agent.json directement ou via les verbes de gestion des ressources (tool, context, escalation, input, output, eval).
  3. Validez le projet (uip agent validate) — exécute des vérifications statiques et le pipeline de migration du schéma.
  4. Envoyez le projet dans Studio Web afin qu'il apparaisse dans l'interface utilisateur d'Agent Builder (uip agent push), ou continuez à le modifier localement et compressez -le dans une archive .uis (uip agent pack).
  5. Publiez l'agent compressé dans Orchestrator sous forme de version package de solution (uip agent publish).
  6. Déployez le package publié dans un dossier (uip agent deploy): Cela crée le dossier, installe le processus, enregistre une machine et un utilisateur de robot sans serveur et active le déploiement.
  7. Exécutez l'agent déployé sous forme de tâche (uip agent run start) et surveillez-le (uip agent run status, uip agent run list).
  8. Évaluez l'agent par rapport à un ensemble d'évaluation (uip agent eval run start), examinez les résultats (uip agent eval run results) et comparez-les par rapport à une base de référence (uip agent eval run compare).

Les opérations qui vont parcourir un projet vers et depuis Studio Web utilisent la paire push / pull et les verbes de partage list / share . Les opérations au niveau du fichier dans un projet Studio Web sont exposées via uip agent file.

Verbes

CommandeObjectif
InitÉlaborez un nouveau projet d’agent sur disque (autonome ou en ligne dans un projet de flux).
ConfigurationLisez ou mettez à jour les clés dans agent.json (model, name, systemPrompt, etc.).
ValiderVérifiez le projet de façon statique et exécutez le pipeline de migration du schéma; réécrire les fichiers migrés.
OutilAjouter, découvrir, connecter, répertorier ou supprimer des outils d’agent (Integration Service/processus/workflow d’API/etc.).
ContexteAjoutez, répertoriez ou supprimez des ressources de contexte RAG liées à des sources d’index.
EscaladeAjoutez, répertoriez ou supprimez HITL/des ressources d’escalade.
entrée / sortieGérez les paramètres du schéma d’entrée et de sortie de l’agent.
ÉvaluationGérez les évaluateurs, les ensembles d’évaluation, les cas de test et les exécutions d’évaluation.
Créer un packageRegroupez le projet dans une archive .uis .
PublierCréez le package et envoyez l’agent vers Orchestrator sous forme de version de package de solution.
DéployerInstallez et activez une version de package publiée dans un dossier Orchestrator.
ExécuterDémarrer, inspecter et répertorier les tâches de l'agent sur Orchestrator.
ListRépertoriez des solutions visibles par l’utilisateur actuel dans Studio Web.
TransmettreTéléchargez une solution depuis Studio Web en tant qu'archive .uis .
TransmettreImportez un projet local dans Studio Web.
FichierRépertorier, télécharger et charger des fichiers dans un projet Studio Web.
PartageAccorder, répertorier ou révoquer l'accès d'un utilisateur/d'un groupe à une solution Studio Web.

Synthèse

uip agent <verb> [subverb] [arguments] [options]
uip agent <verb> [subverb] [arguments] [options]

Toujours uip agent, jamais uip agents ou uip a. agent est le commandPrefix de l'outil (voir uip tools list).

Tous les verbes uip agent respectent les quatre options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat partagé.

Flux de bout en bout

Le flux minimal attendu de zéro vers un agent déployé en cours d'exécution:

# 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

Authentification

Chaque verbe qui traite de Studio Web ou d'Orchestrator (push, pull, list, share, publish, deploy, run *, eval run *, file *) nécessite une CLI valide session. Exécutez d'abord uip login . Voir Authentification pour le modèle de session et --login-validity comportement.

Verbes uniquement locaux (init, config, validate, pack, tool, context, escalation, input, output, eval add / eval set / eval evaluator) fonctionnent uniquement sur des fichiers et ne nécessitent pas de session.

Voir également

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour