API Reference | OcrResult
OCR Result Schema Definitions
OcrResponse
OcrResponse
- Width: integer (int32)
-
Total width (of all pages) according to the document resolution
- Height: integer (int32)
-
Total height (of all pages) according to the document resolution
- NumberOfPages: integer (int32)
-
Total number of pages analyzed by the OCR
- Pages: OcrPageResponse
-
List of pages
Example
{
"Width": "integer (int32)",
"Height": "integer (int32)",
"NumberOfPages": "integer (int32)",
"Pages": "List"
}
OcrPageResponse
OcrPageResponse
- Index: integer (int32)
-
Page index (0-based)
- DpiX: integer (int32)
-
Horizontal resolution of the page in DPI (=dots per inch)
- DpiY: integer (int32)
-
Vertical resolution of the page in DPI (=dots per inch)
- Width: integer (int32)
-
Width of the page according to the horizontal resolution
- Height: integer (int32)
-
Height of the page according to the horizontal resolution
- Orientation: string
-
Describes the rotation of the page.
Possible values are: "0", "90", "180", "270" - Regions: OcrRegion
-
List of regions - A region consists of one or more lines of words in close proximity
Example
{
"Index": "integer (int32)",
"DpiX": "integer (int32)",
"DpiY": "integer (int32)",
"Width": "integer (int32)",
"Height": "integer (int32)",
"Orientation": "string",
"Regions": "List"
}
OcrRegion
OcrRegion
- Lines: OcrLine
-
List of lines - A line consists of one or more words on the same baseline in close proximity
- BoundingBox: BoundingBox
-
Contains the location and size of the region related to the top-left corner of the first page
Example
{
"Lines": "List",
"BoundingBox": "BoundingBox"
}
OcrLine
OcrLine
- Words: OcrWord
-
List of words
- BoundingBox: BoundingBox
-
Contains the location and size of the line related to the top-left corner of the first page
Example
{
"Words": "List",
"BoundingBox": "BoundingBox"
}
OcrWord
OcrWord
- Text: string
-
The text-content detected by the OCR
- BoundingBox: BoundingBox
-
Contains the location and size of the word related to the top-left corner of the first page
- CapHeight: integer (int32)
-
Expresses a measure of the capital letter height in pixels
- BaseLine: integer (ushort)
-
Y coordinate of the baseline in pixels. In case of vertical text this is X coordinate.
- FontSize: integer (int32)
-
Size of the font in pixels.
- Bold: boolean
-
Specifies if the word is formated as "bold"
- Italic: boolean
-
Specifies if the word is formated as "italic"
- Underlined: boolean
-
Specifies if the word is formated as "underlined"
- Proportional: boolean
-
Specifies if the font is a proportinal font.
A proportinal font is any font whose different characters have different widths.
Example
{
"Text": "string",
"BoundingBox": "BoundingBox",
"CapHeight": "integer (int32)",
"BaseLine": "integer (ushort)",
"FontSize": "integer (int32)",
"Bold": "boolean",
"Italic": "boolean",
"Underlined": "boolean",
"Proportional": "boolean"
}