UiPath Documentation
uipath-cli
latest
false
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UiPath-CLI-Benutzerhandbuch

UIP-Agent

uip agent ist das Agent-Tool: Es erstellt, konfiguriert, validiert, verpackt und führt Low-Code-Agents aus – die agent.json-gesteuerten Projekte, die in Agent Builder/Studio Web erstellt wurden. Installieren Sie es mit uip tools install agent oder rufen Sie uip agent … auf und lassen Sie die automatische Installation ausführen. Das Installationsmodell finden Sie unter Tools (Plugins) und unter UIP-Tools finden Sie den Befehl, der die Toolinstallation verwaltet.

Dieses Tool unterscheidet sich vom codierten Agent- Tool (uip codedagent), das auf Python-Agents abzielt, die mit LangGraph/LlamaIndex/OpenAI Agents erstellt wurden. uip agent funktioniert nur bei Low-Code-Agent-Projekten: ein Verzeichnis, das agent.json, entry-points.json, project.uiproj, eine evals/ -Struktur und die Ordner features/ / resources/ enthält.

Was ein UiPath-Agent ist

Ein Low-Code-Agent wird deklarativ durch eine einzelne agent.json -Datei beschrieben – Modell, Prompts, Eingabe-/Ausgabeschemata, Tools, Kontexte, Eskalationen und Einstellungen. Unterstützende Dateien beschreiben die Einstiegspunkte, die Studio Web zum Aufrufen des Agents, des Standardauswertungssatzes und etwaiger RAG/HITL-Ressourcen verwendet.

Der typische Lebenszyklus, der von uip agent abgedeckt wird, ist:

  1. Erstellen Sie mit uip agent init ein Gerüst für ein Projekt auf der Festplatte.
  2. Autor: Aktualisieren Sie agent.json direkt oder über die Ressourcenverwaltungsverben (tool, context, escalation, input, output, eval).
  3. Das Projekt validieren (uip agent validate) – führt statische Prüfungen und die Schemamigrationspipeline aus.
  4. Pushen Sie das Projekt in Studio Web, sodass es in der Agent Builder-Benutzeroberfläche angezeigt wird (uip agent push), oder bearbeiten Sie es lokal weiter und packen Sie es in ein .uis -Archiv (uip agent pack).
  5. Veröffentlichen Sie den gepackten Agent als Lösungspaketversion (uip agent publish) in Orchestrator.
  6. Bereitstellen des veröffentlichten Pakets in einem Ordner (uip agent deploy) – Dadurch wird der Ordner erstellt, der Prozess installiert, eine serverlose Maschine und ein Roboterbenutzer bereitgestellt und die Bereitstellung aktiviert.
  7. Führen Sie den bereitgestellten Agent als Auftrag aus (uip agent run start) und überwachen Sie ihn (uip agent run status, uip agent run list).
  8. Evaluieren Sie den Agent anhand eines Evaluierungssatzes (uip agent eval run start), überprüfen Sie Ergebnisse (uip agent eval run results) und vergleichen Sie ihn mit einer Basis (uip agent eval run compare).

Vorgänge, die ein Projekt zu und von Studio Web weiterleiten, verwenden das Paar push / pull und die Freigabeverben list / share . Vorgänge auf Dateiebene innerhalb eines Studio Web-Projekts werden über uip agent file verfügbar gemacht.

Verben

BefehlZweck
InitErstellen Sie ein Gerüst für ein neues Agent-Projekt auf der Festplatte (eigenständig oder inline innerhalb eines Flow-Projekts).
Konfig.Lesen oder aktualisieren Sie Schlüssel in agent.json (model, name, systemPrompt usw.).
ÜberprüfenStatische-Prüfen des Projekts und Ausführen der Schema-Migrationspipeline; migrierte Dateien zurückschreiben.
ToolHinzufügen, Entdecken, Verbinden, Auflisten oder Entfernen von Agent-Tools (Integration Service/Prozess/API Workflow usw.).
KontextHinzufügen, Auflisten oder Entfernen von RAG-Kontextressourcen, die an Indexquellen gebunden sind.
EskalationHinzufügen, Auflisten oder Entfernen von HITL/Eskalationsressourcen.
Eingabe / AusgabeVerwalten Sie die Parameter des Eingabe- und Ausgabeschemas des Agents.
AuswertungVerwalten Sie Auswerter, Auswertungssätze, Testfälle und Auswertungsausführungen.
PackenPaketieren Sie das Projekt in einem .uis -Archiv.
VeröffentlichenPacken und pushen Sie den Agent als Lösungspaketversion in Orchestrator.
BereitstellenInstallieren und aktivieren Sie eine veröffentlichte Paketversion in einem Orchestrator-Ordner.
AusführenStarten, Überprüfen und Auflisten von Agentenaufträgen im Orchestrator.
ListeListen Sie Lösungen auf, die für den aktuellen Benutzer in Studio Web sichtbar sind.
Pull ausführenLaden Sie eine Lösung von Studio Web als .uis -Archiv herunter.
Verschieben (Push)Importieren Sie ein lokales Projekt in Studio Web.
DateiAuflisten, Herunterladen und Hochladen von Dateien innerhalb eines Studio Web-Projekts.
TeilenBenutzer-/Gruppenzugriff auf eine Studio Web-Lösung gewähren, auflisten oder widerrufen.

Zusammenfassung

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

Immer uip agent, nie uip agents oder uip a. agent ist der commandPrefix des Tools (siehe uip tools list).

Alle uip agent -Verben berücksichtigen die vier globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem gemeinsamen Vertrag.

End-to-End-Flow

Der minimal erwartete Fluss von Null zu einem laufenden bereitgestellten Agent:

# 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

Authentication

Jedes Verb, das mit Studio Web oder Orchestrator kommuniziert (push, pull, list, share, publish, deploy, run *, eval run *, file *), erfordert eine gültige CLI Sitzung. Führen Sie zuerst uip login aus. Siehe Authentifizierung für das Sitzungsmodell und das --login-validity -Verhalten.

Nur lokale Verben (init, config, validate, pack, tool, context, escalation, input, output, eval add / eval set / eval evaluator) arbeiten ausschließlich mit Dateien und erfordern keine Sitzung.

Siehe auch

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben