Procédures: déployer un agent UiPath

Élaborez, actualisez, validez et envoyez un agent UiPath low-code à Orchestrator à l’aide des outils « agent UiP » et « solution UiP ».

Cette page parcourt le cycle de vie complet d’un agent UiPath low-code à partir de la CLI: élaborationz-le sur le disque, maintenez-le synchronisé, validez-le et examinez-le, puis envoyez-le à Orchestrator à l’aide de uip solution. Il utilise l'outil uip agent , qui est différent de uip codedagent (agents codés basés sur Python).

uip agent n'a pas de pack, publish ou deploy de sa propre commande — un projet d'agent est toujours livré dans le cadre d'une solution. uip agent init gère cela automatiquement: il enregistre automatiquement le nouveau projet dans le .uipx d’une solution voisine, ou élabore un parent <Name>Solution lorsqu’il est exécuté en dehors de celui-ci.

Le cycle de vie

init → refresh → validate → review → (uip solution) pack → publish/upload → deploy

Verbe	Entrée	Sortie	Connexion requise
agent init	Répertoire cible	arborescence de projet d'agent, enregistrée dans une solution	Non (No)
agent refresh	Répertoire du projet	fichiers migrés + entry-points.jsonrégénéré/bindings_v2.json	Non (No)
agent validate	Répertoire du projet	réussite/échec — ne écrit rien	Non (No)
agent review	Répertoire du projet	score, note, problèmes	Non (No)
solution pack	Répertoire de solutions	.zip Paquet	Non (No)
solution publish / solution upload	packagé .zip ou dir de solution	version de package publiée/solution Studio Web	Oui (Yes)
solution deploy run	Package publié	dossier déployé + version	Oui (Yes)

Les verbes locaux (agent init, agent refresh, agent validate, agent review, solution pack) ne nécessitent pas une session active. Tout ce qui concerne Studio Web ou Orchestrator nécessite d'abord uip login .

1. Élaboration

Créez un nouveau projet d'agent avec uip agent init:

uip agent init ./invoice-agent \
  --model gpt-5.4 \
  --system-prompt "You are an invoice triage agent."

Exécutez-le à partir de l’intérieur d’un répertoire de solution existant pour enregistrer le projet, ou exécutez-le de manière autonome - un parent InvoiceAgentSolution/ est construit automatiquement et le projet est imbriqué à l’intérieur. Transmettez --skip-solution-registration pour désactiver les deux comportements.

Cela écrit une arborescence de projet autonome complète:

invoice-agent/
  agent.json
  project.uiproj
  entry-points.json
  flow-layout.json
  evals/
    evaluators/<semantic>.json
    evaluators/<trajectory>.json
    eval-sets/evaluation-set-default.json
  features/
  resources/

Le nom du répertoire devient le nom de l’agent; il doit correspondre à [a-zA-Z0-9_ -]+. Transmettez --force pour écraser un répertoire non vide.

Pour les agents qui résident dans un flux Maestro, utilisez --inline-in-flow à la place, cela génère un sous-dossier nommé par UUID contenant uniquement agent.json et flow-layout.json, sans enregistrement automatique de la solution. Voir init --inline-in-flow.

2. Ressources d’auteur

Il n'existe pas de verbe CLI dédié pour ajouter des outils, des contextes, des escalades ou des entrées de schéma E/S. Créez-les en modifiant directement agent.json (et resources/<name>/resource.json) pour les ressources d'outils basées sur des fichiers. uip agent tool list et uip agent memory sont des outils d’aide à lire/attacher, et non des éditeurs de ressources généraux:

# See what tools are already configured
uip agent tool list --path ./invoice-agent

# Attach a memory space for retrieval-augmented recall
uip agent memory add InvoiceHistory \
  --memory-space invoice-recall --folder-path Shared --path ./invoice-agent

# Check available guardrails before wiring one into agent.json
uip agent guardrails list

Après une modification manuelle vers agent.json, passez à l'étape 3 — actualiser régénère les fichiers dérivés dont dépendent ces modifications.

3. Actualiser et valider

Exécutez uip agent refresh après chaque modification effectuée vers agent.json: elle applique les migrations de schéma en attente et régénère entry-points.json / bindings_v2.json. Il s'agit de la seule commande du cycle de vie qui écrit des fichiers.

uip agent refresh ./invoice-agent

Exécutez ensuite uip agent validate — strict et en lecture seule, il répond « est-ce que Studio Web accepterait ce répertoire tel quel?» sans écrire quoi que ce soit:

uip agent validate ./invoice-agent

Les deux sont en local uniquement (aucune connexion requise). Exécutez refresh puis validate dans CI comme passerelle avant la compression; Ensemble, ils capturent la classe des erreurs (modèle non valide, messages[].contentTokens cassé, entrées required manquantes dans les schémas, fichiers dérivés obsolètes) qui apparaîtront beaucoup plus tard sous la forme d’un échec de téléchargement sombre.

4. Examen

uip agent review exécute un ensemble de règles déterministe pour un score de qualité marqué, distinct de la réussite/l’échec structurel de la validation:

uip agent review ./invoice-agent

Enregistrez éventuellement la note pour le suivi au fil du temps avec uip agent review-history add:

uip agent review-history add A --path ./invoice-agent

5. Déboguer (facultatif)

Avant l’expédition, exécutez l’agent une fois sur Studio Web avec des exemples d’entrées à l’aide de uip agent debug (nécessite une connexion et un manifeste project.uiproj ):

uip agent debug ./invoice-agent -i '{"invoicePath":"/tmp/sample.pdf"}'

6. Livré avec la solution uip

Un projet d'agent est livré dans le cadre de la solution dans laquelle il a été enregistré à l'étape 1. Compressez et publiez (ou téléchargez, pour Studio Web) exactement comme vous le feriez pour n'importe quelle autre solution:

# Pack the solution containing the agent project
uip solution pack ./InvoiceAgentSolution ./dist --version 1.0.0

# Publish the packed .zip to a tenant feed
uip solution publish ./dist/InvoiceAgentSolution_1.0.0.zip

Déployer ensuite dans un dossier Orchestrator:

uip solution deploy run ./dist/InvoiceAgentSolution_1.0.0.zip \
  --folder-name invoice-agent-prod

La redéploiement de la même solution vers le même --folder-name ne met pas à jour le déploiement existant — deploy run en crée toujours un nouveau. Utilisez uip solution deploy upgrade avec la clé de déploiement de uip solution deploy list pour déplacer un déploiement existant vers une nouvelle version de package en place.

Script complet prêt pour le pipeline

#!/usr/bin/env bash
set -euo pipefail

AGENT_DIR="./invoice-agent"
SOLUTION_DIR="./InvoiceAgentSolution"
VERSION="${AGENT_VERSION:-1.0.0}"

# 1. Auth (External App in CI)
uip login \
  --client-id env.UIPATH_CLIENT_ID \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --tenant "$UIPATH_TENANT"

# 2. Refresh + validate locally - fail fast before packing
uip agent refresh "$AGENT_DIR"
uip agent validate "$AGENT_DIR"

# 3. Pack and publish the solution
uip solution pack "$SOLUTION_DIR" ./dist --version "$VERSION"
uip solution publish "./dist/InvoiceAgentSolution_${VERSION}.zip"

# 4. Deploy (or upgrade an existing deployment - see uip solution deploy upgrade)
uip solution deploy run "./dist/InvoiceAgentSolution_${VERSION}.zip" \
  --folder-name "invoice-agent-${ENVIRONMENT}"

Suivez avec une exécution d'évaluation — uip agent eval run start — pour valider le comportement par rapport à un ensemble d'évaluation avant que le déploiement ne soit considéré comme vert.

Voir également

• Vue d’ensemble deuip agent — chaque verbe dans l’outil d’agent.
• uip solution vue d'ensemble - empaquetage, publication et déploiement de la solution dans laquelle se trouve un projet d'agent.
• Authentification : sessions, locataires et préfixe env. .
• Procédures: déployer dans Orchestrator depuis CI — Authentification spécifique à CI, mise en cache, épinglage de version.