configuration llm uip

Syntaxe et options pour `uip llm-configuration byo-connections`, qui gère les configurations de produits LLM Bring-Your-Own dans la passerelle UiPath AI Trust Layer/LLM.

uip llm-configuration gère les configurations de produits Bring-Your-Own LLM dans UiPath AI Trust Layer — pointant une fonctionnalité UiPath (un agent, une surface de produit Studio Web, une activité alimentée par l'IA) vers un modèle appartenant au client à la place d'un hébergement hébergé par UiPath. L'outil est fourni sous la forme du package @uipath/llmgw-tool; chaque commande est invoquée sous la forme uip llm-configuration byo-connections <verb>.

Concepts

• Produit/fonctionnalité. Chaque configuration est définie sur une paire (product, operationGroupName), par exemple product=agents, feature=agents-design-eval-deploy. Découvrez des paires valides et leurs règles de modèle avec list-product-configs avant de créer quoi que ce soit.

• Configurations de l'encapsuleur et internes. Un enregistrement de configuration (le « wrapper») contient une ou plusieurs configurations LLM internes, chacune mappant un modèle de catalogue UiPath à un modèle appartenant au client accessible via une connexion Integration Service.

• Deux formes de création pour create/update — mutuellement exclusifs:

  • Raccourci à mappage unique — indicateurs de niveau supérieur (--llm-name, --connector-type, --connection-id, --api-flavor, --llm-identifier). À utiliser pour les fonctionnalités AnyModel et AnyModelWithOwnAdditions, qui ne nécessitent qu'un mappage interne.
  • Formulaire multi-mappage — répétable --mapping 'llm-name=…,llm-identifier=…,connector-type=…,api-flavor=…,connection-id=…'. Requis pour les fonctionnalités AllModels, qui nécessitent un mappage par modèle de catalogue dans models[] (un modèle de catalogue peut être satisfait par l'une de ses alternativesWithProbes entrées ou par une alternative générique lorsque la fonctionnalité définit genericAlternativeProbes).

• Traduction des noms de champs — les noms d'indicateurs de la CLI diffèrent de la charge utile du fil et des libellés de champs du portail Studio Web:

  Libellé du portail	Indicateur CLI	Champ du fil de connexion
  Produit	--product	product
  Fonctionnalités	--feature	operationGroupName
  Dossier des connexions	--folder-key	folderId
  Connecteur	--connector-type (ou --mapping connector-type=…)	connectorType
  Connexion (Connection)	--connection-id (ou --mapping connection-id=…)	connectionId
  Nom du LLM	--llm-name (ou --mapping llm-name=…)	desiredModel
  Type d'API	--api-flavor (ou --mapping api-flavor=…)	apiFlavor
  Identifiant du LLM	--llm-identifier (ou --mapping llm-identifier=…)	customerModel

• La validation côté serveur est toujours exécutée. create et update exécutent tous deux une vérification en amont côté client par rapport aux catalogues de fournisseurs/d'indicateurs d'API en direct de la passerelle (rejetant une combinaison --connector-type/--api-flavor non prise en charge avant toute écriture réseau), puis un appel de sonde côté serveur qui gère réellement la connexion avec le modèle donné. Il n'y a aucun indicateur à ignorer soit de la vérification, soit un échec de sonde (connexion incorrecte, une --llm-identifier que le compte du fournisseur n'expose pas) abandonne l'écriture avec le reason de la sonde et, lorsqu'il est disponible, un objet summary.

• update remplace l'ensemble du wrapper. Il récupère l’enregistrement existant uniquement pour récupérer les champs d’identité product/operationGroupName/folderId/name verrouillés, puis PUT un corps nouvellement créé - chaque mappage de modèle que vous souhaitez doit être fourni à nouveau dans le update s'appelle lui-même; rien n'est reporté implicitement. --product/--feature ne peut pas être modifié sur une configuration existante — supprimer et recréer pour déplacer un vers un autre produit/fonctionnalité.

• --login-validity <minutes> est disponible sur chaque verbe pour remplacer la durée de vie du jeton de connexion interactive pour cet appel.

Synthèse

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]

Chaque verbe accepte également --login-validity <minutes>.

uip llm-configuration par liste-connexions

Répertorie toutes les configurations de produits BYO LLM enregistrées pour le locataire actuel.

Options

Long	Valeur (Value)	Default	Description
--include-connection-details	Drapeau	désactivé	Résolvez et incluez les métadonnées de connexion. Plus lent: un appel supplémentaire est effectué vers Integration Service par connexion.

Exemple

uip llm-configuration byo-connections list

Format des données (--sortie 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
        }
      ]
    }
  ]
}

Les clés de réponse sont conservées dans leur camelCase natif, et non PascalCase - cette charge utile va directement dans les outils de style create/update. validConnection reflète la dernière santé connue de la connexion interne; transmettez --include-connection-details pour forcer une nouvelle résolution.

uip llm-configuration paro-connexions - obtenir

Récupérer une seule configuration de produit BYO par ID.

Arguments

Nom	Requis	Objectif
<configuration-id>	oui	UUID de configuration du produit BYO. Obtenir auprès de byo-connections list.

Options

Long	Valeur (Value)	Default	Description
--force-refresh	Drapeau	désactivé	Contournez les détails des connexions mises en cache et résolvez-les à partir d’Integration Service.

Exemple

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

Format des données (--sortie 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 paro-connections - créer

Créez une nouvelle configuration de produit BYO LLM à partir des indicateurs CLI — aucun fichier JSON requis.

Options

Long	Valeur (Value)	Requis	Description
--product <name>	string	oui	Code du produit, par ex. agents, agenthub. Découvrir avec list-product-configs.
--feature <name>	string	oui	Nom du groupe d'opérations dans le produit (par exemple, agents-design-eval-deploy).
--folder-key <uuid>	UUID	oui	UUID du dossier de connexions. Découvrez avec uip or folders list.
--mapping <kv>	key=value séparé par des virgules, répétable	Conditionnel	Mappage par modèle. Clés requises: llm-name, llm-identifier, connector-type, api-flavor, connection-id. Facultatif: default-model. Requis (une par modèle de catalogue) pour AllModels fonctionnalités; mutuellement exclusifs avec les indicateurs de raccourci à mappage unique ci-dessous.
--connector-type <type>	l’un des OpenAi, AzureOpenAi, AwsBedrock, AmazonWebServices, GoogleVertex, OpenAiV1Compatible, Custom	Raccourci à mappage unique	Connecteur fournisseur.
--connection-id <uuid>	UUID	Raccourci à mappage unique	Connexion Integration Service contenant les informations d'identification du fournisseur.
--llm-name <model>	string	Raccourci à mappage unique	Le nom du modèle de catalogue UiPath est remplacé. desiredModel
--api-flavor <flavor>	l’un des OpenAiChatCompletions, OpenAiResponses, OpenAiEmbeddings, GeminiGenerateContent, GeminiEmbeddings, AwsBedrockInvoke, AwsBedrockConverse, AnthropicMessages	Raccourci à mappage unique	Type d'API.
--llm-identifier <model>	string	Raccourci à mappage unique	Alias du modèle côté fournisseur du client — le modèle vers lequel la passerelle acheminecustomerModel réellement.
--default-model <model>	string	non	Modèle principal d'un groupe d'opérations avec des alternatives. La valeur par défaut est --llm-name.
--name <name>	string	non	Remplacer le nom du encapsuleur généré automatiquement. Par défaut: <feature>-<unix-millis>.
--enabled / --no-enabled	Drapeau	non	Activez (par défaut) ou enregistrez désactivé.

Le raccourci de mappage unique et le nom --mapping s'excluent mutuellement au moment d'une même invocation — comme la transmission des deux ou une --mapping incomplète (manquant l'une des cinq clés requises), qui échoue avant tout appel réseau et le nommage de l'indicateur incriminé.

Exemples

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

Format des données (--sortie 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 comporte une entrée par modèle testé lors de la vérification préalable à l'enregistrement — isModelNameSimilar: false est un panneau d'avertissement qui méritent d'être vérifiés manuellement (le modèle côté fournisseur a répondu, mais son nom ne correspond pas exactement à ce que vous avez spécifié).

Échec: erreurs d'amorçage et de sonde

Si --connector-type/--api-flavor n'est pas une combinaison autorisée par les catalogues de la passerelle, la commande échoue immédiatement avec l'indicateur incriminé nommé — aucune écriture réseau ne se produit. Si la combinaison est valide, mais que la sonde en direct de la connexion échoue (connexion incorrecte, --llm-identifier que le compte fournisseur n'expose pas réellement), la commande échoue avec le reason de la sonde et, lorsque la passerelle en renvoie un, un summary et vous dirige vers uip is connections list et byo-connections list-product-configs --models-only pour diagnostiquer.

uip llm-configuration paro-connections - mise à jour

Mettez à jour une configuration de produit BYO existante en place. PUT l'ensemble du wrapper à partir de zéro — chaque mappage de modèle doit être fourni à nouveau; rien n’est fusionné à partir de l’enregistrement existant, à l’exception des champs d’identité verrouillés.

Arguments

Nom	Requis	Objectif
<configuration-id>	oui	UUID de configuration du produit BYO.

Options

Mêmes options de mappage que create (--mapping, ou le raccourci à mappage unique --connector-type/--connection-id/--llm-name/--api-flavor/--llm-identifier/--default-model), plus:

Long	Valeur (Value)	Description
--folder-key <uuid>	UUID	Remplacer le dossier. Par défaut, le dossier de l'enregistrement existant.
--name <name>	string	Remplacer le nom du encapsuleur. Par défaut, le nom de l'enregistrement existant.
--enabled / --no-enabled	Drapeau	Activez ou désactivez la configuration.

--product/--feature ne peut pas être transmis ici — l'identité d'une configuration est corrigée lors de la création. Supprimer et recréer pour le déplacer vers un autre produit/fonctionnalité.

Exemples

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

Format des données (--sortie 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
      }
    }
  }
}

Mêmes validation en amont/sondes que create s'exécute avant l'écriture — voir Échec: erreurs en amont et de sonde ci-dessus.

uip llm-configuration paro-connexions - suppression

Supprimer définitivement une configuration de produit BYO.

Arguments

Nom	Requis	Objectif
<configuration-id>	oui	UUID de configuration du produit BYO.

Options

Long	Valeur (Value)	Requis	Description
--force	Drapeau	oui	Ignorez la confirmation. La suppression est permanente, l'absence de --force échoue avec un refus explicite, aucun appel réseau n'est effectué.

Exemple

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

Format des données (--sortie json)

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

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

Répertoriez les produits et les groupes d'opérations (fonctionnalités) qui prennent en charge la configuration BYO LLM, avec les règles de connecteur/configuration d'API par modèle create/update requises.

Options

Long	Valeur (Value)	Description
--product <name>	string	Filtrer sur un code produit (correspondance exacte, sensible à la casse).
--feature <name>	string	Filtrez sur un groupe d'opérations dans --product (correspondance exacte). Nécessite --product — la transmission de --feature seul échoue avant toute requête.
--models-only	Drapeau	Réduire par modèle allowedApiFlavors/allowedConnectors (et les mêmes champs pour les entrées alternativesWithProbes) — utile lorsque vous voulez simplement la liste des modèles. addYourOwn et l'entrée générique-alternative synthétique conservent leurs champs indépendamment.

Exemples

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

Format des données (--sortie 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 est l'un de AnyModel, AnyModelWithOwnAdditions, ou AllModels — il détermine si create/update a besoin du raccourci à mappage unique ou du formulaire --mapping à mappage multiple (voir Concepts). addYourOwn apparaît uniquement sur les fonctionnalités AnyModelWithOwnAdditions, mappant chaque connecteur utilisable aux versions d'API valides pour un modèle ajouté par le client pas déjà dans models[]. customConnectorOnlyApiFlavors sur un modèle ou une alternative signifie que api-flator n’est accessible que via un connecteur Custom pour ce modèle spécifique - son catalogue de fournisseurs natif ne le prend pas en charge directement. AllModels propose des alternatives par primaires sous alternatives, chacune portant le même ensemble de sondes de la même primaire.

Associé

• uip is connections — l'Integration Service connecte les points --connection-id d'une configuration BYO.
• uip or folders — recherchez des valeurs --folder-key .

Voir également

• Options globales
• Codes de sortie