uip llm-configuration

Syntax und Optionen für „uip llm-configuration byo-connections“, die Bring-Your-Own-LLM-Produktkonfigurationen im UiPath AI Trust Layer/LLM Gateway verwaltet.

uip llm-configuration verwaltet Bring-Your-Own-LLM-Produktkonfigurationen (BYO LLM) im UiPath AI Trust Layer – verweist stattdessen auf eine UiPath-Funktion (ein Agent, eine Studio Web-Produktoberfläche, eine KI-gestützte Aktivität) auf ein kundeneigenes Modell eines von UiPath gehosteten Pakets. Das Tool wird als @uipath/llmgw-tool -Paket ausgeliefert; Jeder Befehl wird als uip llm-configuration byo-connections <verb> aufgerufen.

Konzepte

• Produkt/Funktion. Jede Konfiguration ist auf ein (product, operationGroupName) -Paar beschränkt – z. B. product=agents, feature=agents-design-eval-deploy. Entdecken Sie gültige Paare und deren Modellregeln mit list-product-configs , bevor Sie etwas erstellen.

• Wrapper und inneren Konfigurationen. Ein Konfigurationsdatensatz (der „Wrapper“) enthält eine oder mehrere innere LLM-Konfigurationen, die jeweils ein UiPath-Katalogmodell einem kundeneigenen Modell zuordnen, das über eine Integration Service-Verbindung erreichbar ist.

• Zwei Autorenstrukturen für create/update – sich gegenseitig ausschließen:

  • Kurzinfo für Einzelzuordnung – Flags der obersten Ebene (--llm-name, --connector-type, --connection-id, --api-flavor, --llm-identifier). Wird für AnyModel - und AnyModelWithOwnAdditions -Funktionen verwendet, die nur eine innere Zuordnung benötigen.
  • Formular mit Mehrfachzuordnung – wiederholbar --mapping 'llm-name=…,llm-identifier=…,connector-type=…,api-flavor=…,connection-id=…'. Erforderlich für AllModels -Funktionen, die eine Zuordnung pro Katalogmodell in models[] benötigen (ein Katalogmodell kann durch einen seiner alternativesWithProbes -Einträge oder durch eine generische Alternative erfüllt werden, wenn die Funktion genericAlternativeProbes definiert).

• Feldnamenübersetzung – Die Flag-Namen der CLI unterscheiden sich von der grafischen Nutzlast und den Feldbeschriftungen des Studio Web-Portals:

  Portal-Beschriftung	CLI-Flag	Nachrichtenfeld
  Produkt	--product	product
  Funktionen	--feature	operationGroupName
  Verbindungsordner	--folder-key	folderId
  Connector	--connector-type (oder --mapping connector-type=…)	connectorType
  Verbindung (Connection)	--connection-id (oder --mapping connection-id=…)	connectionId
  LLM-Name	--llm-name (oder --mapping llm-name=…)	desiredModel
  API-Typ	--api-flavor (oder --mapping api-flavor=…)	apiFlavor
  LLM-Bezeichner	--llm-identifier (oder --mapping llm-identifier=…)	customerModel

• Die serverseitige Validierung wird immer ausgeführt. create und update führen beide eine clientseitige Preflight-Prüfung anhand der Live-Anbieter-/API-Variantenkataloge des Gateways durch (eine nicht unterstützte --connector-type/--api-flavor -Kombination vor einem Netzwerkschreibung wird abgelehnt) und dann einen serverseitigen Probeaufruf das tatsächlich die Verbindung mit dem angegebenen Modell ausführt. Es gibt kein Flag, mit dem eine der beiden Prüfungen übersprungen werden kann – ein Testfehler (fehlerhafte Verbindung, ein --llm-identifier, das das Anbieterkonto nicht verfügbar macht) bricht den Schreibvorgang mit dem reason des Testers und, falls verfügbar, einem summary -Objekt ab.

• update ersetzt den gesamten Wrapper. Es ruft den vorhandenen Datensatz nur ab, um die gesperrten Identitätsfelder product/operationGroupName/folderId/name wiederherzustellen, dann PUTs für einen neu erstellten Textkörper – jede gewünschte Modellzuordnung muss in update erneut bereitgestellt werden } sich selbst aufrufen; nichts wird implizit übertragen. --product/--feature können für eine vorhandene Konfiguration nicht geändert werden – löschen und neu erstellen, um eine in ein anderes Produkt/eine andere Funktion zu verschieben.

• --login-validity <minutes> ist für jedes Verb verfügbar, um die Lebensdauer des interaktiven Anmeldetokens für diesen einen Aufruf zu überschreiben.

Zusammenfassung

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]

Jedes Verb akzeptiert auch --login-validity <minutes>.

uip llm-configuration byo-connections-Liste

Listen Sie alle BYO-LLM-Produktkonfigurationen auf, die für den aktuellen Mandanten registriert sind.

Optionen

Long	Wert	Standard	Beschreibung
--include-connection-details	Markieren	aus	Auflösen und Verbindungsmetadaten einschließen. Langsamer – ruft zusätzlich den Integration Service pro Verbindung auf.

Beispiel

uip llm-configuration byo-connections list

Datenform (--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
        }
      ]
    }
  ]
}

Antwortschlüssel werden in ihrem nativen BinnenMajuskel (CamelCase) beibehalten, nicht in PascalCase – diese Nutzlast wird direkt in die Tools im create/update-Stil umgeleitet. validConnection spiegelt den letzten bekannten Zustand der inneren Verbindung wider; übergeben Sie --include-connection-details, um eine neue Auflösung zu erzwingen.

Abrufen der uip llm-configuration byo-connections

Rufen Sie eine einzelne BYO-Produktkonfiguration nach ID ab.

Argumente

Name	Erforderlich	Zweck
<configuration-id>	ja	UUID der BYO-Produktkonfiguration. Von byo-connections list abrufen.

Optionen

Long	Wert	Standard	Beschreibung
--force-refresh	Markieren	aus	Umgehen Sie zwischengespeicherte Verbindungsdetails und lösen Sie sie erneut aus dem Integration Service auf.

Beispiel

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

Datenform (--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
      }
    ]
  }
}

Erstellung der uip llm-configuration byo-connections

Erstellen Sie eine neue BYO-LLM-Produktkonfiguration aus CLI-Flags – keine JSON-Datei erforderlich.

Optionen

Long	Wert	Erforderlich	Beschreibung
--product <name>	string	ja	Produktcode, z. B. agents, agenthub). Mit list-product-configs erkennen.
--feature <name>	string	ja	Name der Vorgangsgruppe innerhalb des Produkts (z. B. agents-design-eval-deploy).
--folder-key <uuid>	UUID	ja	UUID des Verbindungsordners. Mit uip or folders list erkennen.
--mapping <kv>	durch Komma getrennte key=value, wiederholbar	bedingt	Zuordnung pro Modell. Erforderliche Schlüssel: llm-name, llm-identifier, connector-type, api-flavor, connection-id. Optional: default-model. Erforderlich (eine pro Katalogmodell) für AllModels -Funktionen; sich gegenseitig mit den untenstehenden Flags für einzelne Zuordnungen ausschließen.
--connector-type <type>	einer von OpenAi, AzureOpenAi, AwsBedrock, AmazonWebServices, GoogleVertex, OpenAiV1Compatible, Custom	Kurzinfo für Einzelzuordnung	Anbieter-Connector.
--connection-id <uuid>	UUID	Kurzinfo für Einzelzuordnung	Integration Service-Verbindung, die Anbieteranmeldeinformationen enthält.
--llm-name <model>	string	Kurzinfo für Einzelzuordnung	Name des UiPath-Katalogmodells wird ersetzt (Dwird: desiredModel).
--api-flavor <flavor>	einer von OpenAiChatCompletions, OpenAiResponses, OpenAiEmbeddings, GeminiGenerateContent, GeminiEmbeddings, AwsBedrockInvoke, AwsBedrockConverse, AnthropicMessages	Kurzinfo für Einzelzuordnung	API-Typ.
--llm-identifier <model>	string	Kurzinfo für Einzelzuordnung	Anbieterseitiges Modell-Alias des Kunden – das Modell, an das das Gateway tatsächlich weiterleitet (Dank: customerModel).
--default-model <model>	string	nein	Primäres Modell für eine Vorgangsgruppe mit Alternativen. Die Standardeinstellung ist --llm-name.
--name <name>	string	nein	Überschreiben Sie den automatisch generierten Wrapper-Namen. Standard: <feature>-<unix-millis>.
--enabled / --no-enabled	Markieren	nein	Aktivieren (Standard) oder Speichern deaktiviert.

Die Kurzform für eine einzelne Zuordnung und --mapping schließen sich gegenseitig bei einem Aufruf aus – das Übergeben von beiden oder ein unvollständiges --mapping (fehlt einer der fünf erforderlichen Schlüssel) schlägt fehl, bevor jeder Netzwerkaufruf benannt wird und das fehlerhafte Flag benennen.

Beispiele

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

Datenform (--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 hat einen Eintrag pro Modell, das während der Vorspeicherprüfung getestet wurde – isModelNameSimilar: false ist ein Warnzeichen, das es wert ist, manuell überprüft zu werden (das Anbietermodell hat geantwortet, aber sein Name entspricht nicht genau dem, was Sie angegeben haben).

Fehler: Preflight- und Testfehler

Wenn --connector-type/--api-flavor keine Kombination ist, die die Kataloge des Gateways zulassen, schlägt der Befehl sofort mit dem fehlerhaften Flag namens „Es erfolgt kein Netzwerkschreibvorgang“ fehl. Wenn die Kombination gültig ist, aber der Live-Test für die Verbindung fehlschlägt (fehlerhafte Verbindung, ein --llm-identifier, das das Anbieterkonto nicht tatsächlich verfügbar macht), schlägt der Befehl mit dem reason des Testes fehl und – wenn das Gateway einen zurückgibt – einem summary -Objekt und verweist Sie auf uip is connections list und byo-connections list-product-configs --models-only zur Diagnose.

Aktualisierung der uip llm-configuration byo-connections

Aktualisieren Sie eine vorhandene BYO-Produktkonfiguration. PUTs für den gesamten Wrapper von Grund auf – jede Modellzuordnung muss erneut bereitgestellt werden; mit Ausnahme der gesperrten Identitätsfelder wird nichts mit dem vorhandenen Datensatz zusammengeführt.

Argumente

Name	Erforderlich	Zweck
<configuration-id>	ja	UUID der BYO-Produktkonfiguration.

Optionen

Die gleichen Zuordnungsoptionen wie create (--mapping oder die Kurzform für einzelne Zuordnungen --connector-type/--connection-id/--llm-name/--api-flavor/--llm-identifier/--default-model), plus:

Long	Wert	Beschreibung
--folder-key <uuid>	UUID	Überschreiben Sie den Ordner. Standardmäßig der Ordner des vorhandenen Datensatzes.
--name <name>	string	Überschreiben Sie den Wrapper-Namen. Standardmäßig der Name des vorhandenen Datensatzes.
--enabled / --no-enabled	Markieren	Aktivieren oder deaktivieren Sie die Konfiguration.

--product/--feature kann hier nicht übergeben werden – die Identität einer Konfiguration wird bei der Erstellung festgelegt. Löschen und neu erstellen, um es in ein anderes Produkt/eine andere Funktion zu verschieben.

Beispiele

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

Datenform (--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
      }
    }
  }
}

Die gleiche Preflight-/Testvalidierung wie create wird vor dem Schreiben ausgeführt – siehe Fehler: Preflight- und Testfehler oben.

Löschen von uip llm-configuration byo-connections

Löschen Sie eine BYO-Produktkonfiguration endgültig.

Argumente

Name	Erforderlich	Zweck
<configuration-id>	ja	UUID der BYO-Produktkonfiguration.

Optionen

Long	Wert	Erforderlich	Beschreibung
--force	Markieren	ja	Überspringen Sie die Bestätigung. Das Löschen ist endgültig – das Auslassen von --force schlägt mit einer expliziten Ablehnung fehl, es erfolgt kein Netzwerkaufruf.

Beispiel

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

Datenform (--output json)

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

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

Listen Sie die Produkte und Vorgangsgruppen (Funktionen) auf, die die BYO-LLM-Konfiguration unterstützen, wobei die erforderlichen create/update -Regeln pro Modell für Connector/API-Varianten benötigt werden.

Optionen

Long	Wert	Beschreibung
--product <name>	string	Filtern Sie zu einem Produktcode (exakte Übereinstimmung, Groß-/Kleinschreibung beachten).
--feature <name>	string	Nach einer Vorgangsgruppe innerhalb von --product filtern (genaue Übereinstimmung). Erfordert --product – das Übergeben von --feature schlägt vor einer Anforderung fehl.
--models-only	Markieren	Stripeset pro Modell allowedApiFlavors/allowedConnectors (und die gleichen Felder für alternativesWithProbes -Einträge) – nützlich, wenn Sie nur die Modellliste sehen möchten. addYourOwn und der synthetische generisch-alternative Eintrag behalten ihre Felder unabhängig davon bei.

Beispiele

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

Datenform (--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 ist eine von AnyModel, AnyModelWithOwnAdditions oder AllModels – es wird bestimmt, ob create/update die Kurzform für eine einzelne Zuordnung oder die Form --mapping für mehrere Zuordnungen benötigt (siehe Konzepte). addYourOwn wird nur bei AnyModelWithOwnAdditions -Funktionen angezeigt und ordnet jeden verwendbaren Connector den API-Varianten zu, die für ein vom Kunden hinzugefügtes Modell gültig sind, das noch nicht in models[] ist. customConnectorOnlyApiFlavors für ein Modell oder eine Alternative bedeutet, dass api-flavor nur über einen Custom -Connector für dieses bestimmte Modell erreichbar ist – der native Anbieterkatalog unterstützt dies nicht direkt. AllModels verfügt über eine Verschachtelung pro primärer Alternativen unter alternatives, die jeweils den gleichen primären Prüfsatz haben.

Zugehörig

• uip is connections – Der Integration Service verbindet die --connection-id -Punkte einer BYO-Konfiguration.
• uip or folders – --folder-key Werte finden.

Siehe auch

• Globale Optionen
• Exitcodes