garde-fous UiP

Syntaxe et options pour `uip guardrails byo-configurations`, qui gère les configurations de garde-fous Bring Your Own pour UiPath AI Trust Layer.

uip guardrails gère les configurations Bring-Your-Own-Force pour UiPath AI Trust Layer — connectant le propre connecteur de sécurité/validation du contenu d'un locataire (par exemple, Azure AI Content Security) dans un garde-fou nommé auquel un agent codé peut référencer par alias . Il y a un groupe de commandes, byo-configurations. Cela correspond à Admin → AI Trust Layer → Configurations des garde-fous dans l'interface utilisateur.

Voir uip llm-gateway pour l'API de découverte de modèles LLM pour certains validateurs de garde-fous (par ex. LLM-as-judge).

Concepts

• Configuration vs. validateur. Un validateur (--validator-type, par exemple pii_detection) est une fonctionnalité qu'un connecteur expose - découvrez-la avec list-validators. Une configuration encapsule un validateur avec une connexion et un alias unique au locataire (--validator-name) qui font référence à l'appel ByoValidator(...) d'un agent codé; ValidatorName/ValidatorType sont verrouillés lors de la création, donc modification en supprimant et en recréant.
• Procéder à une vérification avant d’enregistrer. create explore toujours la paire de connexion/validateur en premier et abandonne si la sonde échoue - il n’y a pas d’indicateur d’ignorer, car le backend conserve l’ID de connexion qui lui est donné sans le valider lui-même. update ne se teste que lorsque --connection-id change; la modification de l'état --fallback-on-ui-path ou activé/désactivé ne se réessaie pas, de sorte qu'une configuration dont le fournisseur est actuellement en panne peut toujours être désactivée.
• --fallback-on-ui-path (par défaut false) — si défini, un appel BYO ayant échoué bascule vers le garde-fou intégré d'UiPath au lieu d'échec de la demande.
• Limitation des fonctionnalités. Si l'option BYOM n'est pas activée pour le locataire, chaque verbe échoue avec Code: "ByoGuardrailsUnavailable" et vous indique l'assistance UiPath.

Synthèse

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>

Tous les verbes acceptent également --login-validity <minutes> (remplacer la durée de vie du jeton de connexion interactive).

liste paro-configurations des garde-fous uip

Répertoriez les configurations BYOM pour le locataire authentifié, y compris les détails de la connexion/du connecteur.

Exemple

uip guardrails byo-configurations list

Format des données (--sortie 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 est l'alias choisi par le locataire; ValidatorType est l'ID de validateur brut. ValidConnection indique si la connexion Integration Service sous-jacente se résout actuellement.

uip garde-fous paro-configurations créer

Créez une configuration BYOM. Sonde toujours d'abord la paire de connexion/validateur (voir Concepts) — la création est abandonnée avec l'échec de la sonde si elle ne réussit pas.

Arguments

Aucun — tout est transmis via des options.

Options

Long	Valeur (Value)	Requis	Description
--connection-id <guid>	GUID	oui	Connexion Integration Service par laquelle le garde-fou appelle.
--validator-name <name>	string	oui	Alias unique au locataire — ce qu'un agent codé transmet à ByoValidator(...).
--validator-type <type>	string	oui	ID de validateur brut, par ex. pii_detection. Découvrez des valeurs valides avec list-validators.
--fallback-on-ui-path	Drapeau	non	Revenez au garde-fou intégré d'UiPath si l'appel BYO échoue. Par défaut false.
--disabled	Drapeau	non	Enregistrer la configuration désactivée. La valeur par défaut est activée.
--login-validity <minutes>	Integer	non	Remplacer la durée de vie du jeton de connexion interactive.

Exemple

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

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

Les champs de détails du connecteur/connexion (ConnectorKey, ConnectorName, ConnectionName, ValidConnection) sont null lors de la création - ils sont renseignés lors de list, qui se joint à la connexion au moment de la lecture.

mise à jour des configurations uip guardrails

Mettez à jour la connexion, le comportement de secours ou l'état activé d'une configuration existante. ValidatorName/ValidatorType ne peut pas être modifié — supprimer et recréer à la place.

Arguments

Nom	Requis	Objectif
<configuration-id>	oui	GUID de configuration BYOM, à partir de list.

Options

Long	Valeur (Value)	Description
--connection-id <guid>	GUID	Nouvelle connexion. Teste à nouveau la paire avant d'enregistrer — abandonne en cas d'échec de la sonde.
--fallback-on-ui-path / --no-fallback-on-ui-path	Drapeau	Définir ou supprimer l'indicateur de secours.
--enabled / --disabled	Drapeau	mutuellement exclusif — activez ou désactivez la configuration.
--login-validity <minutes>	Integer	Remplacer la durée de vie du jeton de connexion interactive.

Au moins un de --connection-id, --fallback-on-ui-path/--no-fallback-on-ui-path, ou --enabled/--disabled est requis — l'absence de tous échoue côté client avant toute recherche.

Exemple

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

Format des données (--sortie json)

Même forme que la réponse de create, avec UpdatedAt maintenant défini.

uip guardrails - suppression des configurations

Supprimez définitivement une configuration BYOM.

Arguments

Nom	Requis	Objectif
<configuration-id>	oui	GUID de configuration BYOM, à partir de list.

Options

Long	Valeur (Value)	Requis	Description
--force	Drapeau	oui	Ignorez la garde de confirmation. L'absence de ce message échoue avec le message explicite « Refuser de supprimer sans --force» erreur — la suppression est sinon permanente.
--login-validity <minutes>	Integer	non	Remplacer la durée de vie du jeton de connexion interactive.

Exemple

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

Format des données (--sortie json)

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

uip guardrails - sonde de configurations

Testez si une connexion peut servir de validateur sans créer ni enregistrer quoi que ce soit. Le backend demande au connecteur ses validateurs, puis évalue une entrée de test facultative à l'aide des paramètres par défaut du validateur.

Options

Long	Valeur (Value)	Requis	Description
--connection-id <guid>	GUID	oui	Connexion Integration Service au test.
--validator-type <type>	string	oui	ID du validateur à tester. Découvrez des valeurs avec list-validators.
--login-validity <minutes>	Integer	non	Remplacer la durée de vie du jeton de connexion interactive.

Exemple

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

Format des données (--sortie 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 (pas Verdict) est ce qui guide le succès/l'échec - Verdict est l'évaluation par le fournisseur de l'entrée de test facultative, de sorte que "PASSED" et "FAILED" signifient que le connecteur a répondu. La commande quitte 1 lorsque IsAvailable est false, avec Code: "ByoGuardrailProbeFailed" et la même forme Data attachée à l'enveloppe de l'échec.

uip garde-fous paro-configurations liste-validateurs

Répertorie les validateurs auxquels une connexion Integration Service est associée. Chaque valeur Validator renvoyée est un --validator-type valide pour probe et create.

Options

Long	Valeur (Value)	Requis	Description
--connection-id <guid>	GUID	oui	Connexion à inspecter.
--login-validity <minutes>	Integer	non	Remplacer la durée de vie du jeton de connexion interactive.

Exemple

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

Format des données (--sortie json)

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

Comportement des erreurs

• BYOM non activé pour le locataire: Code: "ByoGuardrailsUnavailable", vous dirige vers l'assistance UiPath.
• ID de configuration inconnu: Code: "ByoGuardrailConfigurationNotFound", vous pointant vers list.
• Une analyse qui s’exécute avec succès mais trouve la paire inutilisable: Code: "ByoGuardrailProbeFailed", sortie 1, avec le résultat de la sonde toujours joint sous Data pour les scripts à inspecter.
• delete sans --force: échoue avant tout appel réseau.

Voir également

• uip llm-gateway — Découverte du modèle LLM, utilisée par les validateurs de style LLM en tant que juge.
• uip is connections — Connexions Integration Service référencées par --connection-id.
• Outils (extensions)
• Options globales
• Codes de sortie