Configuración de UIP llm

Sintaxis y opciones para `uip llm-configuration byo-connections`, que gestiona las configuraciones del producto Bring-Your-Own LLM en AI Trust Layer/puerta de enlace de LLM de UiPath.

uip llm-configuration las configuraciones de productos Bring-Your-Own LLM (BYO LLM) en AI Trust Layer de UiPath: apunta una característica de UiPath (un agente, una superficie de producto de Studio Web, una actividad impulsada por IA) en su lugar a un modelo propiedad del cliente de uno alojado en UiPath. La herramienta se envía como el paquete @uipath/llmgw-tool; cada comando se invoca como uip llm-configuration byo-connections <verb>.

Conceptos

• Producto/característica. Cada configuración se limita a un par (product, operationGroupName), por ejemplo, product=agents, feature=agents-design-eval-deploy. Descubre pares válidos y sus reglas de modelo con list-product-configs antes de crear cualquier cosa.

• Configuraciones de contenedor e internas. Un registro de configuración (el "envoltorio") contiene una o más configuraciones internas de LLM, cada una de las cuales asigna un modelo de catálogo de UiPath a un modelo propiedad del cliente accesible a través de una conexión de Integration Service.

• Dos formas de creación para create/update , mutuamente excluyentes:

  • Taquigrafía de asignación única : marcadores de nivel superior (--llm-name, --connector-type, --connection-id, --api-flavor, --llm-identifier). Utilízalo para las características AnyModel y AnyModelWithOwnAdditions, que solo necesitan una asignación interna.
  • Formulario de asignación múltiple : --mapping 'llm-name=…,llm-identifier=…,connector-type=…,api-flavor=…,connection-id=…' repetible. Obligatorio para las características AllModels, que necesitan una asignación por modelo de catálogo en models[] (un modelo de catálogo puede ser satisfecho por una de sus entradas alternativesWithProbes, o por una alternativa genérica cuando la característica define genericAlternativeProbes).

• Traducción de nombres de campo : los nombres de los marcadores de la CLI difieren de la carga útil de la conexión y de las etiquetas de campo del portal de Studio Web:

  Etiqueta del portal	Indicador CLI	Campo de conexión
  Producto	--product	product
  Función	--feature	operationGroupName
  Carpeta de conexiones	--folder-key	folderId
  Conector	--connector-type (o --mapping connector-type=…)	connectorType
  Conexión	--connection-id (o --mapping connection-id=…)	connectionId
  Nombre de LLM	--llm-name (o --mapping llm-name=…)	desiredModel
  Tipo de API	--api-flavor (o --mapping api-flavor=…)	apiFlavor
  Identificador de LLM	--llm-identifier (o --mapping llm-identifier=…)	customerModel

• La validación del lado del servidor siempre se ejecuta. create y update ejecutan una comprobación previa del lado del cliente con los catálogos de proveedor/api-flavor activos de la puerta de enlace (rechazando una combinación no compatible --connector-type/--api-flavor antes de cualquier escritura de red), luego una llamada de sondeo del lado del servidor que realmente ejerza la conexión con el modelo dado. No hay marca para omitir ninguna de las comprobaciones: un fallo de la sonda (conexión en mal estado, un --llm-identifier que la cuenta del proveedor no expone) aborta la escritura con el reason de la sonda y, cuando esté disponible, un objeto summary.

• update reemplaza el contenedor completo. Obtiene el registro existente solo para recuperar los campos de identidad bloqueados product/operationGroupName/folderId/name, luego PUT un cuerpo recién creado: cada asignación de modelo que desee debe volver a proporcionarse en el update se llama a sí mismo; nada se transfiere implícitamente. --product/--feature no se puede cambiar en una configuración existente: eliminar y volver a crear para mover uno a un producto/característica diferente.

• --login-validity <minutes> está disponible en cada verbo para anular la vida útil del token de inicio de sesión interactivo para esa llamada.

Sinopsis

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 también acepta --login-validity <minutes>.

lista byo-connections de uip llm-configuration

Enumera todas las configuraciones de productos BYO LLM registradas para el tenant actual.

Opciones

Largo	Valor	Predeterminado	Descripción
--include-connection-details	Marca	Desactivado	Resolver e incluir metadatos de conexión. Más lento: realiza una llamada adicional a Integration Service por conexión.

Ejemplo

uip llm-configuration byo-connections list

Forma de datos (--json de salida)

{
  "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
        }
      ]
    }
  ]
}

Las claves de respuesta se mantienen en su camelCase nativo, no en PascalCased: esta carga útil se traslada directamente a las herramientas de estilo create/update. validConnection refleja el último estado conocido de la conexión interna; introduce --include-connection-details para forzar una nueva resolución.

uip llm-configuration byo-connections get

Obtener una única configuración de producto BYO por ID.

Argumentos

Nombre	Obligatorio	Propósito
<configuration-id>	Sí	UUID de configuración del producto BYO. Obtener de byo-connections list.

Opciones

Largo	Valor	Predeterminado	Descripción
--force-refresh	Marca	Desactivado	Omite los detalles de conexión en caché y vuelve a resolverlos desde Integration Service.

Ejemplo

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

Forma de datos (--json de salida)

{
  "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-connections create

Crea una nueva configuración de producto BYO LLM a partir de indicadores CLI: no se requiere archivo JSON.

Opciones

Largo	Valor	Obligatorio	Descripción
--product <name>	String	Sí	Código de producto, por ejemplo agents, agenthub. Descubrir con list-product-configs.
--feature <name>	String	Sí	Nombre del grupo de operaciones dentro del producto (por ejemplo agents-design-eval-deploy).
--folder-key <uuid>	Uuid	Sí	UUID de la carpeta de conexiones. Descubrir con uip or folders list.
--mapping <kv>	separados por comas key=value, repetibles	condicionalmente	Asignación por modelo. Claves necesarias: llm-name, llm-identifier, connector-type, api-flavor, connection-id. Opcional: default-model. Obligatorio (uno por modelo de catálogo) para las características AllModels; se excluyen mutuamente con los siguientes marcadores abreviados de asignación única.
--connector-type <type>	uno de OpenAi, AzureOpenAi, AwsBedrock, AmazonWebServices, GoogleVertex, OpenAiV1Compatible, Custom	abreviatura de asignación única	Conector de proveedor.
--connection-id <uuid>	Uuid	abreviatura de asignación única	Conexión de Integration Service que contiene las credenciales del proveedor.
--llm-name <model>	String	abreviatura de asignación única	Se está reemplazando el nombre del modelo del catálogo de UiPath (conexión: desiredModel).
--api-flavor <flavor>	uno de OpenAiChatCompletions, OpenAiResponses, OpenAiEmbeddings, GeminiGenerateContent, GeminiEmbeddings, AwsBedrockInvoke, AwsBedrockConverse, AnthropicMessages	abreviatura de asignación única	Tipo de API.
--llm-identifier <model>	String	abreviatura de asignación única	Alias del modelo del lado del proveedor del cliente: el modelo al que la puerta de enlace enruta realmente (conexión: customerModel).
--default-model <model>	String	No	Modelo principal para un grupo de operaciones con alternativas. El valor predeterminado es --llm-name.
--name <name>	String	No	Anula el nombre del contenedor generado automáticamente. Predeterminado: <feature>-<unix-millis>.
--enabled / --no-enabled	Marca	No	Habilitar (predeterminado) o guardar deshabilitado.

La abreviatura de asignación única y --mapping son mutuamente excluyentes en una invocación: pasar ambas, o una --mapping incompleta (falta una de las cinco claves necesarias), falla antes de cualquier llamada de red, nombrando el marcador infractor.

Ejemplos

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

Forma de datos (--json de salida)

{
  "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 lleva una entrada por modelo sondeado durante la comprobación previa al guardado: isModelNameSimilar: false es una señal de advertencia que vale la pena comprobar manualmente (el modelo del lado del proveedor respondió, pero su nombre no coincide con lo especificado).

Error: errores de comprobación previa y sondeo

Si --connector-type/--api-flavor no es una combinación que permiten los catálogos de la puerta de enlace, el comando falla inmediatamente con el marcador ofensivo llamado: no se produce escritura en la red. Si la combinación es válida pero el sondeo en vivo contra la conexión falla (conexión en mal estado, un --llm-identifier que la cuenta del proveedor no expone en realidad), el comando falla con el reason del sondeo y, cuando la puerta de enlace devuelve uno, un summary y te dirige a uip is connections list y byo-connections list-product-configs --models-only para diagnosticar.

actualización de byo-connections de configuración llm de uip

Actualizar una configuración de producto BYO existente en su lugar. PUT todo el contenedor desde cero: cada asignación de modelo debe volver a proporcionarse; nada se fusiona del registro existente excepto los campos de identidad bloqueados.

Argumentos

Nombre	Obligatorio	Propósito
<configuration-id>	Sí	UUID de configuración del producto BYO.

Opciones

Las mismas opciones de asignación que create (--mapping, o la forma abreviada de asignación única --connector-type/--connection-id/--llm-name/--api-flavor/--llm-identifier/--default-model), más:

Largo	Valor	Descripción
--folder-key <uuid>	Uuid	Anula la carpeta. El valor predeterminado es la carpeta del registro existente.
--name <name>	String	Anula el nombre del contenedor. El valor predeterminado es el nombre del registro existente.
--enabled / --no-enabled	Marca	Habilita o deshabilita la configuración.

--product/--feature no se puede pasar aquí: la identidad de una configuración se fija en la creación. Eliminar y volver a crear para moverlo a un producto/característica diferente.

Ejemplos

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

Forma de datos (--json de salida)

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

La misma validación de verificación previa/sonda que create se ejecuta antes de la escritura — consulta Fallo: errores de verificación previa y sondeo más arriba.

uip llm-configuration byo-connections eliminar

Eliminar de forma permanente una configuración de producto BYO.

Argumentos

Nombre	Obligatorio	Propósito
<configuration-id>	Sí	UUID de configuración del producto BYO.

Opciones

Largo	Valor	Obligatorio	Descripción
--force	Marca	Sí	Omite la confirmación. La eliminación es permanente: omitir --force falla con un rechazo explícito, no se realiza ninguna llamada de red.

Ejemplo

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

Forma de datos (--json de salida)

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

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

Enumera los productos y grupos de operaciones (características) que admiten la configuración BYO LLM, con el conector por modelo/reglas de tipo API que create/update necesitan.

Opciones

Largo	Valor	Descripción
--product <name>	String	Filtrar a un código de producto (coincidencia exacta, distingue entre mayúsculas y minúsculas).
--feature <name>	String	Filtrar a un grupo de operaciones dentro de --product (coincidencia exacta). Requiere --product: pasar --feature solo falla antes de cualquier solicitud.
--models-only	Marca	Elimina allowedApiFlavors/allowedConnectors por modelo (y los mismos campos en las entradas alternativesWithProbes): útil cuando solo quieres la lista de modelos. addYourOwn y la entrada alternativa genérica sintética mantienen sus campos independientemente.

Ejemplos

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

Forma de datos (--json de salida)

{
  "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 es uno de AnyModel, AnyModelWithOwnAdditions o AllModels : determina si create/update necesita la forma abreviada de asignación única o la forma de asignación múltiple --mapping (consulta Conceptos). addYourOwn aparece solo en las características AnyModelWithOwnAdditions, asignando cada conector utilizable a los sabores de API válidos para un modelo añadido por el cliente que aún no está en models[]. customConnectorOnlyApiFlavors en un modelo o alternativa significa que solo se puede acceder a api-flavor a través de un conector Custom para ese modelo específico; su catálogo de proveedores nativos no lo admite directamente. AllModels presenta alternativas anidadas por principal en alternatives, cada una con el mismo conjunto de sondeo del principal.

Relacionado

• uip is connections : las conexiones de Integration Service a las que apunta una configuración BYO --connection-id .
• uip or folders : busca valores --folder-key .

Ver también

• Opciones globales
• Códigos de salida