UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

UIP 智能体

使用框架工具“uip agent”工具对低代码智能体进行验证、刷新、审核和管理。

uip agent是智能体工具:它构建、验证、迁移和审核低代码智能体,即在 Agent Builder/Studio Web 中编写的agent.json驱动的项目。使用 uip tools install agent 安装,或调用 uip agent … 并运行自动安装。有关管理工具安装的命令,请参阅工具(插件)UIP 工具

此工具与编码智能体工具 ( uip codedagent ) 不同,后者针对的是使用 LangGraph/LlamaIndex/OpenAI 智能体构建的 Python 智能体。uip agent 仅作用于低代码智能体项目:一个包含 agent.jsonentry-points.jsonproject.uiproj 的目录、一个 evals/ 树和 features//resources/ 文件夹 — 或者,对于嵌入到Maestro Flow,这是流程项目 (--inline-in-flow) 中以 UUID 命名的子目录。

uip agent没有packpublishdeploypushpullrunlistsharefileconfigcontextescalationinputoutput命令 — 而打包和发布智能体项目将通过uip solution (智能体项目是解决方案中的一个项目)。资源创作(工具、上下文、升级、I/O 架构)是通过手动编辑 agent.json 来完成的,而不是通过专用的 CLI 动词完成。

什么是 UiPath 智能体

低代码智能体由单个agent.json文件以声明方式进行描述 — 模型、提示、输入/输出架构、工具、上下文、升级和设置。支持文件描述了 Studio Web 用于调用智能体、默认评估集以及任何 RAG/HITL 资源的入口点。

uip agent涵盖的实际生命周期是:

  1. 使用uip agent init (独立,或--inline-in-flow在 Maestro Flow 项目中)在磁盘上构建项目。默认情况下,项目会自动注册到周围解决方案的 .uipx 中,如果不存在 <Name>Solution,则会自动构建新的 。
  2. 通过手动编辑agent.json进行创作(以及resources/evals/下的文件)。
  3. 每次编辑后刷新项目 ( uip agent refresh ) — 应用待处理架构迁移并重新生成entry-points.json / bindings_v2.json 。这是写入派生文件的唯一命令。
  4. 验证项目 ( uip agent validate ) — 严格,只读:回答“Studio Web 是否会按原样接受此目录?”无需编写任何内容。
  5. 根据确定性规则集 ( uip agent review )审核项目,以获得评分质量判定,并可选择记录一段时间内的分数 ( uip agent review-history add )。
  6. 根据需要配置LLM 模型 ( uip agent model list )、内存空间 ( uip agent memory )、护栏 ( uip agent guardrails ) 和工具 ( uip agent tool list )。
  7. 在 Studio Web ( uip agent debug ) 中调试智能体,以便在发布前与示例输入一起运行端到端运行。
  8. uip solution pack /publish /upload /deployuip agent 一起 发布 — 自己没有打包或部署谓词。
  9. 根据评估集 ( uip agent eval run start )评估智能体 — 适用于云推送的解决方案( --solution-id或从SolutionStorage.json自动检测到),或者,当两者都不可用时,则适用于隐式本地工作区评估路径。

动词

命令用途
初始化在磁盘上构建新的智能体项目(独立或内联在流程项目中)。
验证严格只读检查:Studio Web 是否会按原样接受此项目?
refresh应用待处理架构迁移并重新生成 entry-points.json / bindings_v2.json
审核根据确定性规则集(非确定性规则集、分数、分数、问题)对项目进行评分。
审核历史记录在项目的本地审核历史文件中记录审核分数。
工具列表列出智能体上配置的工具资源。
内存附加、列出和移除记忆空间和记忆项目。
评估管理评估程序、评估集、测试用例和评估运行。
防护机制列出防护栏定义、BYOG 防护栏、LLM-as-judge 模型和防护栏目录。
model列出经过身份验证的租户可用的 LLM 模型。
调试使用示例输入针对 Studio Web 运行智能体,并流式传输结果。

大纲

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

始终使用uip agent ,从不使用uip agentsuip aagent是工具的commandPrefix (请参阅uip tools list )。

所有uip agent动词都遵循四个全局选项--output--output-filter--log-level--log-file )。退出代码遵循共享合同

端到端流程

# 1. Scaffold (auto-registers into the surrounding solution, or creates one)
uip agent init ./my-agent --model gpt-5.4

# 2. Refresh after any edit to agent.json (migrates + regenerates derived files)
uip agent refresh ./my-agent

# 3. Validate the project is ready for upload (strict, read-only)
uip agent validate ./my-agent

# 4. Review for quality issues before shipping
uip agent review ./my-agent

# 5. Ship via the solution the project was registered into
uip solution pack . ./dist
uip solution upload .

# 6. Evaluate (against the cloud project once pushed, or the local workspace)
uip agent eval run start --set default --path ./my-agent --wait

# 7. Debug a specific run against Studio Web
uip agent debug ./my-agent -i '{"input":"hello"}'
# 1. Scaffold (auto-registers into the surrounding solution, or creates one)
uip agent init ./my-agent --model gpt-5.4

# 2. Refresh after any edit to agent.json (migrates + regenerates derived files)
uip agent refresh ./my-agent

# 3. Validate the project is ready for upload (strict, read-only)
uip agent validate ./my-agent

# 4. Review for quality issues before shipping
uip agent review ./my-agent

# 5. Ship via the solution the project was registered into
uip solution pack . ./dist
uip solution upload .

# 6. Evaluate (against the cloud project once pushed, or the local workspace)
uip agent eval run start --set default --path ./my-agent --wait

# 7. Debug a specific run against Studio Web
uip agent debug ./my-agent -i '{"input":"hello"}'

身份验证

debugeval run *guardrails llm-as-judge-modelsmodel list 调用 Studio Web/LLM 网关,并且需要活动的 CLI 会话。请先运行 uip login。有关会话模型,请参阅身份验证

initvalidaterefreshreviewreview-historytool listmemoryguardrails listguardrails catalog 仅限本地,不需要会话。

另请参阅

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新