UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

proteções do agente da uip

Liste definições de proteções, proteções BYOG, modelos de LLM como juiz e o catálogo de proteções com "proteções de agentes uip".

uip agent guardrails é um grupo de descoberta somente leitura para as proteções que um projeto de agente pode referenciar — validadores integrados e conexões traga sua própria proteção (BYOG) — além dos modelos disponíveis para a proteção LLM como juiz e o metadados do catálogo criados (descrições, casos de uso, exemplos) para cada validador. Não anexa uma proteção a um projeto; isso é feito editando manualmente agent.json.

Resumo​

uip agent guardrails list [--byo]
uip agent guardrails llm-as-judge-models
uip agent guardrails catalog [--validator <id>]
uip agent guardrails list [--byo]
uip agent guardrails llm-as-judge-models
uip agent guardrails catalog [--validator <id>]

Todas as invocações honram as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

lista de proteções do agente uip​

Liste as definições de proteção disponíveis, incluindo as desabilitadas (Vale a pena exibir uma configuração BYOG desabilitada — caso contrário, ela será indistinguível de uma que nunca foi configurada).

Opções​

BandeiraFinalidade
--byoFiltre apenas para proteções traga seu próprio (BYOG).

Exemplos​

uip agent guardrails list

uip agent guardrails list --byo
uip agent guardrails list

uip agent guardrails list --byo

Formato dos dados (--output json)​

{
  "Code": "GuardrailDefinitionsList",
  "Data": [
    {
      "Validator": "pii_detection",
      "IsByo": false,
      "Status": "Available",
      "AllowedScopes": ["Agent", "Llm", "Tool"],
      "GuardrailStages": { "Agent": ["PreExecution", "PostExecution"], "Llm": ["PreExecution", "PostExecution"], "Tool": ["PreExecution", "PostExecution"] },
      "Parameters": [
        { "Type": "enum-list", "Id": "entities", "Required": true, "DefaultValue": ["Email", "Address"], "Options": ["Person", "Address", "Email", "..."] }
      ]
    }
  ]
}
{
  "Code": "GuardrailDefinitionsList",
  "Data": [
    {
      "Validator": "pii_detection",
      "IsByo": false,
      "Status": "Available",
      "AllowedScopes": ["Agent", "Llm", "Tool"],
      "GuardrailStages": { "Agent": ["PreExecution", "PostExecution"], "Llm": ["PreExecution", "PostExecution"], "Tool": ["PreExecution", "PostExecution"] },
      "Parameters": [
        { "Type": "enum-list", "Id": "entities", "Required": true, "DefaultValue": ["Email", "Address"], "Options": ["Person", "Address", "Email", "..."] }
      ]
    }
  ]
}

Validator não é exclusiva — uma definição BYOG pode compartilhar o nome de um harmful_content integrado (um tenant pode ter duas entradas). Use IsByo mais os campos Byo* (ByoValidatorName, ByoConnectionId, ByoConfigurationId, ByoConnectorName, ByoConnectorKey, FolderKey) para diferenciá-los — ByoValidatorName e ByoConnectionId são os dois valores que um agente codificado passa para ByoValidator(...).

proteções de agentes da UIP llm-as-judge-models​

Listar modelos de LLM disponíveis para a proteção LLM como juiz. Exige login.

Exemplo​

uip agent guardrails llm-as-judge-models
uip agent guardrails llm-as-judge-models

Formato dos dados (--output json)​

{
  "Code": "LlmGatewayModelsList",
  "Data": [
    { "ModelId": "anthropic.claude-haiku-4-5-20251001-v1:0", "DisplayName": "Claude Haiku 4.5", "Vendor": "AwsBedrock", "ModelFamily": "AnthropicClaude", "SubscriptionType": "UiPathOwned", "IsByo": false, "IsPreview": false, "IsBlockedByPolicy": false }
  ]
}
{
  "Code": "LlmGatewayModelsList",
  "Data": [
    { "ModelId": "anthropic.claude-haiku-4-5-20251001-v1:0", "DisplayName": "Claude Haiku 4.5", "Vendor": "AwsBedrock", "ModelFamily": "AnthropicClaude", "SubscriptionType": "UiPathOwned", "IsByo": false, "IsPreview": false, "IsBlockedByPolicy": false }
  ]
}

Os modelos bloqueados pela política do tenant são filtrados antes que a lista seja retornada.

catálogo de proteções para agentes da uip​

Buscar metadados de catálogo criados (descrições, casos de uso, exemplos) para validadores de proteção.

Opções​

BandeiraFinalidade
--validator <id>Filtrar para um único validador pelo seu ID Campaign_case (por exemplo pii_detection).

Exemplos​

uip agent guardrails catalog

uip agent guardrails catalog --validator pii_detection
uip agent guardrails catalog

uip agent guardrails catalog --validator pii_detection

Formato dos dados (--output json)​

{
  "Code": "GuardrailCatalog",
  "Data": {
    "schema_version": "1.0.0",
    "guardrails": [
      { "validator_id": "pii_detection", "display_name": "PII Detection", "type": "BuiltIn", "status": "Available", "description": "...", "use_cases": ["..."], "examples": [] }
    ]
  }
}
{
  "Code": "GuardrailCatalog",
  "Data": {
    "schema_version": "1.0.0",
    "guardrails": [
      { "validator_id": "pii_detection", "display_name": "PII Detection", "type": "BuiltIn", "status": "Available", "description": "...", "use_cases": ["..."], "examples": [] }
    ]
  }
}

Se a funcionalidade de catálogo ainda não estiver habilitada para o tenant, isso falhará com Code: "GuardrailCatalogUnavailable".

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades