uip llm - 構成

「uip llm-configuration byo-connections」の構文とオプション。UiPath AI Trust Layer/LLM ゲートウェイで独自の LLM 製品の設定を管理します。

uip llm-configuration は、UiPath AI Trust Layer で独自の LLM の使用 (BYO LLM) 製品の設定を管理します。この設定は、UiPath の機能 (エージェント、Studio Web 製品サーフェス、AI を活用したアクティビティ) を、UiPath がホストするモデルではなく顧客所有のモデルに向けます。このツールは @uipath/llmgw-tool パッケージとして出荷されます。すべてのコマンドは uip llm-configuration byo-connections <verb>として呼び出されます。

概念

• 製品/機能。すべての構成のスコープは、 (product, operationGroupName) ペア (例: product=agents、 feature=agents-design-eval-deploy) に設定されます。何かを作成する前に、有効なペアとそのモデル ルールを list-product-configs で発見します。

• ラッパーと内部構成。1 つの設定レコード (「ラッパー」) は 1 つ以上の内部 LLM 設定を保持し、各設定は UiPath カタログ モデルを、 Integration Service のコネクションを介してアクセス可能な顧客所有のモデルにマッピングします。

• create/update用の 2 つのオーサリング図形 — 相互に排他的です。

  • 単一マッピングの省略形 — 最上位レベルのフラグ (--llm-name、 --connector-type、 --connection-id、 --api-flavor、 --llm-identifier) です。内部マッピングを 1 つだけ必要とする AnyModel および AnyModelWithOwnAdditions 機能に使用します。
  • マルチマッピング フォーム — 反復可能な --mapping 'llm-name=…,llm-identifier=…,connector-type=…,api-flavor=…,connection-id=…'。models[]のカタログモデルごとに1つのマッピングを必要とするAllModels機能に必要です(カタログモデルは、そのalternativesWithProbesエントリの1つで満たすか、機能がgenericAlternativeProbesを定義している場合は汎用の代替で満たすことができます)。

• フィールド名の変換 — CLI のフラグ名は、ワイヤ ペイロードおよび Studio Web ポータルのフィールド ラベルとは異なります。

  ポータルのラベル	CLI フラグ	ワイヤーフィールド
  製品	--product	product
  機能	--feature	operationGroupName
  コネクションのフォルダー	--folder-key	folderId
  コネクタ	--connector-type (または --mapping connector-type=…)	connectorType
  コネクション	--connection-id (または --mapping connection-id=…)	connectionId
  LLM 名	--llm-name (または --mapping llm-name=…)	desiredModel
  API の種類	--api-flavor (または --mapping api-flavor=…)	apiFlavor
  LLM の識別子	--llm-identifier (または --mapping llm-identifier=…)	customerModel

• サーバー側の検証は常に実行されます。create と update はどちらも、ゲートウェイのライブ ベンダー/API フレーバー カタログに対してクライアント側のプリフライト チェックを実行し (ネットワーク書き込みの前にサポートされていない --connector-type/--api-flavor の組み合わせを拒否します)、次にサーバー側のプローブ呼び出しを実行してから、特定のモデルとの接続を実際に実行します。どちらのチェックもスキップするフラグはありません。プローブの失敗 (異常な接続、ベンダー アカウントが公開していない --llm-identifier ) は、プローブの reason で書き込みを中止し、利用可能な場合は summary オブジェクトで中止します。

• update はラッパー全体を置き換えます。ロックされた product/operationGroupName/folderId/name ID フィールドを回復するためにのみ既存のレコードを取得し、新しく作成された本文を PUT します — 必要なすべてのモデル マッピングは、 update 呼び出し自体で再指定する必要があります。暗黙のうちに引き継がれるものは何もありません。既存の構成の--product/--featureを変更することはできません。削除して再作成し、別の製品/機能に移動する必要があります。

• --login-validity <minutes> は、その 1 回の呼び出しの対話型ログイン トークンの有効期間を上書きするために、すべての動詞で使用できます。

概要

uip llm-configuration byo-connections list [--include-connection-details]
uip llm-configuration byo-connections get <configuration-id> [--force-refresh]
uip llm-configuration byo-connections create --product <name> --feature <name> --folder-key <uuid> [--mapping <kv>]... | [--connector-type <type> --connection-id <uuid> --llm-name <model> --api-flavor <flavor> --llm-identifier <model>] [--name <name>] [--enabled | --no-enabled]
uip llm-configuration byo-connections update <configuration-id> [--mapping <kv>]... | [--connector-type <type> --connection-id <uuid> --llm-name <model> --api-flavor <flavor> --llm-identifier <model>] [--folder-key <uuid>] [--name <name>] [--enabled | --no-enabled]
uip llm-configuration byo-connections delete <configuration-id> --force
uip llm-configuration byo-connections list-product-configs [--product <name>] [--feature <name>] [--models-only]

すべての動詞も --login-validity <minutes>を受け入れます。

uip llm 構成 byo-connections リスト

現在のテナントに登録されているすべての BYO LLM 製品の設定を一覧表示します。

オプション

長押し	値 (Value)	既定 (Default)	説明
--include-connection-details	フラグ	無効	コネクションのメタデータを解決して含めます。低速 — 接続ごとに Integration Service に対して追加の呼び出しを実行します。

例

uip llm-configuration byo-connections list

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

{
  "Code": "AiByoConnectionsList",
  "Data": [
    {
      "id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
      "folderId": "117fc0a5-d840-4601-9659-a5963a39ff81",
      "name": "agenthub-llm-call-1777293840315",
      "product": "agenthub",
      "operationGroupName": "agenthub-llm-call",
      "enabled": true,
      "llmConfigurations": [
        {
          "id": "e4e4aab5-2bf4-403e-bbf0-08de803bc012",
          "connectorType": "AmazonWebServices",
          "apiFlavor": "AwsBedrockInvoke",
          "configurationType": "SelfServe",
          "connectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
          "desiredModel": "anthropic.claude-sonnet-4-20250514-v1:0",
          "customerModel": "eu.anthropic.claude-sonnet-4-20250514-v1:0",
          "connectedModel": "eu.anthropic.claude-sonnet-4-20250514-v1:0",
          "validConnection": true
        }
      ]
    }
  ]
}

応答キーは、PascalCasedではなく、ネイティブのキャメルケースに保持されます—このペイロードは create/updateスタイルのツールに直接ラウンドトリップします。validConnection は、内部接続の最後に知られた健全性を反映しています。 --include-connection-details を渡すと、新しい解決が強制されます。

uip llm - 構成 byo-connections get

単一の BYO 製品構成を ID で取得する。

引数

名前	Required	目的
<configuration-id>	○	BYO 製品構成 UUID。byo-connections listから取得します。

オプション

長押し	値 (Value)	既定 (Default)	説明
--force-refresh	フラグ	無効	キャッシュされたコネクションの詳細をバイパスし、Integration Service から再解決する

例

uip llm-configuration byo-connections get e5723bb8-fbc2-4317-c7d7-08de803bc010

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

{
  "Code": "AiByoConnectionsGet",
  "Data": {
    "id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
    "folderId": "117fc0a5-d840-4601-9659-a5963a39ff81",
    "name": "agenthub-llm-call-1777293840315",
    "product": "agenthub",
    "operationGroupName": "agenthub-llm-call",
    "enabled": true,
    "llmConfigurations": [
      {
        "id": "e4e4aab5-2bf4-403e-bbf0-08de803bc012",
        "connectorType": "AmazonWebServices",
        "apiFlavor": "AwsBedrockInvoke",
        "configurationType": "SelfServe",
        "connectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
        "desiredModel": "anthropic.claude-sonnet-4-20250514-v1:0",
        "customerModel": "eu.anthropic.claude-sonnet-4-20250514-v1:0",
        "connectedModel": "eu.anthropic.claude-sonnet-4-20250514-v1:0",
        "validConnection": true
      }
    ]
  }
}

uip llm - 設定 byo-connections 作成

CLI フラグを使用して新しい BYO LLM 製品の設定を作成します。JSON ファイルは不要です。

オプション

長押し	値 (Value)	Required	説明
--product <name>	string	○	製品コード (例:agents、 agenthubです。list-product-configsで発見する
--feature <name>	string	○	製品内の操作グループ名 (例:agents-design-eval-deploy)。
--folder-key <uuid>	UUID	○	コネクション フォルダー UUID。uip or folders listで発見する
--mapping <kv>	コンマ区切り key=value、繰り返し可能	条件付き	モデルごとのマッピング必要なキー: llm-name、llm-identifier、connector-type、api-flavor、connection-id任意: default-model。AllModels機能に必要 (カタログ モデルごとに 1 つ)。以下の単一マッピングの省略フラグと相互に排他的です。
--connector-type <type>	OpenAi、AzureOpenAi、AwsBedrock、AmazonWebServices、GoogleVertex、OpenAiV1Compatible、のいずれかCustom	単一マッピングの省略形	ベンダー コネクタ。
--connection-id <uuid>	UUID	単一マッピングの省略形	ベンダーの資格情報を保持する Integration Service のコネクション。
--llm-name <model>	string	単一マッピングの省略形	UiPath カタログのモデル名が置換されます (ワイヤ: desiredModel)。
--api-flavor <flavor>	OpenAiChatCompletions、OpenAiResponses、OpenAiEmbeddings、GeminiGenerateContent、GeminiEmbeddings、AwsBedrockInvoke、AwsBedrockConverse、のいずれかAnthropicMessages	単一マッピングの省略形	API の種類。
--llm-identifier <model>	string	単一マッピングの省略形	顧客のベンダー側のモデル エイリアス — ゲートウェイが実際にルーティングするモデル (ワイヤ: customerModel) です。
--default-model <model>	string	×	代替案を含む操作グループのプライマリ モデル。既定値は --llm-nameです。
--name <name>	string	×	自動生成されたラッパー名を上書きします。既定値は <feature>-<unix-millis>です。
--enabled / --no-enabled	フラグ	×	有効化 (既定) するか、無効化して保存します。

単一マッピングの短縮形と --mapping は、1 回の呼び出しで相互に排他的です — 両方を渡すか、不完全な --mapping (必要な 5 つのキーのうちの 1 つが欠落している) は、ネットワーク呼び出しの前に失敗し、問題のあるフラグに名前を付けます。

例

# Single-mapping form (typical for AnyModelWithOwnAdditions features)
uip llm-configuration byo-connections create \
  --product agenthub --feature agenthub-llm-call \
  --folder-key 117fc0a5-d840-4601-9659-a5963a39ff81 \
  --connector-type AmazonWebServices \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df \
  --llm-name anthropic.claude-sonnet-4-20250514-v1:0 \
  --api-flavor AwsBedrockInvoke \
  --llm-identifier eu.anthropic.claude-sonnet-4-20250514-v1:0

# Multi-mapping form for an AllModels feature — one --mapping per catalog model
uip llm-configuration byo-connections create \
  --product uipath-ecs --feature uipath-ecs-batch-transform-web-search \
  --folder-key f73c21e7-f36e-4833-94c1-9446a04b02e4 \
  --mapping 'llm-name=gemini-2.5-flash,llm-identifier=gemini-2.5-flash,connector-type=GoogleVertex,api-flavor=GeminiGenerateContent,connection-id=6d33e3b5-5480-4435-9bc5-ef0ea785bda5' \
  --mapping 'llm-name=gemini-2.5-flash-lite,llm-identifier=gemini-2.5-flash,connector-type=GoogleVertex,api-flavor=GeminiGenerateContent,connection-id=6d33e3b5-5480-4435-9bc5-ef0ea785bda5'

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

{
  "Code": "AiByoConnectionsCreated",
  "Data": {
    "configuration": {
      "id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
      "name": "agenthub-llm-call-1777293840315",
      "product": "agenthub",
      "operationGroupName": "agenthub-llm-call",
      "enabled": true
    },
    "validation": {
      "anthropic.claude-sonnet-4-20250514-v1:0": {
        "isAvailable": true,
        "isCompatible": true,
        "isModelNameSimilar": true
      }
    }
  }
}

validation には、保存前の isModelNameSimilar: false チェック中にプローブされたモデルごとに 1 つのエントリが含まれます。これは手動で確認する価値のある警告サインです (ベンダー側のモデルは応答しましたが、その名前が指定したものとほとんど一致しません)。

失敗: プリフライトとプローブのエラー

--connector-typeと--api-flavor がゲートウェイのカタログで許可されている組み合わせでない場合、コマンドは直ちに失敗し、問題のあるフラグ という名前が付けられます。つまり、ネットワーク書き込みは行われません。組み合わせが有効であるが、接続に対するライブ プローブが失敗する場合 (異常な接続、ベンダー アカウントが実際に公開していない --llm-identifier )、コマンドは失敗し、プローブの reason と (ゲートウェイが 1 つを返した場合は summary オブジェクト) で失敗し、診断する uip is connections list と byo-connections list-product-configs --models-only を示します。

UIP LLM の設定 BYO-Connections の更新

既存の BYO 製品の設定をその場で更新します。ラッパー全体をゼロからPUTする — すべてのモデルマッピングを再提供する必要があります。ロックされた ID フィールドを除き、既存のレコードからは何も結合されません。

引数

名前	Required	目的
<configuration-id>	○	BYO 製品構成 UUID。

オプション

create (--mapping、または単一マッピングの省略形 --connector-type/--connection-id/--llm-name/--api-flavor/--llm-identifier/--default-modelと同じマッピング オプションに加えて、以下のようなマッピング オプションがあります。

長押し	値 (Value)	説明
--folder-key <uuid>	UUID	フォルダーを上書きします。既定では、既存のレコードのフォルダーです。
--name <name>	string	ラッパー名を上書きします。既定値は既存のレコードの名前です。
--enabled / --no-enabled	フラグ	設定を有効または無効化します。

ここで--product/--featureを渡すことはできません。構成の ID は作成時に固定されます。削除して再作成し、別の製品/機能に移動します。

例

# Replace the model on an existing single-mapping configuration
uip llm-configuration byo-connections update e5723bb8-fbc2-4317-c7d7-08de803bc010 \
  --llm-name anthropic.claude-sonnet-4-20250514-v1:0 \
  --llm-identifier eu.anthropic.claude-sonnet-4-20250514-v1:0 \
  --connector-type AmazonWebServices --api-flavor AwsBedrockInvoke \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df

# Update a multi-mapping AllModels configuration
uip llm-configuration byo-connections update e5723bb8-fbc2-4317-c7d7-08de803bc010 \
  --mapping 'llm-name=gemini-2.5-flash,llm-identifier=gemini-2.5-flash,connector-type=GoogleVertex,api-flavor=GeminiGenerateContent,connection-id=6d33e3b5-5480-4435-9bc5-ef0ea785bda5' \
  --mapping 'llm-name=gemini-2.5-flash-lite,llm-identifier=gemini-2.5-flash,connector-type=GoogleVertex,api-flavor=GeminiGenerateContent,connection-id=6d33e3b5-5480-4435-9bc5-ef0ea785bda5'

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

{
  "Code": "AiByoConnectionsUpdated",
  "Data": {
    "configuration": { "id": "e5723bb8-fbc2-4317-c7d7-08de803bc010" },
    "validation": {
      "anthropic.claude-sonnet-4-20250514-v1:0": {
        "isAvailable": true,
        "isCompatible": true,
        "isModelNameSimilar": true
      }
    }
  }
}

書き込み前の create 実行と同じプリフライト/プローブ検証 — 上記の 「失敗: プリフライトとプローブエラー 」を参照してください。

uip llm - 設定 byo-connections delete

BYO 製品の構成を完全に削除する。

引数

名前	Required	目的
<configuration-id>	○	BYO 製品構成 UUID。

オプション

長押し	値 (Value)	Required	説明
--force	フラグ	○	確認をスキップします。削除は永続的です。削除を省略すると、 --force 明示的に拒否され、ネットワーク呼び出しが行われずに失敗します。

例

uip llm-configuration byo-connections delete e5723bb8-fbc2-4317-c7d7-08de803bc010 --force

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

{
  "Code": "AiByoConnectionsDeleted",
  "Data": { "id": "e5723bb8-fbc2-4317-c7d7-08de803bc010" }
}

uip llm の設定 byo-connections list-product-configs

BYO LLM の設定をサポートする製品と操作グループ (機能) を、 create/update 必要なモデルごとのコネクタ/API フレーバーのルールとともにリストします。

オプション

長押し	値 (Value)	説明
--product <name>	string	フィルターを適用し、1 つの製品コード (完全一致、大文字と小文字を区別) に絞り込む。
--feature <name>	string	フィルターを適用し、 --product 内の 1 つの操作グループに絞り込む (完全一致)。--productが必要です。要求の前に--featureだけ渡すと失敗します。
--models-only	フラグ	モデルごとの allowedApiFlavors/allowedConnectors を削除する (および alternativesWithProbes エントリの同じフィールド) — モデルのリストのみが必要な場合に便利です。addYourOwn と synthetic generic-alternative エントリでは、に関係なくフィールドが保持されます。

例

uip llm-configuration byo-connections list-product-configs \
  --product agents --feature agents-design-eval-deploy

uip llm-configuration byo-connections list-product-configs --models-only

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

{
  "Code": "AiByoProductConfigs",
  "Data": [
    {
      "product": "agents",
      "feature": "agents-design-eval-deploy",
      "modelsConfigurationOption": "AnyModelWithOwnAdditions",
      "addYourOwn": {
        "OpenAi": ["OpenAiResponses", "OpenAiChatCompletions"],
        "AmazonWebServices": ["AwsBedrockInvoke", "AwsBedrockConverse"],
        "Custom": ["OpenAiResponses", "OpenAiChatCompletions", "AwsBedrockInvoke", "AwsBedrockConverse", "AnthropicMessages", "GeminiGenerateContent"]
      },
      "models": [
        {
          "model": "gpt-4o-2024-11-20",
          "allowedApiFlavors": ["OpenAiResponses", "OpenAiChatCompletions"],
          "allowedConnectors": ["OpenAi", "AzureOpenAi", "OpenAiV1Compatible", "NvidiaNim", "Custom"]
        },
        {
          "model": "anthropic.claude-sonnet-4-20250514-v1:0",
          "allowedApiFlavors": ["AwsBedrockInvoke", "AwsBedrockConverse", "AnthropicMessages"],
          "allowedConnectors": ["AmazonWebServices", "Custom"],
          "customConnectorOnlyApiFlavors": ["OpenAiChatCompletions"]
        }
      ]
    }
  ]
}

modelsConfigurationOption は、 AnyModel、 AnyModelWithOwnAdditions、または AllModels のいずれかです。 create/update に単一マッピングの省略形とマルチマッピングの --mapping 形式のどちらが必要かを決定 します (「概念」を参照)。addYourOwn は AnyModelWithOwnAdditions 機能にのみ表示され、使用可能な各コネクタが、まだ models[]にないユーザー追加モデルに対して有効な API フレーバーにマッピングされます。モデルまたは代替モデルをcustomConnectorOnlyApiFlavorsするということは、API フレーバーにその特定のモデルの Custom コネクタを介してのみアクセスできることを意味します。ネイティブ ベンダーのカタログでは直接サポートされていません。AllModels では、プライマリごとの代替手段が alternativesの下に入れ子になり、それぞれが同じプライマリのプローブ セットを持ちます。

関連

• uip is connections — BYO 構成の--connection-idポイントとなる Integration Service の接続です。
• uip or folders — --folder-key値を検索します。

参照

• グローバル オプション
• 終了コード