UIP 防护机制

"uip Guardrails byo-configurations" 的语法和选项，用于管理 UiPath AI Trust Layer 的自带 (BYOG) 防护栏配置。

uip guardrails管理 UiPath AI Trust Layer 的自带防护机制 (BYOG) 配置 — 将租户自己的内容安全/验证连接器（例如 Azure AI 内容安全）连接到命名防护机制中，以便编码智能体可通过别名引用。有一个命令组 byo-configurations。这对应于用户界面中的管理 → AI Trust Layer → 护栏配置。

请参阅uip llm-gateway ，以了解 LLM 模型发现 API 的某些防护机制验证程序（例如LLM-as-judge）路由直通。

概念

• 配置与验证程序。验证程序（ --validator-type ，例如pii_detection）是连接器公开的功能 — 使用 list-validators 发现它们。配置使用连接和租户唯一别名 ( --validator-name ) 包装一个验证程序，编码智能体的ByoValidator(...)调用会引用这些别名；已在创建时锁定ValidatorName / ValidatorType ，因此请通过删除并重新创建其中之一来进行更改。
• 保存前探测。 create始终先探测连接/验证程序对，并在探测器失败时中止 — 没有跳过标志，因为后端会保留其给定的任何连接 ID，而不会自行验证。update 仅在 --connection-id 更改时才会重新探测；仅更改 --fallback-on-ui-path 或启用/禁用状态不会重新探测，因此仍可以禁用供应商当前已关闭的配置。
• --fallback-on-ui-path （默认为false ）— 如果设置，则失败的 BYO 调用将回退到 UiPath 自己的内置防护机制，而不是使请求失败。
• 功能门控。如果未为租户启用 BYOG，则每个动词都将失败 Code: "ByoGuardrailsUnavailable"，并将其指向 UiPath 支持。

大纲

uip guardrails byo-configurations list
uip guardrails byo-configurations create --connection-id <guid> --validator-name <name> --validator-type <type> [--fallback-on-ui-path] [--disabled]
uip guardrails byo-configurations update <configuration-id> [--connection-id <guid>] [--fallback-on-ui-path | --no-fallback-on-ui-path] [--enabled | --disabled]
uip guardrails byo-configurations delete <configuration-id> --force
uip guardrails byo-configurations probe --connection-id <guid> --validator-type <type>
uip guardrails byo-configurations list-validators --connection-id <guid>

所有动词也接受 --login-validity <minutes>（覆盖交互式登录令牌生存期）。

UIP 防护栏自带配置列表

列出经过身份验证的租户的 BYOG 配置，包括连接/连接器详细信息。

示例

uip guardrails byo-configurations list

数据形状（--输出 json）

{
  "Code": "ByoGuardrailConfigurationsList",
  "Data": [
    {
      "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
      "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
      "ValidatorName": "my-pii-guardrail",
      "ValidatorType": "pii_detection",
      "FallbackOnUiPath": true,
      "Enabled": true,
      "CreatedAt": "2026-07-01T10:00:00Z",
      "UpdatedAt": null,
      "ConnectorKey": "uipath-azure-contentsafety",
      "ConnectorName": "Azure AI Content Safety",
      "ConnectionName": "My Content Safety Connection",
      "ValidConnection": true
    }
  ]
}

ValidatorName 是租户选择的别名； ValidatorType 是原始验证程序 ID。 ValidConnection 反映当前是否解析基础 Integration Service 连接。

uip 防护栏自带配置创建

创建 BYOG 配置。“始终先探测连接/验证程序对”（请参阅“概念” ）——如果未通过，则创建将因探测器自身失败而中止。

参数

无 — 一切内容都通过选项传递。

选项

长	值	必填	描述
--connection-id <guid>	GUID	是	防护栏调用通过的 Integration Service 连接。
--validator-name <name>	字符串	是	租户唯一别名 — 编码智能体传递给 ByoValidator(...) 的内容。
--validator-type <type>	字符串	是	原始验证程序 ID，例如pii_detection。发现使用 list-validators 的有效值。
--fallback-on-ui-path	标记	否	如果 BYO 调用失败，则回退到 UiPath 内置防护机制。默认 false。
--disabled	标记	否	保存配置已禁用。默认情况下处于启用状态。
--login-validity <minutes>	整数	否	覆盖交互式登录令牌的生存期。

示例

uip guardrails byo-configurations create \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df \
  --validator-name my-pii-guardrail --validator-type pii_detection

数据形状（--输出 json）

{
  "Code": "ByoGuardrailConfigurationCreated",
  "Data": {
    "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
    "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
    "ValidatorName": "my-pii-guardrail",
    "ValidatorType": "pii_detection",
    "FallbackOnUiPath": false,
    "Enabled": true,
    "CreatedAt": "2026-07-01T10:00:00Z",
    "UpdatedAt": null,
    "ConnectorKey": null,
    "ConnectorName": null,
    "ConnectionName": null,
    "ValidConnection": null
  }
}

连接器/连接详细信息字段（ConnectorKey、ConnectorName、ConnectionName、ValidConnection）在创建时为 null — 并在读取时根据连接进行填充 list。

uip 防护栏 byo 配置更新

更新现有配置的连接、回退行为或启用状态。无法更改 ValidatorName/ValidatorType — 请将其删除并重新创建。

参数

名称	必填	用途
<configuration-id>	是	BYOG 配置 GUID，来自 list。

选项

长	值	描述
--connection-id <guid>	GUID	新连接。保存前重新探测该对 — 探测失败时中止。
--fallback-on-ui-path / --no-fallback-on-ui-path	标记	设置或清除回退标志。
--enabled / --disabled	标记	互斥 — 启用或禁用配置。
--login-validity <minutes>	整数	覆盖交互式登录令牌的生存期。

--connection-id、--fallback-on-ui-path /--no-fallback-on-ui-path 或 中至少有一个为必需--enabled --disabled— 在任何查找之前，省略所有这些选项会在客户端失败。

示例

uip guardrails byo-configurations update e5723bb8-fbc2-4317-c7d7-08de803bc010 \
  --connection-id 24887687-1234-4abc-9def-012345678901

数据形状（--输出 json）

形状与 create 的响应相同，但现已设置 UpdatedAt。

uip 防护栏自有配置删除

永久删除 BYOG 配置。

参数

名称	必填	用途
<configuration-id>	是	BYOG 配置 GUID，来自 list。

选项

长	值	必填	描述
--force	标记	是	跳过确认防护。省略它会失败，并显示明确的“拒绝在没有 --force 的情况下删除”错误error — 否则，删除将是永久性的。
--login-validity <minutes>	整数	否	覆盖交互式登录令牌的生存期。

示例

uip guardrails byo-configurations delete e5723bb8-fbc2-4317-c7d7-08de803bc010 --force

数据形状（--输出 json）

{ "Code": "ByoGuardrailConfigurationDeleted", "Data": { "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010" } }

uip 防护栏自带配置探测器

测试连接是否可以在不创建或保存任何内容的情况下为验证程序提供服务。后端向连接器询问其验证程序，然后使用验证程序的默认参数评估良性测试输入。

选项

长	值	必填	描述
--connection-id <guid>	GUID	是	要测试的 Integration Service 连接。
--validator-type <type>	字符串	是	要测试的验证程序 ID。使用 list-validators 发现值。
--login-validity <minutes>	整数	否	覆盖交互式登录令牌的生存期。

示例

uip guardrails byo-configurations probe \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df --validator-type pii_detection

数据形状（--输出 json）

{
  "Code": "ByoGuardrailProbeSucceeded",
  "Data": {
    "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
    "ValidatorType": "pii_detection",
    "ConnectorKey": "uipath-azure-contentsafety",
    "IsAvailable": true,
    "Verdict": "PASSED",
    "Details": null,
    "DurationMs": 842,
    "Error": null
  }
}

IsAvailable（非 Verdict）决定于成功/失败，Verdict 是供应商对良好测试输入的评估，因此 "PASSED" 和 "FAILED" 都表示连接器已做出响应。当 IsAvailable 为 false 时，命令退出 1，并为失败包线附加相同的 Code: "ByoGuardrailProbeFailed" 和相同的 Data 形状。

UIP 防护栏自带配置验证程序列表

列出 Integration Service 连接公开的验证程序。返回的每个 Validator 值都是对 --validator-type 和 probe 的有效 create。

选项

长	值	必填	描述
--connection-id <guid>	GUID	是	要检查的连接。
--login-validity <minutes>	整数	否	覆盖交互式登录令牌的生存期。

示例

uip guardrails byo-configurations list-validators --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df

数据形状（--输出 json）

{
  "Code": "ByoGuardrailValidatorsList",
  "Data": [
    {
      "Validator": "pii_detection",
      "DisplayName": "PII detection",
      "Description": null,
      "Status": "Available",
      "AllowedScopes": ["Agent", "Llm", "Tool"],
      "PayloadMinSizeLimit": null,
      "PayloadMaxSizeLimit": 10000
    }
  ]
}

错误行为

• 未为租户 Code: "ByoGuardrailsUnavailable" 启用 BYOG，系统会将您指向 UiPath 支持团队。
• 未知配置 ID：Code: "ByoGuardrailConfigurationNotFound"，指向您 list。
• 探测器成功运行，但发现该对不可用：Code: "ByoGuardrailProbeFailed"，退出 1，探测器结果仍附加在 Data 下，供脚本检查。
• delete没有--force：在任何网络调用之前失败。

另请参阅

• uip llm-gateway — LLM 模型发现，由 LLM-as-judge 风格的验证程序使用。
• uip is connections — --connection-id引用的 Integration Service 连接。
• 工具（插件）
• 全局选项
• 退出代码