configuração-llm-uip

Sintaxe e opções para "uip llm-configuration byo-connections", que gerencia as configurações de produtos LLM do Bring-your-Own no UiPath AI Trust Layer / Gateway LLM.

uip llm-configuration gerencia configurações de produtos Bring-Your-Own LLM (BYO LLM) na AI Trust Layer da UiPath — apontando uma funcionalidade da UiPath (um agente, uma superfície de produto do Studio Web, uma atividade com IA) em um modelo de propriedade do cliente de um hospedado pela UiPath. A ferramenta é enviada como o pacote @uipath/llmgw-tool; cada comando é invocado como uip llm-configuration byo-connections <verb>.

Conceitos

• Produto / funcionalidade. Cada configuração tem como escopo um par (product, operationGroupName) — por exemplo, product=agents, feature=agents-design-eval-deploy. Descubra pares válidos e suas regras de modelo com list-product-configs antes de criar qualquer coisa.

• Configurações wrapper e internas. Um registro de configuração (o "wrapper") contém uma ou mais configurações de LLM internas, cada uma mapeando um modelo do catálogo da UiPath para um modelo de propriedade do cliente acessível por meio de uma conexão do Integration Service.

• Duas formas de criação para create/update — mutuamente exclusivas:

  • Atalho de mapeamento único — sinalizadores de nível superior (--llm-name, --connector-type, --connection-id, --api-flavor, --llm-identifier). Use para funcionalidades AnyModel e AnyModelWithOwnAdditions, que precisam de apenas um mapeamento interno.
  • Formulário de mapeamento múltiplo — repetível --mapping 'llm-name=…,llm-identifier=…,connector-type=…,api-flavor=…,connection-id=…'. Necessário para funcionalidades AllModels, que precisam de um mapeamento por modelo de catálogo em models[] (um modelo de catálogo pode ser satisfeito por uma de suas entradas alternativesWithProbes ou por uma alternativa genérica quando a funcionalidade define genericAlternativeProbes).

• Tradução do nome do campo — os nomes dos sinalizadores da CLI diferem da carga útil do conexão e dos rótulos de campo do portal do Studio Web:

  Rótulo do portal	Sinalizador da CLI	Campo de conexão
  Produto	--product	product
  Recurso	--feature	operationGroupName
  Pasta de conexões	--folder-key	folderId
  Conector	--connector-type (ou --mapping connector-type=…)	connectorType
  Conexão	--connection-id (ou --mapping connection-id=…)	connectionId
  Nome do LLM	--llm-name (ou --mapping llm-name=…)	desiredModel
  Tipo da API	--api-flavor (ou --mapping api-flavor=…)	apiFlavor
  Identificador do LLM	--llm-identifier (ou --mapping llm-identifier=…)	customerModel

• A validação no lado do servidor sempre é executada. create e update executam uma verificação de simulação do lado do cliente contra os catálogos de fornecedores/api-fla local em tempo real do gateway (rejeitando uma combinação --connector-type/--api-flavor antes de qualquer gravação de rede), em seguida, uma chamada de investigação do lado do servidor que realmente executa a conexão com o modelo fornecido. Não há sinalizador para ignorar nenhuma verificação — uma falha de investigação (conexão sem integridade, um --llm-identifier que a conta do fornecedor não expõe) anula a gravação com o reason da investigação e, quando disponível, um objeto summary.

• substituiupdate o wrapper. Ele busca o registro existente apenas para recuperar os campos de identidade product/operationGroupName/folderId/name bloqueados e, em seguida, aplica PUTs de um corpo recém-criado — cada mapeamento de modelo que você deseja deve ser fornecido novamente no update chamada em si; nada é transferido implicitamente. Não é possível alterar --product/--feature em uma configuração existente — exclua e recrie para mover para um produto/funcionalidade diferente.

• --login-validity <minutes> disponível em cada verbo para substituir o tempo de vida do token de login interativo para essa chamada.

Resumo

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]

Cada verbo também --login-validity <minutes> aceita.

lista de byo-connections do uip llm-configuration

Liste todas as configurações de produtos BYO LLM registradas para o tenant atual.

Opções

Long	Valor	Padrão	Description
--include-connection-details	Bandeira	desativada	Resolver e incluir metadados de conexão. Mais lento — faz uma chamada extra para o Integration Service por conexão.

Exemplo

uip llm-configuration byo-connections list

Formato dos dados (--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
        }
      ]
    }
  ]
}

As chaves de resposta são mantidas em seu CamelCase nativo, não no PascalCased — essa carga vai de ida e volta diretamente para ferramentas no estilo create/update. validConnection reflete a última integridade conhecida da conexão interna; passe --include-connection-details para forçar uma nova resolução.

uip llm-configuration byo-connections get

Buscar uma única configuração de produto BYO por ID.

Argumentos

Name	Required	Finalidade
<configuration-id>	sim	UUID de configuração do produto BYO. Obter de byo-connections list.

Opções

Long	Valor	Padrão	Description
--force-refresh	Bandeira	desativada	Ignore os detalhes de conexão em cache e resolva-os novamente no Integration Service.

Exemplo

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

Formato dos dados (--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-configuration byo-connectiontions criar

Crie uma nova configuração de produto BYO LLM a partir de sinalizadores CLI — nenhum arquivo JSON é necessário.

Opções

Long	Valor	Required	Description
--product <name>	String	sim	Código do produto. Por exemplo agents, agenthub. Descubra com list-product-configs.
--feature <name>	String	sim	Nome do grupo de operações dentro do produto (por exemplo agents-design-eval-deploy).
--folder-key <uuid>	UUID	sim	UUID da pasta de conexões. Descubra com uip or folders list.
--mapping <kv>	separados por vírgulas key=value, repetível	condicionalmente	Mapeamento por modelo. Chaves obrigatórias: llm-name, llm-identifier, connector-type, api-flavor, connection-id. Opcional: default-model. Necessário (um por modelo de catálogo) para as funcionalidades AllModels; mutuamente exclusivos com os sinalizadores abreviados de mapeamento único abaixo.
--connector-type <type>	um entre OpenAi, AzureOpenAi, AwsBedrock, AmazonWebServices, GoogleVertex, OpenAiV1Compatible, Custom	abreviação de mapeamento único	Conector do fornecedor.
--connection-id <uuid>	UUID	abreviação de mapeamento único	Conexão do Integration Service que contém as credenciais do fornecedor.
--llm-name <model>	String	abreviação de mapeamento único	Nome do modelo do catálogo da UiPath sendo substituído (fio: desiredModel).
--api-flavor <flavor>	um entre OpenAiChatCompletions, OpenAiResponses, OpenAiEmbeddings, GeminiGenerateContent, GeminiEmbeddings, AwsBedrockInvoke, AwsBedrockConverse, AnthropicMessages	abreviação de mapeamento único	Tipo de API.
--llm-identifier <model>	String	abreviação de mapeamento único	Alias do modelo do lado do fornecedor do cliente — o modelo para o qual o gateway realmente roteia (fio: customerModel).
--default-model <model>	String	não	Modelo principal de um grupo de operações com alternativas. O padrão é --llm-name.
--name <name>	String	não	Substitua o nome do wrapper gerado automaticamente. <feature>-<unix-millis>Padrão:.
--enabled / --no-enabled	Bandeira	não	Habilitar (padrão) ou salvar desabilitado.

O atalho de mapeamento único e --mapping são mutuamente exclusivos em uma invocação — passando ambos, ou um --mapping incompleto (faltando uma das cinco chaves necessárias), falha antes de qualquer chamada de rede, nomeando o sinalizador ofensiva.

Exemplos

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

Formato dos dados (--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 carrega uma entrada por modelo sondado durante a verificação pré-salvamento — isModelNameSimilar: false é um sinal de aviso que vale a pena verificar manualmente (o modelo do lado do fornecedor respondeu, mas seu nome não corresponde ao que você especificou).

Falha: erros de simulação e teste

Se --connector-type/--api-flavor não for uma combinação que os catálogos do gateway permitem, o comando falhará imediatamente com o sinalizador problemático — nenhuma gravação de rede acontece. Se a combinação for válida, mas a investigação ao vivo contra a conexão falhar (conexão sem integridade, um --llm-identifier que a conta do fornecedor não expõe na verdade), o comando falha com o reason da investigação e — quando o gateway retorna um — um summary e aponta você para uip is connections list e byo-connections list-product-configs --models-only para diagnosticar.

atualização de byo-connectiones do uip llm-configuration

Atualize uma configuração existente do produto BYO em vigor. PUTs todo o wrapper do zero — cada mapeamento de modelo deve ser fornecido novamente; nada é mesclado do registro existente, exceto os campos de identidade bloqueados.

Argumentos

Name	Required	Finalidade
<configuration-id>	sim	UUID de configuração do produto BYO.

Opções

Mesmas opções de mapeamento que create (--mapping, ou o atalho de mapeamento único --connector-type/--connection-id/--llm-name/--api-flavor/--llm-identifier/--default-model), mais:

Long	Valor	Description
--folder-key <uuid>	UUID	Substitua a pasta. O padrão é a pasta do registro existente.
--name <name>	String	Substitua o nome do wrapper. O padrão é o nome do registro existente.
--enabled / --no-enabled	Bandeira	Habilite ou desabilite a configuração.

--product/--feature não pode ser passado aqui — a identidade de uma configuração é corrigida na criação. Exclua e recrie para movê-lo para um produto/funcionalidade diferente.

Exemplos

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

Formato dos dados (--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
      }
    }
  }
}

A mesma validação de simulação/sondagem que create é executada antes da gravação — consulte Falha: erros de simulação e teste acima.

uip llm-configuration byo-connections excluir

Excluir permanentemente uma configuração do produto BYO.

Argumentos

Name	Required	Finalidade
<configuration-id>	sim	UUID de configuração do produto BYO.

Opções

Long	Valor	Required	Description
--force	Bandeira	sim	Ignore a confirmação. A exclusão é permanente — a omissão de --force falha com uma recusa explícita, nenhuma chamada de rede feita.

Exemplo

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

Formato dos dados (--output json)

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

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

Liste os produtos e grupos de operações (funcionalidades) compatíveis com a configuração do BYO LLM, com as regras de conector/api-flaver por modelo create/update precisam.

Opções

Long	Valor	Description
--product <name>	String	Filtre para um código de produto (correspondência exata, diferenciação entre maiúsculas e minúsculas).
--feature <name>	String	Filtre para um grupo de operações dentro de --product (correspondência exata). Requer --product — passar --feature individualmente falha antes de qualquer solicitação.
--models-only	Bandeira	Faixa por modelo allowedApiFlavors/allowedConnectors (e os mesmos campos em entradas alternativesWithProbes) — útil quando você quer apenas a lista de modelos. addYourOwn e a entrada alternativa genérica sintética mantêm seus campos independentemente.

Exemplos

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

Formato dos dados (--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 é um dos AnyModel, AnyModelWithOwnAdditions ou AllModels — ele determina se create/update precisa da abreviação de mapeamento único ou da forma --mapping de vários mapeamentos (consulte Conceitos). addYourOwn aparece apenas em funcionalidades AnyModelWithOwnAdditions, mapeando cada conector utilizável para os tipos de API válidos para um modelo adicionado pelo cliente que ainda não está em models[]. customConnectorOnlyApiFlavors em um modelo ou alternativa significa que o api- sabor é acessível apenas por meio de um conector Custom para esse modelo específico — seu catálogo de fornecedores nativo não é compatível com ele diretamente. AllModels apresenta alternativas aninhadas por principal em alternatives, cada uma carregando o mesmo conjunto de investigação do primário.

Relacionado

• uip is connections — as conexões do Integration Service em que --connection-id aponta uma configuração BYO.
• uip or folders — encontre valores --folder-key .

Veja também

• Opções globais
• Códigos de saída