Amazon Comprehend · JSON Structure

Openapi.Yml Detect Pii Entities Response Structure

DetectPiiEntitiesResponse schema

Type: object Properties: 1
Machine LearningNatural Language ProcessingNLPText Analysis

DetectPiiEntitiesResponse is a JSON Structure definition published by Amazon Comprehend, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Entities

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-detect-pii-entities-response-structure.json",
  "name": "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."
        }
      ]
    }
  }
}