DetectEntitiesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-comprehend/json-schema/amazon-comprehend-detect-entities-response-schema.json",
  "title": "DetectEntitiesResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-comprehend-operations-api-openapi.yml#/components/schemas/DetectEntitiesResponse",
  "type": "object",
  "properties": {
    "Entities": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Entity"
      },
      "description": "A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide."
    },
    "DocumentMetadata": {
      "$ref": "#/$defs/DocumentMetadata"
    },
    "DocumentType": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/DocumentTypeListItem"
      },
      "description": "The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter."
    },
    "Blocks": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Block"
      },
      "description": "Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word. The Block content for a Word input document does not include a Geometry field. The Block field is not present in the response for plain-text inputs."
    },
    "Errors": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ErrorsListItem"
      },
      "description": "Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors."
    }
  },
  "$defs": {
    "Block": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "Unique identifier for the block."
        },
        "BlockType": {
          "type": "string",
          "enum": [
            "LINE",
            "WORD"
          ],
          "description": "The block represents a line of text or one word of text. WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. LINE - A string of tab-delimited, contiguous words that are detected on a document page"
        },
        "Text": {
          "type": "string",
          "description": "The word or line of text extracted from the block."
        },
        "Page": {
          "type": "integer",
          "description": "Page number where the block appears."
        },
        "Geometry": {
          "$ref": "#/$defs/Geometry"
        },
        "Relationships": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RelationshipsListItem"
          },
          "description": "A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text."
        }
      }
    },
    "BlockReference": {
      "type": "object",
      "properties": {
        "BlockId": {
          "type": "string",
          "description": "Unique identifier for the block."
        },
        "BeginOffset": {
          "type": "integer",
          "description": "Offset of the start of the block within its parent block."
        },
        "EndOffset": {
          "type": "integer",
          "description": "Offset of the end of the block within its parent block."
        },
        "ChildBlocks": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ChildBlock"
          },
          "description": "List of child blocks within this block."
        }
      }
    },
    "BoundingBox": {
      "type": "object",
      "properties": {
        "Height": {
          "type": "number",
          "description": "The height of the bounding box as a ratio of the overall document page height."
        },
        "Left": {
          "type": "number",
          "description": "The left coordinate of the bounding box as a ratio of overall document page width."
        },
        "Top": {
          "type": "number",
          "description": "The top coordinate of the bounding box as a ratio of overall document page height."
        },
        "Width": {
          "type": "number",
          "description": "The width of the bounding box as a ratio of the overall document page width."
        }
      }
    },
    "ChildBlock": {
      "type": "object",
      "properties": {
        "ChildBlockId": {
          "type": "string",
          "description": "Unique identifier for the child block."
        },
        "BeginOffset": {
          "type": "integer",
          "description": "Offset of the start of the child block within its parent block."
        },
        "EndOffset": {
          "type": "integer",
          "description": "Offset of the end of the child block within its parent block."
        }
      }
    },
    "DocumentMetadata": {
      "type": "object",
      "properties": {
        "Pages": {
          "type": "integer",
          "description": "Number of pages in the document."
        },
        "ExtractedCharacters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ExtractedCharactersListItem"
          },
          "description": "List of pages in the document, with the number of characters extracted from each page."
        }
      }
    },
    "DocumentTypeListItem": {
      "type": "object",
      "properties": {
        "Page": {
          "type": "integer",
          "description": "Page number."
        },
        "Type": {
          "type": "string",
          "enum": [
            "NATIVE_PDF",
            "SCANNED_PDF",
            "MS_WORD",
            "IMAGE",
            "PLAIN_TEXT",
            "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON",
            "TEXTRACT_ANALYZE_DOCUMENT_JSON"
          ],
          "description": "Document type."
        }
      }
    },
    "Entity": {
      "type": "object",
      "properties": {
        "Score": {
          "type": "number",
          "description": "The level of confidence that Amazon Comprehend has in the accuracy of the detection."
        },
        "Type": {
          "type": "string",
          "enum": [
            "PERSON",
            "LOCATION",
            "ORGANIZATION",
            "COMMERCIAL_ITEM",
            "EVENT",
            "DATE",
            "QUANTITY",
            "TITLE",
            "OTHER"
          ],
          "description": "The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below. For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model."
        },
        "Text": {
          "type": "string",
          "description": "The text of the entity."
        },
        "BeginOffset": {
          "type": "integer",
          "description": "The zero-based offset from the beginning of the source text to the first character in the entity. This field is empty for non-text input."
        },
        "EndOffset": {
          "type": "integer",
          "description": "The zero-based offset from the beginning of the source text to the last character in the entity. This field is empty for non-text input."
        },
        "BlockReferences": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/BlockReference"
          },
          "description": "A reference to each block for this entity. This field is empty for plain-text input."
        }
      }
    },
    "ErrorsListItem": {
      "type": "object",
      "properties": {
        "Page": {
          "type": "integer",
          "description": "Page number where the error occurred."
        },
        "ErrorCode": {
          "type": "string",
          "enum": [
            "TEXTRACT_BAD_PAGE",
            "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED",
            "PAGE_CHARACTERS_EXCEEDED",
            "PAGE_SIZE_EXCEEDED",
            "INTERNAL_SERVER_ERROR"
          ],
          "description": "Error code for the cause of the error."
        },
        "ErrorMessage": {
          "type": "string",
          "description": "Text message explaining the reason for the error."
        }
      }
    },
    "ExtractedCharactersListItem": {
      "type": "object",
      "properties": {
        "Page": {
          "type": "integer",
          "description": "Page number."
        },
        "Count": {
          "type": "integer",
          "description": "Number of characters extracted from each page."
        }
      }
    },
    "Geometry": {
      "type": "object",
      "properties": {
        "BoundingBox": {
          "$ref": "#/$defs/BoundingBox"
        },
        "Polygon": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Point"
          },
          "description": "Within the bounding box, a fine-grained polygon around the recognized item."
        }
      }
    },
    "Point": {
      "type": "object",
      "properties": {
        "X": {
          "type": "number",
          "description": "The value of the X coordinate for a point on a polygon"
        },
        "Y": {
          "type": "number",
          "description": "The value of the Y coordinate for a point on a polygon"
        }
      }
    },
    "RelationshipsListItem": {
      "type": "object",
      "properties": {
        "Ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Identifers of the child blocks."
        },
        "Type": {
          "type": "string",
          "enum": [
            "CHILD"
          ],
          "description": "Only supported relationship is a child relationship."
        }
      }
    }
  }
}