View a markdown version of this page

使用 API - Amazon Bedrock

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

使用 API

若要執行護欄檢查,請將 InvokeGuardrailChecks請求傳送至 Amazon Bedrock 執行時間端點。

要求格式

{ "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 - 必要。至少一個訊息具有一個文字內容區塊。

  • checks - 必要。至少必須設定一個檢查欄位。

回應格式

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

只有您請求的檢查會顯示在 results和 下usage。每個textUnits值都是檢查評估的文字單位數量。如需文字單位的定義,請參閱 Amazon Bedrock 定價

錯誤

下表列出 InvokeGuardrailChecks API 可以傳回的錯誤。

InvokeGuardrailChecks API 錯誤
HTTP 代碼 錯誤 原因
400 ValidationException 請求格式錯誤、缺少必要欄位,或違反限制條件。
403 AccessDeniedException 呼叫者無權叫用 API。
429 ThrottlingException 請求率超過帳戶的配額。以指數退避重試。
500 InternalServerException 服務遇到未預期的錯誤。重試 請求。
503 ServiceUnavailableException 此服務暫時無法使用。以指數退避重試。