查看有关您的护栏的信息 - Amazon Bedrock

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

查看有关您的护栏的信息

您可以按照以下步骤查看有关护栏的信息 AWS 主机或API:

Console
查看有关您的护栏版本和设置的信息
  1. 登录 AWS Management Console 使用具有 Amazon Bedrock 权限的IAM角色,然后打开 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字段。

  • 要列出护栏的所有版本,请在字段中指定护栏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" }