AssetOcrResponseDto

Endpoints · All schemas

Field	Required	Description
assetId	Yes	string
boxScore	Yes	Confidence score for text detection box
id	Yes	string
text	Yes	Recognized text
textScore	Yes	Confidence score for text recognition
x1	Yes	Normalized x coordinate of box corner 1 (0-1)
x2	Yes	Normalized x coordinate of box corner 2 (0-1)
x3	Yes	Normalized x coordinate of box corner 3 (0-1)
x4	Yes	Normalized x coordinate of box corner 4 (0-1)
y1	Yes	Normalized y coordinate of box corner 1 (0-1)
y2	Yes	Normalized y coordinate of box corner 2 (0-1)
y3	Yes	Normalized y coordinate of box corner 3 (0-1)
y4	Yes	Normalized y coordinate of box 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.

{
  "properties": {
    "assetId": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "boxScore": {
      "description": "Confidence score for text detection box",
      "format": "double",
      "type": "number"
    },
    "id": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "text": {
      "description": "Recognized text",
      "type": "string"
    },
    "textScore": {
      "description": "Confidence score for text recognition",
      "format": "double",
      "type": "number"
    },
    "x1": {
      "description": "Normalized x coordinate of box corner 1 (0-1)",
      "format": "double",
      "type": "number"
    },
    "x2": {
      "description": "Normalized x coordinate of box corner 2 (0-1)",
      "format": "double",
      "type": "number"
    },
    "x3": {
      "description": "Normalized x coordinate of box corner 3 (0-1)",
      "format": "double",
      "type": "number"
    },
    "x4": {
      "description": "Normalized x coordinate of box corner 4 (0-1)",
      "format": "double",
      "type": "number"
    },
    "y1": {
      "description": "Normalized y coordinate of box corner 1 (0-1)",
      "format": "double",
      "type": "number"
    },
    "y2": {
      "description": "Normalized y coordinate of box corner 2 (0-1)",
      "format": "double",
      "type": "number"
    },
    "y3": {
      "description": "Normalized y coordinate of box corner 3 (0-1)",
      "format": "double",
      "type": "number"
    },
    "y4": {
      "description": "Normalized y coordinate of box corner 4 (0-1)",
      "format": "double",
      "type": "number"
    }
  },
  "required": [
    "assetId",
    "boxScore",
    "id",
    "text",
    "textScore",
    "x1",
    "x2",
    "x3",
    "x4",
    "y1",
    "y2",
    "y3",
    "y4"
  ],
  "type": "object"
}