가드레일 정보 확인

규격 초안 및 가드레일 버전에 대한 자세한 내용은 가드레일 배포 섹션을 참조하세요.

가드레일에 대한 정보를 얻으려면 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

응답으로 반환할 최대 결과 수를 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"
}