Document Extraction 0.8.0

{    "x-license": {        "id": "Apache-2.0",        "notice": "Copyright 2025-2026 The OATS Authors",        "url": "https://github.com/oatschema/oats/blob/main/LICENSE"    },    "$schema": "https://json-schema.org/draft/2020-12/schema",    "$id": "https://oatschema.org/0.8.0/document-extraction",    "title": "Document Extraction",    "x-version": "0.8.0",    "description": "Represent the layout and content of a document, including text blocks, geometric coordinates, and page structure.",    "type": "object",    "properties": {        "extraction_type": {            "type": "string",            "description": "Optionally indicate the extraction type.",            "enum": [                "text",                "lines",                "boxes",                "polygons",                "mixed"            ]        },        "producer": {            "type": "string",            "description": "The creator (model, tool or author) of this extraction.",            "maxLength": 1024        },        "unit": {            "type": "string",            "description": "The unit for all coordinate values: 'px' for pixels, 'pt' for typographic points, 'normalized' for values from 0.0 to 1.0, and 'per_mille' for values from 0 to 1000. Required whenever geometric data is present.",            "enum": [                "px",                "pt",                "normalized",                "per_mille"            ]        },        "page_width": {            "description": "The width of the page(s), in the record's unit if 'px' or 'pt', otherwise in any unit shared with page_height. Can be a single number for uniform documents, or an array of objects mapping specific widths to page numbers.",            "oneOf": [                {                    "type": "number",                    "title": "Uniform Width",                    "exclusiveMinimum": 0                },                {                    "type": "array",                    "title": "Variable Widths",                    "minItems": 1,                    "maxItems": 10000,                    "items": {                        "type": "object",                        "description": "A width shared by one or more pages.",                        "properties": {                            "value": {                                "type": "number",                                "description": "The width of these pages.",                                "exclusiveMinimum": 0                            },                            "pages": {                                "type": "array",                                "description": "The page numbers (1-indexed) that share this width.",                                "minItems": 1,                                "maxItems": 100000,                                "uniqueItems": true,                                "items": {                                    "type": "integer",                                    "minimum": 1                                }                            }                        },                        "required": [                            "value",                            "pages"                        ],                        "additionalProperties": false                    }                }            ]        },        "page_height": {            "description": "The height of the page(s), in the record's unit if 'px' or 'pt', otherwise in any unit shared with page_width. Can be a single number for uniform documents, or an array of objects mapping specific heights to page numbers.",            "oneOf": [                {                    "type": "number",                    "title": "Uniform Height",                    "exclusiveMinimum": 0                },                {                    "type": "array",                    "title": "Variable Heights",                    "minItems": 1,                    "maxItems": 10000,                    "items": {                        "type": "object",                        "description": "A height shared by one or more pages.",                        "properties": {                            "value": {                                "type": "number",                                "description": "The height of these pages.",                                "exclusiveMinimum": 0                            },                            "pages": {                                "type": "array",                                "description": "The page numbers (1-indexed) that share this height.",                                "minItems": 1,                                "maxItems": 100000,                                "uniqueItems": true,                                "items": {                                    "type": "integer",                                    "minimum": 1                                }                            }                        },                        "required": [                            "value",                            "pages"                        ],                        "additionalProperties": false                    }                }            ]        },        "score_explanation": {            "type": "string",            "description": "Defines the meaning of the 'score' field.",            "maxLength": 256        },        "blocks": {            "type": "array",            "description": "An array of text blocks extracted from the document.",            "maxItems": 100000,            "items": {                "type": "object",                "description": "A single extracted block of text or geometry.",                "properties": {                    "block_type": {                        "type": "string",                        "description": "Defines the nature of this specific block (text, line, box, polygon, or multi_polygon).",                        "enum": [                            "text",                            "line",                            "box",                            "polygon",                            "multi_polygon"                        ]                    },                    "id": {                        "type": "string",                        "description": "A unique identifier (e.g., UUID4) for this block, useful for referencing.",                        "maxLength": 128                    },                    "text": {                        "type": "string",                        "description": "The text content of the block. Required for text and line block types.",                        "maxLength": 4096                    },                    "line_number": {                        "type": "integer",                        "description": "The line number of the block within its page, if applicable.",                        "minimum": 1                    },                    "page_number": {                        "type": "integer",                        "description": "The page number (1-indexed) where this block is located.",                        "minimum": 1                    },                    "score": {                        "type": "number",                        "description": "The confidence score for this block's detection and transcription, ranging from 0.0 (uncertain) to 1.0 (certain).",                        "minimum": 0,                        "maximum": 1                    },                    "box": {                        "type": "object",                        "description": "A rectangular bounding box defined by its top-left corner (x, y) and its dimensions.",                        "properties": {                            "x": {                                "type": "number",                                "description": "The x-coordinate of the top-left corner.",                                "minimum": 0                            },                            "y": {                                "type": "number",                                "description": "The y-coordinate of the top-left corner.",                                "minimum": 0                            },                            "width": {                                "type": "number",                                "description": "The width of the box.",                                "minimum": 0                            },                            "height": {                                "type": "number",                                "description": "The height of the box.",                                "minimum": 0                            }                        },                        "required": [                            "x",                            "y",                            "width",                            "height"                        ],                        "additionalProperties": false                    },                    "polygon": {                        "type": "array",                        "description": "An ordered list of vertices defining a non-rectangular boundary.",                        "minItems": 3,                        "maxItems": 1000,                        "items": {                            "type": "object",                            "description": "A single vertex, measured from the top-left corner of the page or image.",                            "properties": {                                "x": {                                    "type": "number",                                    "description": "The x-coordinate of the vertex.",                                    "minimum": 0                                },                                "y": {                                    "type": "number",                                    "description": "The y-coordinate of the vertex.",                                    "minimum": 0                                }                            },                            "required": [                                "x",                                "y"                            ],                            "additionalProperties": false                        }                    },                    "multi_polygon": {                        "type": "array",                        "description": "A list of polygons, for a single region that is occluded or fragmented into multiple visible parts.",                        "minItems": 1,                        "maxItems": 100,                        "items": {                            "type": "array",                            "description": "An ordered list of vertices defining a non-rectangular boundary.",                            "minItems": 3,                            "maxItems": 1000,                            "items": {                                "type": "object",                                "description": "A single vertex, measured from the top-left corner of the page or image.",                                "properties": {                                    "x": {                                        "type": "number",                                        "description": "The x-coordinate of the vertex.",                                        "minimum": 0                                    },                                    "y": {                                        "type": "number",                                        "description": "The y-coordinate of the vertex.",                                        "minimum": 0                                    }                                },                                "required": [                                    "x",                                    "y"                                ],                                "additionalProperties": false                            }                        }                    },                    "attributes": {                        "type": "object",                        "description": "Arbitrary metadata relevant to this block.",                        "maxProperties": 16,                        "propertyNames": {                            "maxLength": 128                        },                        "additionalProperties": {                            "anyOf": [                                {                                    "type": "string",                                    "maxLength": 1024                                },                                {                                    "type": "number"                                },                                {                                    "type": "boolean"                                },                                {                                    "type": "null"                                }                            ]                        }                    }                },                "required": [                    "block_type"                ],                "allOf": [                    {                        "if": {                            "properties": {                                "block_type": {                                    "enum": [                                        "text",                                        "line"                                    ]                                }                            }                        },                        "then": {                            "required": [                                "text"                            ]                        }                    },                    {                        "if": {                            "properties": {                                "block_type": {                                    "const": "box"                                }                            }                        },                        "then": {                            "required": [                                "box"                            ]                        }                    },                    {                        "if": {                            "properties": {                                "block_type": {                                    "const": "polygon"                                }                            }                        },                        "then": {                            "required": [                                "polygon"                            ]                        }                    },                    {                        "if": {                            "properties": {                                "block_type": {                                    "const": "multi_polygon"                                }                            }                        },                        "then": {                            "required": [                                "multi_polygon"                            ]                        }                    },                    {                        "if": {                            "properties": {                                "block_type": {                                    "const": "line"                                }                            }                        },                        "then": {                            "anyOf": [                                {                                    "required": [                                        "box"                                    ]                                },                                {                                    "required": [                                        "polygon"                                    ]                                },                                {                                    "required": [                                        "multi_polygon"                                    ]                                }                            ]                        }                    }                ],                "additionalProperties": false            }        },        "attributes": {            "type": "object",            "description": "Arbitrary metadata relevant to this extraction.",            "maxProperties": 16,            "propertyNames": {                "maxLength": 128            },            "additionalProperties": {                "anyOf": [                    {                        "type": "string",                        "maxLength": 1024                    },                    {                        "type": "number"                    },                    {                        "type": "boolean"                    },                    {                        "type": "null"                    }                ]            }        }    },    "required": [        "blocks"    ],    "allOf": [        {            "if": {                "properties": {                    "blocks": {                        "contains": {                            "anyOf": [                                {                                    "required": [                                        "box"                                    ]                                },                                {                                    "required": [                                        "polygon"                                    ]                                },                                {                                    "required": [                                        "multi_polygon"                                    ]                                }                            ]                        }                    }                },                "required": [                    "blocks"                ]            },            "then": {                "required": [                    "unit"                ]            }        },        {            "if": {                "properties": {                    "unit": {                        "const": "normalized"                    }                },                "required": [                    "unit"                ]            },            "then": {                "properties": {                    "blocks": {                        "items": {                            "properties": {                                "box": {                                    "properties": {                                        "x": {                                            "maximum": 1                                        },                                        "y": {                                            "maximum": 1                                        },                                        "width": {                                            "maximum": 1                                        },                                        "height": {                                            "maximum": 1                                        }                                    }                                },                                "polygon": {                                    "items": {                                        "properties": {                                            "x": {                                                "maximum": 1                                            },                                            "y": {                                                "maximum": 1                                            }                                        }                                    }                                },                                "multi_polygon": {                                    "items": {                                        "items": {                                            "properties": {                                                "x": {                                                    "maximum": 1                                                },                                                "y": {                                                    "maximum": 1                                                }                                            }                                        }                                    }                                }                            }                        }                    }                }            }        },        {            "if": {                "properties": {                    "unit": {                        "const": "per_mille"                    }                },                "required": [                    "unit"                ]            },            "then": {                "properties": {                    "blocks": {                        "items": {                            "properties": {                                "box": {                                    "properties": {                                        "x": {                                            "maximum": 1000                                        },                                        "y": {                                            "maximum": 1000                                        },                                        "width": {                                            "maximum": 1000                                        },                                        "height": {                                            "maximum": 1000                                        }                                    }                                },                                "polygon": {                                    "items": {                                        "properties": {                                            "x": {                                                "maximum": 1000                                            },                                            "y": {                                                "maximum": 1000                                            }                                        }                                    }                                },                                "multi_polygon": {                                    "items": {                                        "items": {                                            "properties": {                                                "x": {                                                    "maximum": 1000                                                },                                                "y": {                                                    "maximum": 1000                                                }                                            }                                        }                                    }                                }                            }                        }                    }                }            }        }    ],    "additionalProperties": false}