

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 使用 API
<a name="guardrails-use-invoke-guardrail-checks-using"></a>

要运行护栏检查，请向 Amazon Bedrock 运行时终端节点发送`InvokeGuardrailChecks`请求。

## 请求格式
<a name="guardrails-use-invoke-guardrail-checks-request"></a>

```
{
  "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` – 必需。必须至少设置一个复选字段。

## 响应格式
<a name="guardrails-use-invoke-guardrail-checks-response"></a>

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

只有您请求的支票才会显示在`results`和下`usage`。每个`textUnits`值都是校验评估的文本单位数。有关文本单位的定义，请参阅 [Amazon Bedrock 定价](https://aws.amazon.com/bedrock/pricing/)。

## 错误
<a name="guardrails-use-invoke-guardrail-checks-errors"></a>

下表列出了 `InvokeGuardrailChecks` API 可能返回的错误。


**InvokeGuardrailChecks API 错误**  

| HTTP 代码 | 错误 | 原因 | 
| --- | --- | --- | 
| 400 | ValidationException | 请求格式错误、缺少必填字段或违反约束。 | 
| 403 | AccessDeniedException | 调用者无权调用 API。 | 
| 429 | ThrottlingException | 请求速率超过了账户的配额。使用指数退避重试。 | 
| 500 | InternalServerException | 服务遇到意外错误。重试请求。 | 
| 503 | ServiceUnavailableException | 服务暂时不可用。使用指数退避重试。 | 