UiPath Documentation
uipath-cli
latest
false
UiPath CLI ユーザー ガイド
重要 :
このコンテンツは機械翻訳によって処理されています。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

UIP ガードレール

「uip guardrails byo-configurations」の構文とオプション - UiPath AI Trust Layer の独自の (BYOG) ガードレールの構成を管理します。

uip guardrails は、UiPath AI Trust Layer の独自の ガードレールの使用 (BYOG) の構成を管理します。この設定は、テナント独自のコンテンツの安全性/検証コネクタ (Azure AI Content Safety など) を、コード化されたエージェントがエイリアスで参照できる名前付きガードレールに接続します。コマンド グループは byo-configurations1 つです。これは、UI での [管理] → [AI Trust Layer] → [ガードレール] の設定に対応します。

LLM モデル検出 API については、uip llm-gateway をご覧ください。一部のガードレール検証ツール (例:LLM-as-judge) のルートを通過します。

概念​

  • 構成と検証者検証者 (--validator-type、例:pii_detection) はコネクタによって公開される機能です。 list-validatorsでそれらを発見してください。設定は、1 つの検証者を、コード化されたエージェントのByoValidator(...)呼び出しが参照するコネクションと、テナント固有のエイリアス (--validator-name) でラップします。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>
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 ガードレールの BYO 構成リスト​

認証されているテナントの BYOG 構成を、接続/コネクタの詳細を含めて一覧表示します。

uip guardrails byo-configurations list
uip guardrails byo-configurations list

データシェイプ(--output 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
    }
  ]
}
{
  "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 ガードレール BYO-configurations 作成​

BYOG 構成を作成します。常に最初に接続/バリデーターのペアをプローブします ( 概念を参照) — 成功しない場合、作成はプローブ自身の失敗で中止されます。

引数​

なし — すべてはオプションを介して渡されます。

オプション​

長押し値 (Value)Required説明
--connection-id <guid>GUID○Integration Service のコネクション: ガードレールが呼び出す
--validator-name <name>string○テナント固有のエイリアス — コード化されたエージェントが ByoValidator(...)に渡すものです。
--validator-type <type>string○生の検証者 ID (例:pii_detectionです。list-validatorsで有効な値を検出します。
--fallback-on-ui-pathフラグ×BYO 呼び出しが失敗した場合は、UiPath の組み込みガードレールにフォールバックします。既定 falseです。
--disabledフラグ×無効化された設定を保存します。既定では有効です。
--login-validity <minutes>integer×対話型ログイン トークンの有効期間を上書きします。
uip guardrails byo-configurations create \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df \
  --validator-name my-pii-guardrail --validator-type pii_detection
uip guardrails byo-configurations create \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df \
  --validator-name my-pii-guardrail --validator-type pii_detection

データシェイプ(--output 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
  }
}
{
  "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 は変更できません。代わりに削除して再作成してください。

引数​

名前Required目的
<configuration-id>○BYOG 構成 GUID ( listから)。

オプション​

長押し値 (Value)説明
--connection-id <guid>GUID新しい接続。保存する前にペアを再プローブします — プローブが失敗すると中止します。
--fallback-on-ui-path / --no-fallback-on-ui-pathフラグフォールバック フラグを設定またはクリアします。
--enabled / --disabledフラグ相互に排他的 — 設定を有効または無効化します。
--login-validity <minutes>integer対話型ログイン トークンの有効期間を上書きします。

--connection-id、--fallback-on-ui-path/--no-fallback-on-ui-path、または --enabled/--disabled のうち少なくとも 1 つが必要です。これらすべてを省略すると、検索の前にクライアント側で失敗します。

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

データシェイプ(--output json)​

createの応答と同じ形状で、UpdatedAtが設定されました。

UIP ガードレールの BYO-configurations 削除​

BYOG 構成を完全に削除する。

引数​

名前Required目的
<configuration-id>○BYOG 構成 GUID ( listから)。

オプション​

長押し値 (Value)Required説明
--forceフラグ○確認ガードをスキップします。省略すると、明示的な "Refusing to delete without --force" エラーで失敗します — 削除は永続的です。
--login-validity <minutes>integer×対話型ログイン トークンの有効期間を上書きします。
uip guardrails byo-configurations delete e5723bb8-fbc2-4317-c7d7-08de803bc010 --force
uip guardrails byo-configurations delete e5723bb8-fbc2-4317-c7d7-08de803bc010 --force

データシェイプ(--output json)​

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

UIP ガードレールの BYO 構成プローブ​

何も作成または保存せずに、接続が検証者にサービスを提供できるかどうかをテストします。バックエンドはコネクタにバリデーターを要求し、バリデーターの既定のパラメーターを使用して無害なテスト入力を評価します。

オプション​

長押し値 (Value)Required説明
--connection-id <guid>GUID○テストするための Integration Service の接続
--validator-type <type>string○テストする検証者 ID。list-validatorsで価値を発見する
--login-validity <minutes>integer×対話型ログイン トークンの有効期間を上書きします。
uip guardrails byo-configurations probe \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df --validator-type pii_detection
uip guardrails byo-configurations probe \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df --validator-type pii_detection

データシェイプ(--output 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
  }
}
{
  "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 ガードレール byo-configurations list-validators​

Integration Service のコネクションで公開される検証者のリストを表示します。返されるすべての Validator 値は、probe および createに対して有効な--validator-typeです。

オプション​

長押し値 (Value)Required説明
--connection-id <guid>GUID○検査する接続
--login-validity <minutes>integer×対話型ログイン トークンの有効期間を上書きします。
uip guardrails byo-configurations list-validators --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df
uip guardrails byo-configurations list-validators --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df

データシェイプ(--output json)​

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

エラー動作​

  • テナントに対して BYOG が有効化されていない: Code: "ByoGuardrailsUnavailable"UiPath サポートを参照しています。
  • 不明な構成 ID: Code: "ByoGuardrailConfigurationNotFound"を指定します list。
  • 正常に実行されたが、ペアが使用できないことが判明したプローブ: Code: "ByoGuardrailProbeFailed"、出口 1 で、プローブ結果は検査するスクリプトのために Data の下に添付されたままです。
  • --forceなしでdelete : ネットワーク呼び出しの前に失敗します。

参照​

このページは役に立ちましたか?

接続

ヘルプ リソース サポート

学習する UiPath アカデミー

質問する UiPath フォーラム

最新情報を取得