Amazon Comprehend · Schema

DetectPiiEntitiesResponse

DetectPiiEntitiesResponse schema

Machine LearningNatural Language ProcessingNLPText Analysis

Properties

Name Type Description
Entities object
View JSON Schema on GitHub

JSON Schema

openapi.yml-detect-pii-entities-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-schema/openapi.yml-detect-pii-entities-response-schema.json",
  "title": "DetectPiiEntitiesResponse",
  "description": "DetectPiiEntitiesResponse schema",
  "type": "object",
  "properties": {
    "Entities": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfPiiEntities"
        },
        {
          "description": "A collection of PII entities identified in the input text. For each entity, the response provides the entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection."
        }
      ]
    }
  }
}