查看关于护栏的信息 - Amazon Bedrock

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

查看关于护栏的信息

您可以按照以下适用于 AWS 管理控制台或 API 操作的步骤查看关于护栏的信息：

Console
查看关于护栏版本和设置的信息

  1. 采用有权使用 Amazon Bedrock 控制台的 IAM 身份登录 AWS 管理控制台。然后，通过以下网址打开 Amazon Bedrock 控制台：https://console.aws.amazon.com/bedrock。

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

  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 字段。

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

您可以在 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"
}