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发现有效对及其模型规则。

• 包装器和内部配置。一个配置记录（“包装器”）保存一个或多个内部 LLM 配置，每个配置将 UiPath 目录模型映射到可通过Integration Service 连接访问的客户拥有的模型。

• 两个创作形状，各自的create / update — 互斥：

  • 单映射速记— 顶层标志（ --llm-name 、 --connector-type 、 --connection-id 、 --api-flavor 、 --llm-identifier ）。用于 AnyModel 和 AnyModelWithOwnAdditions 功能，这些功能仅需要一个内部映射。
  • 多重映射表单— 可重复--mapping 'llm-name=…,llm-identifier=…,connector-type=…,api-flavor=…,connection-id=…' 。对于 AllModels 功能为必需，这些功能需要 models[] 中的每个目录模型一个映射（目录模型可以通过其中一个 alternativesWithProbes 条目满足，也可以在功能定义 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 身份字段，然后 PUT 新建的正文 — 您需要在update 调用自身；任何内容都不会隐式继承。无法更改现有配置上的 --product/--feature — 请删除并重新创建，以将其移至其他产品/功能。

• --login-validity <minutes>可用于每个动词，以覆盖该调用的交互式登录令牌生存期。

大纲

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 LLM 产品配置。

选项

长	值	默认	描述
--include-connection-details	标记	关闭	解析并包含连接元数据。速度较慢 — 每次连接都会对 Integration Service 进行额外调用。

示例

uip llm-configuration byo-connections list

数据形状（--输出 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
        }
      ]
    }
  ]
}

响应密钥采用其原生驼峰式命名法，而非帕斯卡命名法 — 此有效负载直接进入 create/update 样式的工具。validConnection 反映内部连接最新已知的运行状况；传递 --include-connection-details 以强制执行新的解析。

uip llm 配置 byo 连接获取

按 ID 获取单个 BYO 产品配置。

参数

名称	必填	用途
<configuration-id>	是	BYO 产品配置 UUID。从byo-connections list获取。

选项

长	值	默认	描述
--force-refresh	标记	关闭	绕过缓存的连接详细信息，并从 Integration Service 重新解析这些详细信息。

示例

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

数据形状（--输出 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 连接创建

使用 CLI 标志创建新的 BYO LLM 产品配置 — 无需 JSON 文件。

选项

长	值	必填	描述
--product <name>	字符串	是	产品代码，例如agents，agenthub。使用 list-product-configs 发现。
--feature <name>	字符串	是	产品中的操作组名称（例如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 功能为必要项（每个目录模型一个）；与下面的单映射速记标志互斥。
--connector-type <type>	OpenAi、AzureOpenAi、AwsBedrock、AmazonWebServices、GoogleVertex、OpenAiV1Compatible 和 Custom 之一	单个映射速记	供应商连接器。
--connection-id <uuid>	UUID	单个映射速记	Integration Service 连接保存供应商凭据。
--llm-name <model>	字符串	单个映射速记	正在替换的 UiPath 目录模型名称（连接：desiredModel）。
--api-flavor <flavor>	OpenAiChatCompletions、OpenAiResponses、OpenAiEmbeddings、GeminiGenerateContent、GeminiEmbeddings、AwsBedrockInvoke、AwsBedrockConverse 和 AnthropicMessages 之一	单个映射速记	API 类型。
--llm-identifier <model>	字符串	单个映射速记	客户的供应商端模型别名 — 网关实际路由到的模型（连接：customerModel）。
--default-model <model>	字符串	否	具有替代方案的操作组的主要模型。默认为 --llm-name。
--name <name>	字符串	否	覆盖自动生成的包装器名称。默认值：<feature>-<unix-millis>。
--enabled / --no-enabled	标记	否	启用（默认）或禁用保存。

单映射速记和 --mapping 在一次调用中互斥 — 在任何网络调用之前传递两者或不完整的 --mapping（缺少五个必需键中的一个）会失败，命名违规标志。

示例

# 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'

数据形状（--输出 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 是一个警告标志，值得手动检查（供应商端模型已响应，但其名称与您指定的名称并不完全匹配）。

失败：预检和探测器错误

如果 --connector-type/--api-flavor 不是网关目录允许的组合，则该命令将立即失败，并使用名为 — 未发生网络写入的违规标志。如果组合有效，但针对连接的实时探测器失败（连接运行状况不佳，即供应商帐户实际未公开的 --llm-identifier），则命令将失败，并显示探测器的 reason — 当网关返回一个 summary 对象，并为您指向 uip is connections list 和 byo-connections list-product-configs --models-only 进行诊断。

uip llm 配置 byo 连接更新

就地更新现有 BYO 产品配置。从头开始 PUT 整个包装器 — 必须重新提供每个模型映射；除锁定身份字段外，不会从现有记录中合并任何内容。

参数

名称	必填	用途
<configuration-id>	是	BYO 产品配置 UUID。

选项

与 create（--mapping 或单一映射速记--connector-type /--connection-id /--llm-name /--api-flavor /--llm-identifier--default-model ）相同的映射选项，并新增：

长	值	描述
--folder-key <uuid>	UUID	覆盖文件夹。默认为现有记录的文件夹。
--name <name>	字符串	覆盖包装器名称。默认为现有记录的名称。
--enabled / --no-enabled	标记	启用或禁用配置。

无法在此处传递 --product/--feature — 配置的身份在创建时已固定。“删除并重新创建”，以将其移至其他产品/功能。

示例

# 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'

数据形状（--输出 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 连接删除

永久删除 BYO 产品配置。

参数

名称	必填	用途
<configuration-id>	是	BYO 产品配置 UUID。

选项

长	值	必填	描述
--force	标记	是	跳过确认。删除为永久性操作 — 省略 --force 会因明确拒绝而失败，未进行任何网络调用。

示例

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

数据形状（--输出 json）

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

uip llm 配置 byo 连接列表产品配置

列出支持 BYO LLM 配置的产品和操作组（功能），以及每个模型连接器/API 风格规则 create/update 的需求。

选项

长	值	描述
--product <name>	字符串	筛选出一个产品代码（精确匹配，区分大小写）。
--feature <name>	字符串	筛选出--product（精确匹配）内的某个操作组。需要 --product — 在任何请求之前单独传递 --feature 都会失败。
--models-only	标记	去除每个模型的 allowedApiFlavors/allowedConnectors（以及 alternativesWithProbes 条目上的相同字段）— 当您只需要模型列表时非常有用。无论何种情况，addYourOwn 和合成的通用替代条目都会保留其字段。

示例

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

数据形状（--输出 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 意味着只能通过该特定模型的 Custom 连接器访问 api- 服务器 - 其原生供应商目录不直接支持。AllModels 功能按主替代方案嵌套在 alternatives 下，每个替代方案都包含相同的主要替代方案集。

相关内容

• uip is connections — BYO 配置的--connection-id指向的 Integration Service 连接。
• uip or folders — 查找--folder-key值。

另请参阅

• 全局选项
• 退出代码