UIP 智能体运行

uip agent run启动并监控 Orchestrator 上的智能体作业。在内部，每个子命令都调用标准 Orchestrator 作业/版本 OData 端点（与uip or jobs公开的端点相同），范围为uip agent deploy生成的版本。

每个子命令都需要活动的 CLI 会话 ( uip login )。如果未传递--folder-id ，该命令将使用绑定到当前会话的文件夹。

大纲

uip agent run start <releaseKeyOrName> [-i <json>] [--folder-id <id>] [-t <tenant>] [--login-validity <minutes>]
uip agent run status <jobId>                         [--folder-id <id>] [-t <tenant>] [--login-validity <minutes>]
uip agent run list                                   [--folder-id <id>] [--filter <odata>] [-t <tenant>] [--login-validity <minutes>]

所有uip agent run子命令均采用全局选项（ --output 、 --output-filter 、 --log-level 、 --log-file ）。退出代码遵循标准合同。

uip 智能体运行开始

为已部署的智能体版本启动作业。

参数

• <releaseKeyOrName> （必填） — 版本密钥 (GUID) 或版本名称。如果该值不是 GUID，则该命令将对版本 OData 端点 ( $filter=Name eq '<name>' ) 执行名称查找。

选项

标记	默认	用途
-i, --inputs <json>	{}	JSON 字符串形式的输入参数。必须是有效的 JSON。
--folder-id <id>	登录文件夹	Orchestrator 文件夹组织单位 ID。作为X-UIPATH-OrganizationUnitId发送。
-t, --tenant <tenant>	登录租户	目标租户。
--login-validity <minutes>	10	令牌有效期的最短分钟数要求。

示例

# Start by release key (the exact key from 'agent run list')
uip agent run start a1b2c3d4-0000-0000-0000-000000000401 -i '{"input":"hello"}'

# Start by release name (resolved via OData lookup)
uip agent run start InvoiceAgent -i '{"invoiceUrl":"…"}' --folder-id 42

# Start with no inputs
uip agent run start InvoiceAgent

数据形状（--输出 json）

{
  "Code": "AgentJobStarted",
  "Data": {
    "JobId": 12345,
    "JobKey": "a1b2c3d4-0000-0000-0000-000000000410",
    "State": "Pending"
  }
}

JobId是您传递给uip agent run status数字 ID。JobKey是 GUID 等效项，可用于交叉引用 Orchestrator 用户界面或uip or jobs命令。作业以Strategy: ModernJobsCount和JobsCount: 1开始。

uip 智能体运行状态

获取单个作业的当前状态。

参数

• <jobId> （必填） — 数字 Orchestrator 作业 ID（来自run start或uip or jobs list ）。

选项

与run start （ --folder-id 、 -t/--tenant 、 --login-validity ）相同。

示例

# Quick status check
uip agent run status 12345

# Explicit folder
uip agent run status 12345 --folder-id 42

数据形状（--输出 json）

{
  "Code": "AgentJobStatus",
  "Data": {
    "JobId": 12345,
    "State": "Successful",
    "ReleaseName": "InvoiceAgent",
    "StartTime": "2025-04-15T10:30:00Z",
    "EndTime": "2025-04-15T10:31:12Z",
    "Info": "…",
    "Output": { "...": "..." }
  }
}

• State值反映 Orchestrator 的作业状态（ Pending 、 Running 、 Successful 、 Faulted 、 Stopped 、 Suspended等）。
• Info仅在作业包含状态消息时（通常在失败时）才会出现。
• Output被OutputArguments解析为 JSON。如果解析失败，则返回原始字符串。

uip 智能体运行列表

列出文件夹中的可用智能体版本。

参数

无。

选项

标记	默认	用途
--folder-id <id>	登录文件夹	Orchestrator 文件夹组织单位 ID。
--filter <odata>	—	将其他 OData $filter表达式附加到默认查询（已按Name排序）。
-t, --tenant <tenant>	登录租户	目标租户。
--login-validity <minutes>	10	令牌有效期的最短分钟数要求。

示例

# List all releases in the login folder
uip agent run list

# List in a specific folder
uip agent run list --folder-id 42

# Filter by name prefix
uip agent run list --filter "startswith(Name,'Invoice')"

数据形状（--输出 json）

{
  "Code": "AgentReleaseList",
  "Data": [
    {
      "Name": "InvoiceAgent",
      "ReleaseKey": "a1b2c3d4-0000-0000-0000-000000000401",
      "ProcessKey": "InvoiceAgent",
      "Version": "1.0.0",
      "FolderId": 42
    }
  ]
}

空文件夹将返回Message日志条目 ( No releases found in this folder. Publish an agent first. )，且不会返回任何成功负载。

相关内容

• uip agent deploy — 发布run list枚举的版本。
• uip agent eval run start — 相当于run start的评估，针对的是 Agent Runtime 服务，而不是 Orchestrator 作业。
• Orchestrator：作业— 完整的作业 API（停止、重新启动、日志、附件）。

另请参阅

• 身份验证— 会话、租户和--login-validity 。
• 全局选项，退出代码。