- 概要
- はじめに
- 概念
- UiPath CLI を使用する
- UiPath for Coding Agents
- 使用ガイド
- CI/CD レシピ
- コマンド リファレンス
- 概要
- 終了コード
- グローバル オプション
- uip codedagent
- uip docsai
- add-test-data-entity
- テスト データのキューを追加
- 追加-テスト-データ-バリエーション
- 分析
- 開発
- プロジェクトを作成
- 差分
- アクティビティを検索
- GET-ANALYZER-RULES
- get-default-activity-xaml
- エラーを取得
- 手動テスト用のテスト ケースを取得
- 手動テストステップを取得
- get-versions
- Get-workflow-example
- indicate-application
- 要素を示す
- inspect-package
- install-data-fabric-entities
- パッケージのインストールまたは更新
- list-data-fabric-entities
- list-workflow-examples
- パッケージ化
- 元に戻す
- ファイル名を実行
- 検索テンプレート
- スタートスタジオ
- 実行を停止
- UIA
- UIP トレース
- 移行
- 参照とサポート
UiPath CLI ユーザー ガイド
uip agent エージェント ツールであり、 ローコード エージェント (Agent Builder/Studio Web で作成された agent.jsonドリブン プロジェクト) のスキャフォールディング、設定、検証、パッケージ化、運用を行います。uip tools install agentでインストールするか、uip agent … を呼び出して自動インストールを実行します。インストール モデルについては 「ツール (プラグイン)」 を、ツールのインストールを管理するコマンドについては「 uip ツール 」を参照してください。
このツールは、LangGraph/LlamaIndex/OpenAI エージェントで構築された Python エージェントを対象とする コード化されたエージェント ツール (uip codedagentとは異なります。uip agent は、ローコード エージェント プロジェクト ( agent.json、 entry-points.json、 project.uiproj、、 evals/ ツリー、 features/ / resources/ フォルダーを含むディレクトリ) でのみ動作します。
UiPath エージェントとは
ローコード エージェントは、モデル、プロンプト、入出力スキーマ、ツール、コンテキスト、エスカレーション、設定という 1 つの agent.json ファイルで宣言的に記述されます。サポート ファイルには、Studio Web がエージェントを呼び出すために使用するエントリ ポイント、既定の評価セット、RAG/HITL リソースが記述されています。
uip agent でカバーされる一般的なライフサイクルは次のとおりです。
uip agent initを使用してディスク上のプロジェクトをスキャフォールディングします。- 作成者:
agent.jsonを直接またはリソース管理動詞 (tool、context、escalation、input、output、eval) を使用して更新します。 - プロジェクトの検証 (
uip agent validate) — 静的チェックとスキーマ移行パイプラインを実行します。 - プロジェクトを Studio Web にプッシュして Agent Builder の UI に表示するか (
uip agent push)、ローカルで編集を続けて.uisアーカイブ (uip agent packにパックします。 - パックされたエージェントをソリューション パッケージ バージョン (
uip agent publish) として Orchestrator にパブリッシュします。 - パブリッシュしたパッケージをフォルダー (
uip agent deploy) にデプロイする — フォルダーの作成、プロセスのインストール、サーバーレス マシンとロボット ユーザーのプロビジョニング、デプロイのアクティブ化を行います。 - デプロイしたエージェントをジョブとして実行し (
uip agent run start)、監視します (uip agent run status、uip agent run list)。 - 評価セットに照らしてエージェントを評価し (
uip agent eval run start)、結果を確認し (uip agent eval run results)、ベースラインと比較します (uip agent eval run compare)。
プロジェクトを Studio Web との間で往復させる操作では、 push / pull のペアと list / share sharing 動詞を使用します。Studio Web プロジェクト内のファイル レベルの操作は、 uip agent fileを通じて公開されます。
動詞
| コマンド | 目的 |
|---|---|
| Init | 新しいエージェント プロジェクトをディスク上にスキャフォールディングします (スタンドアロン、またはフロー プロジェクト内のインライン)。 |
| Config | agent.json のキー (model、name、systemPromptなど) の読み取りまたは更新を行います。 |
| 検証 | プロジェクトを静的チェックし、スキーマ移行パイプラインを実行する移行したファイルを書き戻します。 |
| ツール | エージェント ツール (Integration Service/プロセス/API ワークフローなど) を追加、検出、接続、一覧表示、削除する |
| コンテキスト | インデックス ソースにバインドされた RAG コンテキスト リソースを追加、一覧表示、削除します。 |
| エスカレーション | HITL/エスカレーション リソースを追加、リスト、削除します。 |
| 入力 / 出力 | エージェントの入力および出力スキーマ パラメーターを管理します。 |
| 評価 | 評価器、評価セット、テスト ケース、評価の実行を管理します。 |
| パッケージ化 | プロジェクトを .uis アーカイブにバンドルします。 |
| パブリッシュ | エージェントをソリューション パッケージ バージョンとして梱包し、Orchestrator にプッシュします。 |
| デプロイ | パブリッシュ済みのパッケージ バージョンを Orchestrator フォルダーにインストールしてアクティベーションします。 |
| 実行 | Orchestrator でエージェント ジョブを開始、検査、および一覧表示します。 |
| リスト (List) | Studio Web で現在のユーザーに表示されるソリューションのリストを取得します。 |
| プル | Studio Web からソリューションを .uis アーカイブとしてダウンロードします。 |
| プッシュ | ローカル プロジェクトを Studio Web にインポートします。 |
| file | Studio Web プロジェクト内のファイルを一覧表示、ダウンロード、アップロードします。 |
| 共有 | Studio Web ソリューションへのユーザー/グループのアクセス権を付与、リスト表示、取り消します。 |
概要
uip agent <verb> [subverb] [arguments] [options]
uip agent <verb> [subverb] [arguments] [options]
常に uip agentし、 uip agents したり uip aしたりすることはありません。agent ツール commandPrefix です ( uip tools listを参照)。
すべての uip agent 動詞は、4 つの グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) に従います。終了コードは共有 コントラクトに従います。
エンドツーエンドのフロー
ゼロから実行中のデプロイ済みのエージェントまでの予想される最小フロー:
# 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
認証
Studio Web または Orchestrator と通信するすべての動詞 (push、 pull、 list、 の share、 publish、 deploy、 run *、 eval run *、 file *) には、有効な CLI セッションが必要です。最初に uip login を実行します。セッションモデルと--login-validityの動作については、認証を参照してください。
ローカル専用動詞 (init、 config、 validate、 pack、 tool、 context、 escalation、 input、 output、 eval add / eval set / eval evaluator) は純粋にファイルを操作するので、セッションは必要ありません。
参照
- 概念: ツール (プラグイン) — プラグインのモデルとバージョンのピン留め。
- 概念: スキル — エージェントがスキルとしてどのように表面化し、スキルがツール リソースとどのように関連しているか。
- 認証 — セッション、テナント、およびフォルダー。
- Orchestrator: ジョブ —
uip agent run委任先の基になるジョブ API です。