Amazon Comprehend · JSON Structure

Openapi.Yml Bounding Box Structure

The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

For additional information, see BoundingBox in the Amazon Textract API reference.

Type: object Properties: 4
Machine LearningNatural Language ProcessingNLPText Analysis

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

Properties

Height Left Top Width

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-bounding-box-structure.json",
  "name": "BoundingBox",
  "description": "<p>The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0). </p> <p>For additional information, see <a href=\"https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html\">BoundingBox</a> in the Amazon Textract API reference.</p>",
  "type": "object",
  "properties": {
    "Height": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Float"
        },
        {
          "description": "The height of the bounding box as a ratio of the overall document page height."
        }
      ]
    },
    "Left": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Float"
        },
        {
          "description": "The left coordinate of the bounding box as a ratio of overall document page width."
        }
      ]
    },
    "Top": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Float"
        },
        {
          "description": "The top coordinate of the bounding box as a ratio of overall document page height."
        }
      ]
    },
    "Width": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Float"
        },
        {
          "description": "The width of the bounding box as a ratio of the overall document page width."
        }
      ]
    }
  }
}