UiPath CLI 用户指南
uip agent是智能体工具:它构建、配置、验证、打包和运行低代码智能体,即在 Agent Builder/Studio Web 中创作的agent.json驱动的项目。使用uip tools install agent安装,或调用uip agent …并运行自动安装。有关管理工具安装的命令,请参阅工具(插件)和UIP 工具。
此工具与编码智能体工具 ( uip codedagent ) 不同,后者针对的是使用 LangGraph/LlamaIndex/OpenAI 智能体构建的 Python 智能体。uip agent仅作用于低代码智能体项目:包含agent.json 、 entry-points.json 、 project.uiproj 、 evals/树和features/ / resources/文件夹的目录。
什么是 UiPath 智能体
低代码智能体由单个agent.json文件以声明方式进行描述 — 模型、提示、输入/输出架构、工具、上下文、升级和设置。支持文件描述了 Studio Web 用于调用智能体、默认评估集以及任何 RAG/HITL 资源的入口点。
uip agent涵盖的典型生命周期为:
- 使用
uip agent init在磁盘上构建项目。 - 作者:直接或通过资源管理动词(
tool、context、escalation、input、output、eval)更新agent.json。 - 验证项目 (
uip agent validate) — 运行静态检查和架构迁移管道。 - 将项目推送到 Studio Web 中,使其显示在 Agent Builder 用户界面中 (
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共享动词。Studio Web 项目中的文件级操作通过uip agent file公开。
动词
| 命令 | 用途 |
|---|---|
| 初始化 | 在磁盘上构建新的智能体项目(独立或内联在流程项目中)。 |
| 配置 | 读取或更新agent.json ( model 、 name和systemPrompt等)中的密钥。 |
| 验证 | 静态检查项目并运行架构迁移管道;写回已迁移的文件。 |
| 工具 | 添加、发现、连接、列出或删除智能体工具(Integration Service/流程/API 工作流等)。 |
| 上下文 | 添加、列出或删除绑定到索引源的 RAG 上下文资源。 |
| 升级 | 添加、列出或删除 HITL/升级资源。 |
| 输入/输出 | 管理智能体的输入和输出架构参数。 |
| 评估 | 管理评估程序、评估集、测试用例和评估运行。 |
| 打包 | 将项目捆绑到.uis存档中。 |
| 发布 | 打包智能体并将其作为解决方案包版本推送到 Orchestrator。 |
| 部署 | 在 Orchestrator 文件夹中安装并激活已发布的包版本。 |
| 运行 | 在 Orchestrator 上启动、检查和列出智能体作业。 |
| 列表 | 列出 Studio Web 中当前用户可见的解决方案。 |
| 拉取 | 从 Studio Web 将解决方案下载为.uis存档。 |
| 推送 | 将本地项目导入 Studio Web。 |
| 文件 | 列出、下载和上传 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 )。
端到端流程
从零到正在运行的已部署智能体的最小预期流程:
# 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。