Visualización de información sobre las barreras de protección

Para obtener más información sobre el borrador de trabajo y las versiones de las barreras de protección, consulte Implementación de la barrera de protección.

Para obtener información sobre una barandilla, envíe una GetGuardrailsolicitud e incluya el ID y la versión de la barandilla. Si no especifica una versión, la respuesta devuelve los detalles de la versión DRAFT.

Este es el formato de la solicitud:

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

Este es el formato de la respuesta:

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"
}

Para obtener información sobre todas sus barandillas, envíe una solicitud. ListGuardrails

Este es el formato de la solicitud:

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

Puede especificar el número máximo de resultados que se devuelven en una respuesta en el campo maxResults. Si hay más resultados que la cantidad que ha establecido, la respuesta devuelve un nextToken que puede enviar en otra solicitud ListGuardrails para ver el siguiente lote de resultados.

Este es el formato de la respuesta:

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"
}