UIP-Leitplanken

Syntax und Optionen für „uip guardrails byo-configurations“, die Bring-Your-Own- (BYOM)-Konfigurationen für UiPath AI Trust Layer verwalten.

uip guardrails verwaltet Bring-Your-Own Guardrail (BYOM) -Konfigurationen für UiPath AI Trust Layer – verknüpfen den eigenen Connector für Inhaltssicherheit/Validierung eines Mandanten (z. B. Azure AI Content Security) mit einer benannten Leitplanke, auf die ein codierter Agent anhand eines Alias verweisen kann . Es gibt eine Befehlsgruppe, byo-configurations. Dies entspricht Admin → AI Trust Layer → Guardrails-Konfigurationen auf der Benutzeroberfläche.

Weitere Informationen zur LLM-Modellerkennungs-API finden Sie unter uip llm-gateway Einige Leitplankenvalidierer (z. B LLM-as-Judge).

Konzepte

• Konfiguration vs. Validierer. Ein Validierer (--validator-type, z. B pii_detection) ist eine Funktion, die ein Connector bereitstellt – entdecken Sie sie mit list-validators. Eine Konfiguration umschließt einen Validierer mit einer Verbindung und einem mandanten-eindeutigen Alias (--validator-name), auf das der ByoValidator(...) -Aufruf eines codierten Agents verweist; ValidatorName/ValidatorType sind bei der Erstellung gesperrt, also ändern Sie sie entweder durch Löschen oder Neuerstellen.
• Vor dem Speichern testen. create prüft immer zuerst das Verbindungs-/Validierungspaar und bricht ab, wenn der Test fehlschlägt – es gibt kein Überspringungs-Flag, da das Back-End die ihm gegebene Verbindungs-ID beibehält, ohne sie selbst zu validieren. update führt nur einen erneuten Test durch, wenn sich --connection-id ändert; Das Ändern von --fallback-on-ui-path oder des aktivierten/deaktivierten Status führt nicht zu einem erneuten Test, sodass eine Konfiguration, deren Anbieter derzeit ausgefallen ist, weiterhin deaktiviert werden kann.
• --fallback-on-ui-path (Standard false) – Wenn diese Option festgelegt ist, greift ein fehlgeschlagener BYO-Aufruf auf die eigene integrierte Leitplanke von UiPath zurück, anstatt die Anforderung fehlzuschlagen.
• Funktions-Governance. Wenn BYOM für den Mandanten nicht aktiviert ist, schlägt jedes Verb mit Code: "ByoGuardrailsUnavailable" fehl und Sie verweisen auf den UiPath-Support.

Zusammenfassung

uip guardrails byo-configurations list
uip guardrails byo-configurations create --connection-id <guid> --validator-name <name> --validator-type <type> [--fallback-on-ui-path] [--disabled]
uip guardrails byo-configurations update <configuration-id> [--connection-id <guid>] [--fallback-on-ui-path | --no-fallback-on-ui-path] [--enabled | --disabled]
uip guardrails byo-configurations delete <configuration-id> --force
uip guardrails byo-configurations probe --connection-id <guid> --validator-type <type>
uip guardrails byo-configurations list-validators --connection-id <guid>

Alle Verben akzeptieren auch --login-validity <minutes> (überschreiben die Lebensdauer des interaktiven Anmeldetokens).

Liste der UIP-Leitplanken nach Konfigurationen

Listen Sie BYOM-Konfigurationen für den authentifizierten Mandanten auf, einschließlich Verbindungs-/Connector-Details.

Beispiel

uip guardrails byo-configurations list

Datenform (--output json)

{
  "Code": "ByoGuardrailConfigurationsList",
  "Data": [
    {
      "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
      "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
      "ValidatorName": "my-pii-guardrail",
      "ValidatorType": "pii_detection",
      "FallbackOnUiPath": true,
      "Enabled": true,
      "CreatedAt": "2026-07-01T10:00:00Z",
      "UpdatedAt": null,
      "ConnectorKey": "uipath-azure-contentsafety",
      "ConnectorName": "Azure AI Content Safety",
      "ConnectionName": "My Content Safety Connection",
      "ValidConnection": true
    }
  ]
}

ValidatorName ist der vom Mandanten ausgewählte Alias; ValidatorType ist die unformatierte Validierer-ID. ValidConnection spiegelt wider, ob die zugrunde liegende Integration Service-Verbindung derzeit aufgelöst wird.

UIP-Leitplanken nach Konfigurationen erstellen

Erstellen Sie eine BYOM-Konfiguration. Testet immer zuerst das Verbindungs-/Validierungspaar (siehe Konzepte) – die Erstellung wird mit dem eigenen Fehler des Test abgebrochen, wenn er nicht besteht.

Argumente

Keine – alles wird über Optionen übergeben.

Optionen

Long	Wert	Erforderlich	Beschreibung
--connection-id <guid>	GUID	ja	Integration Service-Verbindung der Leitplankenaufrufe.
--validator-name <name>	string	ja	Mandanteneindeutiger Alias – was ein codierter Agent an ByoValidator(...) übergibt.
--validator-type <type>	string	ja	Unformatierte Validierer-ID, z. B. pii_detection). Erkennen Sie gültige Werte mit list-validators.
--fallback-on-ui-path	Markieren	nein	Greifen Sie auf die integrierte UiPath-Leitplanke zurück, wenn der BYO-Aufruf fehlschlägt. Der Standardwert ist false.
--disabled	Markieren	nein	Speichern Sie die Konfiguration deaktiviert. Standardmäßig ist diese Option aktiviert.
--login-validity <minutes>	Integer	nein	Überschreiben Sie die Lebensdauer des interaktiven Anmeldetokens.

Beispiel

uip guardrails byo-configurations create \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df \
  --validator-name my-pii-guardrail --validator-type pii_detection

Datenform (--output json)

{
  "Code": "ByoGuardrailConfigurationCreated",
  "Data": {
    "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
    "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
    "ValidatorName": "my-pii-guardrail",
    "ValidatorType": "pii_detection",
    "FallbackOnUiPath": false,
    "Enabled": true,
    "CreatedAt": "2026-07-01T10:00:00Z",
    "UpdatedAt": null,
    "ConnectorKey": null,
    "ConnectorName": null,
    "ConnectionName": null,
    "ValidConnection": null
  }
}

Die Connector-/Verbindungsdetailfelder (ConnectorKey, ConnectorName, ConnectionName, ValidConnection) sind beim Erstellen null – sie werden in list ausgefüllt, das zum Lesezeitpunkt mit der Verbindung verbunden wird.

Aktualisierung der UIP-Leitplanken nach Konfigurationen

Aktualisieren Sie die Verbindung, das Fallback-Verhalten oder den aktivierten Status einer vorhandenen Konfiguration. ValidatorName/ValidatorType kann nicht geändert werden – stattdessen löschen und neu erstellen.

Argumente

Name	Erforderlich	Zweck
<configuration-id>	ja	BYOM-Konfigurations-GUID von list.

Optionen

Long	Wert	Beschreibung
--connection-id <guid>	GUID	Neue Verbindung. Testet das Paar erneut, bevor es gespeichert wird – bricht bei Testfehler ab.
--fallback-on-ui-path / --no-fallback-on-ui-path	Markieren	Legen Sie das Fallback-Flag fest oder löschen Sie es.
--enabled / --disabled	Markieren	Sich gegenseitig ausschließen – Aktivieren oder Deaktivieren der Konfiguration.
--login-validity <minutes>	Integer	Überschreiben Sie die Lebensdauer des interaktiven Anmeldetokens.

Mindestens eines von --connection-id, --fallback-on-ui-path/--no-fallback-on-ui-path oder --enabled/--disabled ist erforderlich – das Auslassen aller von ihnen schlägt auf der Clientseite vor jeder Suche fehl.

Beispiel

uip guardrails byo-configurations update e5723bb8-fbc2-4317-c7d7-08de803bc010 \
  --connection-id 24887687-1234-4abc-9def-012345678901

Datenform (--output json)

Die gleiche Form wie die Antwort von create, wobei UpdatedAt jetzt festgelegt ist.

UIP-Leitplanken nach Konfigurationen löschen

Löschen Sie eine BYOM-Konfiguration endgültig.

Argumente

Name	Erforderlich	Zweck
<configuration-id>	ja	BYOM-Konfigurations-GUID von list.

Optionen

Long	Wert	Erforderlich	Beschreibung
--force	Markieren	ja	Überspringen Sie den Bestätigungs Guard. Das Auslassen schlägt mit einer expliziten „Verweigerung des Löschens ohne --force“ fehl. Fehler – andernfalls ist die Löschung endgültig.
--login-validity <minutes>	Integer	nein	Überschreiben Sie die Lebensdauer des interaktiven Anmeldetokens.

Beispiel

uip guardrails byo-configurations delete e5723bb8-fbc2-4317-c7d7-08de803bc010 --force

Datenform (--output json)

{ "Code": "ByoGuardrailConfigurationDeleted", "Data": { "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010" } }

UIP-Leitplanken byo-configurations-Test

Testen Sie, ob eine Verbindung einem Validierer dienen kann, ohne etwas zu erstellen oder zu speichern. Das Back-End fragt den Connector nach seinen Validierern und bewertet dann eine ungefähre Testeingabe mithilfe der Standardparameter des Validierers.

Optionen

Long	Wert	Erforderlich	Beschreibung
--connection-id <guid>	GUID	ja	Integration Service-Verbindung zu testen.
--validator-type <type>	string	ja	Zu testende Validierer-ID. Erkennen Sie Werte mit list-validators.
--login-validity <minutes>	Integer	nein	Überschreiben Sie die Lebensdauer des interaktiven Anmeldetokens.

Beispiel

uip guardrails byo-configurations probe \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df --validator-type pii_detection

Datenform (--output json)

{
  "Code": "ByoGuardrailProbeSucceeded",
  "Data": {
    "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
    "ValidatorType": "pii_detection",
    "ConnectorKey": "uipath-azure-contentsafety",
    "IsAvailable": true,
    "Verdict": "PASSED",
    "Details": null,
    "DurationMs": 842,
    "Error": null
  }
}

IsAvailable (nicht Verdict) ist der entscheidende Schritt für Erfolg/Fehlschlag – Verdict ist die Bewertung des Anbieters der guten Testeingabe, also stellen "PASSED" und "FAILED" beide dar, dass der Connector beantwortet wurde. Der Befehl wird 1 beendet, wenn IsAvailable false ist, wobei Code: "ByoGuardrailProbeFailed" und dieselbe Data -Form an den Fehlerumschlag angehängt sind.

UIP-Leitplanken nach Konfigurationen-Listenvalidatoren

Listen Sie die Validierer auf, die eine Integration Service-Verbindung verfügbar macht. Jeder zurückgegebene Validator -Wert ist ein gültiger --validator-type für probe und create.

Optionen

Long	Wert	Erforderlich	Beschreibung
--connection-id <guid>	GUID	ja	Zu überprüfende Verbindung.
--login-validity <minutes>	Integer	nein	Überschreiben Sie die Lebensdauer des interaktiven Anmeldetokens.

Beispiel

uip guardrails byo-configurations list-validators --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df

Datenform (--output json)

{
  "Code": "ByoGuardrailValidatorsList",
  "Data": [
    {
      "Validator": "pii_detection",
      "DisplayName": "PII detection",
      "Description": null,
      "Status": "Available",
      "AllowedScopes": ["Agent", "Llm", "Tool"],
      "PayloadMinSizeLimit": null,
      "PayloadMaxSizeLimit": 10000
    }
  ]
}

Fehlerverhalten

• BYOM für den Mandanten nicht aktiviert: Code: "ByoGuardrailsUnavailable", was Sie auf den UiPath-Support verweist.
• Unbekannte Konfigurations-ID: Code: "ByoGuardrailConfigurationNotFound", verweisen auf list.
• Ein Test, der erfolgreich ausgeführt wird, das Paar jedoch für unbrauchbar findet: Code: "ByoGuardrailProbeFailed", Beenden 1, wobei das Probeergebnis immer noch unter Data angehängt ist, damit die Skripte überprüft werden können.
• delete ohne --force: schlägt vor jedem Netzwerkaufruf fehl.

Siehe auch

• uip llm-gateway – LLM-Modellerkennung, die von Validierern im LLM-als-Richter-Stil verwendet wird.
• uip is connections – Integration Service-Verbindungen, auf die von --connection-id verwiesen wird.
• Tools (Plugins)
• Globale Optionen
• Exitcodes