Optional
BlockThe type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block
objects
that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block
objects
that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block
objects for linked text that's detected on a document page. Use the
EntityType
field to determine if a KEY_VALUE_SET object is a KEY
Block
object or a VALUE Block
object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.
TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
MERGED_CELL - A cell in a table whose content spans more than
one row or column. The Relationships
array for this cell contain data
from individual cells.
SELECTION_ELEMENT - A selection element such as an option
button (radio button) or a check box that's detected on a document page. Use the
value of SelectionStatus
to determine the status of the selection
element.
SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
Optional
ColumnThe column in which a table cell appears. The first column position is 1.
ColumnIndex
isn't returned by DetectDocumentText
and
GetDocumentTextDetection
.
Optional
ColumnThe number of columns that a table cell spans. ColumnSpan
isn't returned by
DetectDocumentText
and GetDocumentTextDetection
.
Optional
ConfidenceThe confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
Optional
EntityThe type of entity.
The following entity types can be returned by FORMS analysis:
KEY - An identifier for a field on the document.
VALUE - The field text.
The following entity types can be returned by TABLES analysis:
COLUMN_HEADER - Identifies a cell that is a header of a column.
TABLE_TITLE - Identifies a cell that is a title within the table.
TABLE_SECTION_TITLE - Identifies a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section.
TABLE_FOOTER - Identifies a cell that is a footer of a table.
TABLE_SUMMARY - Identifies a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.
STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.
SEMI_STRUCTURED_TABLE - Identifies a non-structured table.
EntityTypes
isn't returned by DetectDocumentText
and
GetDocumentTextDetection
.
Optional
GeometryThe location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
Optional
IdThe identifier for the recognized text. The identifier is only unique for a single operation.
Optional
PageThe page on which a block was detected. Page
is returned by synchronous and
asynchronous operations. Page values greater than 1 are only returned for multipage
documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an
asynchronous operation, even if it contains multiple document pages, is considered a
single-page document. This means that for scanned images the value of Page
is
always 1. Synchronous operations will also return a Page
value of 1
because every input document is considered to be a single-page document.
Optional
QueryOptional
RelationshipsA list of relationship objects that describe how blocks are related to each other. For example, a LINE block object contains a CHILD relationship type with the WORD blocks that make up the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks.
Optional
RowThe row in which a table cell is located. The first row position is 1.
RowIndex
isn't returned by DetectDocumentText
and
GetDocumentTextDetection
.
Optional
RowThe number of rows that a table cell spans. RowSpan
isn't returned by
DetectDocumentText
and GetDocumentTextDetection
.
Optional
SelectionThe selection status of a selection element, such as an option button or check box.
Optional
TextThe word or line of text that's recognized by Amazon Textract.
Optional
TextThe kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
A
Block
represents items that are recognized in a document within a group of pixels close to each other. The information returned in aBlock
object depends on the type of operation. In text detection for documents (for example DetectDocumentText), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument), you can also get information about the fields, tables, and selection elements that are detected in the document.An array of
Block
objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array ofBlock
objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis, the array is returned over one or more responses.For more information, see How Amazon Textract Works.