Skip to content

DocumentRegionDto

Endpoints · All schemas

Where the text is in the photo as it is shown, edits applied

FieldRequiredDescription
x1YesNormalized x coordinate of corner 1 (0-1)
x2YesNormalized x coordinate of corner 2 (0-1)
x3YesNormalized x coordinate of corner 3 (0-1)
x4YesNormalized x coordinate of corner 4 (0-1)
y1YesNormalized y coordinate of corner 1 (0-1)
y2YesNormalized y coordinate of corner 2 (0-1)
y3YesNormalized y coordinate of corner 3 (0-1)
y4YesNormalized y coordinate of corner 4 (0-1)

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "description": "Where the text is in the photo as it is shown, edits applied",
  "properties": {
    "x1": {
      "description": "Normalized x coordinate of corner 1 (0-1)",
      "format": "double",
      "type": "number"
    },
    "x2": {
      "description": "Normalized x coordinate of corner 2 (0-1)",
      "format": "double",
      "type": "number"
    },
    "x3": {
      "description": "Normalized x coordinate of corner 3 (0-1)",
      "format": "double",
      "type": "number"
    },
    "x4": {
      "description": "Normalized x coordinate of corner 4 (0-1)",
      "format": "double",
      "type": "number"
    },
    "y1": {
      "description": "Normalized y coordinate of corner 1 (0-1)",
      "format": "double",
      "type": "number"
    },
    "y2": {
      "description": "Normalized y coordinate of corner 2 (0-1)",
      "format": "double",
      "type": "number"
    },
    "y3": {
      "description": "Normalized y coordinate of corner 3 (0-1)",
      "format": "double",
      "type": "number"
    },
    "y4": {
      "description": "Normalized y coordinate of corner 4 (0-1)",
      "format": "double",
      "type": "number"
    }
  },
  "required": [
    "x1",
    "x2",
    "x3",
    "x4",
    "y1",
    "y2",
    "y3",
    "y4"
  ],
  "type": "object"
}