ReadResult interface

Text extracted from a page in the input document.

Properties

angle

The orientation of the image in degrees in the clockwise direction. Range between [-180, 180).

height

The height of the image in pixels or the PDF in inches.

language

The BCP-47 language code of the recognized text page.

lines

A list of recognized text lines.

page

The 1-based page number of the recognition result.

unit

The unit used in the Width, Height and BoundingBox. For images, the unit is 'pixel'. For PDF, the unit is 'inch'. Possible values include: 'pixel', 'inch'

width

The width of the image in pixels or the PDF in inches.

Property Details

angle

The orientation of the image in degrees in the clockwise direction. Range between [-180, 180).

angle: number

Property Value

number

height

The height of the image in pixels or the PDF in inches.

height: number

Property Value

number

language

The BCP-47 language code of the recognized text page.

language?: string

Property Value

string

lines

A list of recognized text lines.

lines: Line[]

Property Value

Line[]

page

The 1-based page number of the recognition result.

page: number

Property Value

number

unit

The unit used in the Width, Height and BoundingBox. For images, the unit is 'pixel'. For PDF, the unit is 'inch'. Possible values include: 'pixel', 'inch'

unit: TextRecognitionResultDimensionUnit

Property Value

width

The width of the image in pixels or the PDF in inches.

width: number

Property Value

number