Proteções da UIP

Sintaxe e opções para "uip guardrails byo-configurations", que gerencia configurações de proteção (BYOG) para a AI Trust Layer da UiPath.

uip guardrails gerencia configurações de bring-your-own guardrail (BYOG) para a UiPath AI Trust Layer — conectando um conector de segurança de conteúdo/validação do próprio tenant (por exemplo, Azure AI Content Security) em uma proteção nomeada que um agente codificado pode referenciar por alias . Há um grupo de comando, byo-configurations. Isso corresponde a Admin → AI Trust Layer → Configurações de proteções na interface gráfica.

Consulte uip llm-gateway para a API de descoberta de modelos de LLM alguns validadores de proteção (por exemplo LLM-como-Juiz).

Conceitos

• Configuração versus validador. Um validador (--validator-type, por exemplo pii_detection) é um recurso que um conector expõe — descubra-os com list-validators. Uma configuração envolve um validador com uma conexão e um alias exclusivo do tenant (--validator-name) a que a chamada ByoValidator(...) de um agente codificado faz referência; ValidatorName/ValidatorType são bloqueados na criação. Portanto, altere-o excluindo e recriando.
• Testar antes de salvar. create testa o par de conexão/validador primeiro e anula se a investigação falhar — não há um sinalizador de skip, porque o back-end persiste qualquer ID de conexão que seja fornecido sem validá-lo por conta própria. update testa apenas quando --connection-id muda; mudar apenas o estado --fallback-on-ui-path ou habilitado/desabilitado não verifica novamente, portanto, uma configuração cujo fornecedor está inativo no momento ainda pode ser desabilitada.
• --fallback-on-ui-path padrão false) — se definido, uma chamada BYO com falha recairá na própria proteção integrada da UiPath em vez de falhar na solicitação.
• Fechamento de funcionalidades. Se o BYOG não estiver habilitado para o tenant, cada verbo falhará com Code: "ByoGuardrailsUnavailable" e apontará você para o suporte da UiPath.

Resumo

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>

Todos os verbos também aceitam --login-validity <minutes> (substituir o tempo de vida do token de login interativo).

lista de byo-configurations das proteções uip

Liste as configurações de BYOG do tenant autenticado, incluindo os detalhes de conexão/conector.

Exemplo

uip guardrails byo-configurations list

Formato dos dados (--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 é o alias escolhido pelo tenant; ValidatorType é o ID do validador bruto. ValidConnection reflete se a conexão subjacente do Integration Service resolve atualmente.

proteções uip byo-configurations criar

Crie uma configuração BYOG. Sempre verifique o par de conexão/validador primeiro (consulte Conceitos) — a criação será anulada com a própria falha de investigação se ela não for aprovada.

Argumentos

None — tudo é passado por meio das opções.

Opções

Long	Valor	Required	Description
--connection-id <guid>	GUID	sim	Conexão do Integration Service por meio da qual a proteção é chamada.
--validator-name <name>	String	sim	Alias exclusivo do tenant — o que um agente codificado passa para ByoValidator(...).
--validator-type <type>	String	sim	ID do validador bruto, por exemplo pii_detection). Descubra valores válidos com list-validators.
--fallback-on-ui-path	Bandeira	não	Volte para a proteção integrada da UiPath se a chamada BYO falhar. falsePadrão.
--disabled	Bandeira	não	Salvar a configuração desabilitada. O padrão é habilitado.
--login-validity <minutes>	Número inteiro	não	Substitua a vida útil do token de login interativo.

Exemplo

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

Formato dos dados (--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
  }
}

Os campos de detalhes do conector/conexão (ConnectorKey, ConnectorName, ConnectionName, ValidConnection) são null na criação — eles são preenchidos em list, que se une à conexão no tempo de leitura.

atualização de byo-configurations das proteções uip

Atualize a conexão, o comportamento de fallback ou o estado habilitado de uma configuração existente. ValidatorName/ValidatorType não pode ser alterado — exclua e recrie.

Argumentos

Name	Required	Finalidade
<configuration-id>	sim	GUID de configuração BYOG, de list.

Opções

Long	Valor	Description
--connection-id <guid>	GUID	Nova conexão. Investiga novamente o par antes de salvar — anula em caso de falha de investigação.
--fallback-on-ui-path / --no-fallback-on-ui-path	Bandeira	Defina ou limpe o sinalizador de fallback.
--enabled / --disabled	Bandeira	mutuamente exclusivo — habilite ou desabilite a configuração.
--login-validity <minutes>	Número inteiro	Substitua a vida útil do token de login interativo.

Pelo menos um dos --connection-id, --fallback-on-ui-path/--no-fallback-on-ui-path, ou --enabled/--disabled é necessário — omitir todos eles falha no lado do cliente antes de qualquer pesquisa.

Exemplo

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

Formato dos dados (--output json)

Mesmo formato da resposta de create, com UpdatedAt agora definido.

proteções uip byo-configurations excluir

Excluir permanentemente uma configuração BYOG.

Argumentos

Name	Required	Finalidade
<configuration-id>	sim	GUID de configuração BYOG, de list.

Opções

Long	Valor	Required	Description
--force	Bandeira	sim	Ignore a proteção de confirmação. A sua omissão falha com um aviso explícito "Recusa de exclusão sem --force" erro — caso contrário, a exclusão é permanente.
--login-validity <minutes>	Número inteiro	não	Substitua a vida útil do token de login interativo.

Exemplo

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

Formato dos dados (--output json)

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

Investigação byo-configurations das proteções uip

Teste se uma conexão pode atender a um validador, sem criar ou salvar nada. O back-end solicita ao conector seus validadores e, em seguida, avalia uma entrada de teste estável usando os parâmetros padrão do validador.

Opções

Long	Valor	Required	Description
--connection-id <guid>	GUID	sim	Conexão do Integration Service a ser testada.
--validator-type <type>	String	sim	ID do validador a ser testado. Descubra valores com list-validators.
--login-validity <minutes>	Número inteiro	não	Substitua a vida útil do token de login interativo.

Exemplo

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

Formato dos dados (--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 (não Verdict) é o que abre para o sucesso/falha — Verdict é a avaliação do fornecedor da entrada de teste compatibilidade, então, "PASSED" e "FAILED" significam que o conector respondeu. O comando sai 1 quando IsAvailable é false, com Code: "ByoGuardrailProbeFailed" e o mesmo formato Data anexado ao envelope de falha.

proteções uip byo-configurations list-validators

Listar os validadores que uma conexão do Integration Service expõe. Cada valor Validator retornado é um --validator-type válido para probe e create.

Opções

Long	Valor	Required	Description
--connection-id <guid>	GUID	sim	Conexão para inspecionar.
--login-validity <minutes>	Número inteiro	não	Substitua a vida útil do token de login interativo.

Exemplo

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

Formato dos dados (--output json)

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

Comportamento de erro

• BYOG não habilitado para o tenant: Code: "ByoGuardrailsUnavailable", apontando você para o suporte da UiPath.
• ID de configuração desconhecido:, Code: "ByoGuardrailConfigurationNotFound" apontando para list você.
• Uma investigação que é executada com sucesso, mas encontra o par inutilizável: Code: "ByoGuardrailProbeFailed", saída 1, com o resultado da investigação ainda anexado em Data para os scripts inspecionarem.
• delete sem --force: falha antes de qualquer chamada de rede.

Veja também

• uip llm-gateway — Descoberta de modelos de LLM, usada por validadores no estilo de LLM como juiz.
• uip is connections — Conexões do Integration Service referenciadas por --connection-id.
• Ferramentas ( plugins )
• Opções globais
• Códigos de saída