DocumentLineDto

Endpoints · All schemas

Field	Required	Description
confidence	Yes	Recognition confidence (0-1)
editId	Yes	ID of the owner’s decision about this line
evidenceChanged	Yes	The decision was made against text that has since been read differently
id	Yes	Recognized line ID, or the decision ID of a kept correction
ocrId	Yes	Recognized line ID; null once the line is gone
recognizedText	Yes	The recognized text, while the recognized line exists
region	Yes	See definition below
revision	Yes	Revision of the owner’s decision
status	Yes	See definition below
text	Yes	What the line reads: the owner’s correction or the recognized text

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.

Field definitions: DocumentRegionDto, DocumentLineStatus

{
  "properties": {
    "confidence": {
      "description": "Recognition confidence (0-1)",
      "format": "double",
      "nullable": true,
      "type": "number"
    },
    "editId": {
      "description": "ID of the owner’s decision about this line",
      "format": "uuid",
      "nullable": true,
      "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"
    },
    "evidenceChanged": {
      "description": "The decision was made against text that has since been read differently",
      "type": "boolean"
    },
    "id": {
      "description": "Recognized line ID, or the decision ID of a kept correction",
      "type": "string"
    },
    "ocrId": {
      "description": "Recognized line ID; null once the line is gone",
      "format": "uuid",
      "nullable": true,
      "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"
    },
    "recognizedText": {
      "description": "The recognized text, while the recognized line exists",
      "nullable": true,
      "type": "string"
    },
    "region": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DocumentRegionDto"
        }
      ],
      "nullable": true
    },
    "revision": {
      "description": "Revision of the owner’s decision",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    },
    "status": {
      "$ref": "#/components/schemas/DocumentLineStatus"
    },
    "text": {
      "description": "What the line reads: the owner’s correction or the recognized text",
      "type": "string"
    }
  },
  "required": [
    "confidence",
    "editId",
    "evidenceChanged",
    "id",
    "ocrId",
    "recognizedText",
    "region",
    "revision",
    "status",
    "text"
  ],
  "type": "object"
}