View a markdown version of this page

Uso da API - Amazon Bedrock

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Uso da API

Para executar verificações de proteção, envie uma InvokeGuardrailChecks solicitação para o endpoint de tempo de execução do Amazon Bedrock.

Formato de solicitação

{ "messages": [ { "role": "user", "content": [{ "text": "string" }] } ], "checks": { "contentFilter": { "categories": [ { "category": "VIOLENCE | HATE | SEXUAL | INSULTS | MISCONDUCT" } ] }, "promptAttack": { "categories": [ { "category": "JAILBREAK | PROMPT_INJECTION | PROMPT_LEAKAGE" } ] }, "sensitiveInformation": { "entities": [ { "type": "EMAIL | PHONE | US_SOCIAL_SECURITY_NUMBER | ..." } ] } } }
  • messages – obrigatório. Pelo menos uma mensagem com um bloco de conteúdo de texto.

  • checks – obrigatório. Pelo menos um campo de verificação deve ser definido.

Formato de resposta

{ "results": { "contentFilter": { "results": [ ... ] }, "promptAttack": { "results": [ ... ] }, "sensitiveInformation": { "results": [ ... ], "truncated": false } }, "usage": { "contentFilter": { "textUnits": 0 }, "promptAttack": { "textUnits": 0 }, "sensitiveInformation": { "textUnits": 0 } } }

Somente os cheques que você solicitou aparecem em results usage e. Cada textUnits valor é o número de unidades de texto que a verificação avaliou. Para a definição de uma unidade de texto, consulte os preços do Amazon Bedrock.

Erros

A tabela a seguir lista os erros que a InvokeGuardrailChecks API pode retornar.

InvokeGuardrailChecks Erros de API
Código HTTP Erro Causa
400 ValidationException A solicitação está malformada, não tem campos obrigatórios ou viola uma restrição.
403 AccessDeniedException O chamador não está autorizado a invocar a API.
429 ThrottlingException A taxa de solicitação excedeu a cota da conta. Tente novamente com um recuo exponencial.
500 InternalServerException O serviço encontrou um erro inesperado. Repetir a solicitação .
503 ServiceUnavailableException O serviço está temporariamente indisponível. Tente novamente com um recuo exponencial.