管理护栏 - Amazon Bedrock
查看有关您的护栏的信息编辑护栏删除护栏

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

管理护栏

您可以修改现有护栏以添加新的配置策略或编辑现有策略。当你达到你满意的护栏配置后，你可以创建一个静态版本的护栏，用于你的模型或代理。有关更多信息，请参阅 部署护栏。

查看有关您的护栏的信息

Console
查看有关您的护栏的信息

  1. AWS Management Console 使用具有 Amazon Bedrock 权限的 IAM 角色登录，然后通过 https://console.aws.amazon.com/bedrock/ 打开亚马逊 Bedrock 控制台。

  2. 从左侧导航窗格中选择 Guardrails。然后，在护栏部分选择护栏。

  3. 护栏概述部分显示了适用于所有版本的护栏配置。

  4. 要查看有关工作草案的更多信息，请在 “工作草稿” 部分中选择工作草案。

  5. 要查看有关护栏特定版本的更多信息，请从 “版本” 部分中选择该版本。

要了解有关工作草案和护栏版本的更多信息，请参阅。部署护栏

API

要获取有关护栏的信息，请发送GetGuardrail请求并附上护栏的 ID 和版本。如果您未指定版本，则响应会返回该DRAFT版本的详细信息。

以下是请求格式：

GET /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1

以下是响应格式：

HTTP/1.1 200
Content-type: application/json

{
  "topicPolicy": {
    "topics": [
      {
        "definition": "string",
        "examples": [
          "string"
        ],
        "name": "string",
        "type": "DENY"
      }
    ]
  },
  "contentPolicy": {
    "filters": [
      {
        "type": "string",
        "inputStrength": "string",
        "outputStrength": "string"
      }
    ]
  },
  "wordPolicy": {
    "words": [
      {
        "text": "string"
      }
    ],
    "managedWordLists": [
      {
        "type": "string"
      }
    ]
  },
  "sensitiveInformationPolicy": {
    "piiEntities": [
      {
        "type": "string",
        "action": "string"
      }
    ],
    "regexes": [
      {
        "name": "string",
        "description": "string",
        "regex": "string",
        "action": "string"
      }
    ]
  },
  "contextualGroundingPolicy": {
    "groundingFilter": {
      "threshold": float
    },
    "relevanceFilter": {
      "threshold": float
    }
  },
  "createdAt": "string",
  "blockedInputMessaging": "string",
  "blockedOutputsMessaging": "string",
  "description": "string",
  "failureRecommendations": [
    "string"
  ],
  "guardrailArn": "string",
  "guardrailId": "string",
  "kmsKeyArn": "string",
  "name": "string",
  "status": "string",
  "statusReasons": [
    "string"
  ],
  "updatedAt": "string",
  "version": "string"
}

要列出有关您所有护栏的信息，请发送请求。ListGuardrails

以下是请求格式：

GET /guardrails?guardrailIdentifier=guardrailIdentifier&maxResults=maxResults&nextToken=nextToken HTTP/1.1

  • 要列出所有护栏的DRAFT版本，请不要指定该guardrailIdentifier字段。

  • 要列出护栏的所有版本，请在字段中指定护栏的 ARN。guardrailIdentifier

您可以在maxResults字段中设置响应中返回的最大结果数。如果结果数超过您设置的值，响应会返回 nextToken，您可以再发送一个 ListGuardrails 请求并在其中包含它，以查看下一批结果。

以下是响应格式：

HTTP/1.1 200
Content-type: application/json

{
   "guardrails": [ 
      { 
         "arn": "string",
         "createdAt": "string",
         "description": "string",
         "id": "string",
         "name": "string",
         "status": "string",
         "updatedAt": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}

编辑护栏

Console
编辑护栏

  1. AWS Management Console 使用具有 Amazon Bedrock 权限的 IAM 角色登录，然后通过 https://console.aws.amazon.com/bedrock/ 打开亚马逊 Bedrock 控制台。

  2. 从左侧导航窗格中选择 Guardrails。然后，在护栏部分选择护栏。

  3. 要编辑护栏的名称、描述、标签或型号加密设置，请在 “护栏概述” 部分中选择 “编辑”。

  4. 要编辑护栏的特定配置，请在 “工作草稿” 部分中选择 “工作草稿”。

  5. 对于包含要更改的设置的部分，选择 “编辑”。

  6. 进行所需的编辑，然后选择 “保存并退出” 以实现编辑。

API

要编辑护栏，请发送请求。UpdateGuardrail包括要更新的字段以及要保持不变的字段。

以下是请求格式：

PUT /guardrails/guardrailIdentifier HTTP/1.1
Content-type: application/json

{
   "blockedInputMessaging": "string",
   "blockedOutputsMessaging": "string",
   "contentPolicyConfig": { 
      "filtersConfig": [ 
         { 
            "inputStrength": "NONE | LOW | MEDIUM | HIGH",
            "outputStrength": "NONE | LOW | MEDIUM | HIGH",
            "type": "SEXUAL | VIOLENCE | HATE | INSULTS"
         }
      ]
   },
   "description": "string",
   "kmsKeyId": "string",
   "name": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "topicPolicyConfig": { 
      "topicsConfig": [ 
         { 
            "definition": "string",
            "examples": [ "string" ],
            "name": "string",
            "type": "DENY"
         }
      ]
   }
}

以下是响应格式：

HTTP/1.1 202
Content-type: application/json

{
   "guardrailArn": "string",
   "guardrailId": "string",
   "updatedAt": "string",
   "version": "string"
}

删除护栏

当您不再需要使用护栏时，可以将其删除。在删除护栏之前，请务必断开护栏与所有使用该护栏的资源或应用程序的关联，以免出现潜在的错误。

Console
要删除护栏

  1. AWS Management Console 使用具有 Amazon Bedrock 权限的 IAM 角色登录，然后通过 https://console.aws.amazon.com/bedrock/ 打开亚马逊 Bedrock 控制台。

  2. 从左侧导航窗格中选择 Guardrails。然后，在护栏部分选择护栏。

  3. 在护栏部分，选择要删除的护栏，然后选择删除。

  4. delete在用户输入字段中输入并选择删除以删除护栏。

API

要删除护栏，请发送DeleteGuardrail请求并仅在字段中指定护栏的 ARN。guardrailIdentifier不要指定 guardrailVersion

以下是请求格式：

DELETE /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1
警告

如果删除护栏，则其所有版本都将被删除。

如果删除成功，则响应将返回 HTTP 200 状态码。