results
Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe. | STRUCT(
"page" BIGINT,
"page_classification" STRUCT(
"page_type" STRUCT(
"value" VARCHAR,
"confidence" DOUBLE
)[],
"page_number" STRUCT(
"value" VARCHAR,
"confidence" DOUBLE
)[]
),
"extractions" STRUCT(
"lending_document" STRUCT(
"lending_fields" STRUCT(
"type" VARCHAR,
"key_detection" STRUCT(
"text" VARCHAR,
"selection_status" VARCHAR,
"geometry" STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
),
"confidence" DOUBLE
),
"value_detections" STRUCT(
"text" VARCHAR,
"selection_status" VARCHAR,
"geometry" STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
),
"confidence" DOUBLE
)[]
)[],
"signature_detections" STRUCT(
"confidence" DOUBLE,
"geometry" STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
)
)[]
),
"expense_document" STRUCT(
"expense_index" BIGINT,
"summary_fields" STRUCT(
"type" STRUCT(
"text" VARCHAR,
"confidence" DOUBLE
),
"label_detection" STRUCT(
"text" VARCHAR,
"geometry" STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
),
"confidence" DOUBLE
),
"value_detection" STRUCT(
"text" VARCHAR,
"geometry" STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
),
"confidence" DOUBLE
),
"page_number" BIGINT,
"currency" STRUCT(
"code" VARCHAR,
"confidence" DOUBLE
),
"group_properties" STRUCT(
"types" VARCHAR[],
"id" VARCHAR
)[]
)[],
"line_item_groups" STRUCT(
"line_item_group_index" BIGINT,
"line_items" STRUCT(
"line_item_expense_fields" STRUCT(
"type" STRUCT(
"text" VARCHAR,
"confidence" DOUBLE
),
"label_detection" STRUCT(
"text" VARCHAR,
"geometry" STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
),
"confidence" DOUBLE
),
"value_detection" STRUCT(
"text" VARCHAR,
"geometry" STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
),
"confidence" DOUBLE
),
"page_number" BIGINT,
"currency" STRUCT(
"code" VARCHAR,
"confidence" DOUBLE
),
"group_properties" STRUCT(
"types" VARCHAR[],
"id" VARCHAR
)[]
)[]
)[]
)[],
"blocks" STRUCT(
"block_type" VARCHAR,
"confidence" DOUBLE,
"text" VARCHAR,
"text_type" VARCHAR,
"row_index" BIGINT,
"column_index" BIGINT,
"row_span" BIGINT,
"column_span" BIGINT,
"geometry" STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
),
"id" VARCHAR,
"relationships" STRUCT(
"type" VARCHAR,
"ids" VARCHAR[]
)[],
"entity_types" VARCHAR[],
"selection_status" VARCHAR,
"page" BIGINT,
"query" STRUCT(
"text" VARCHAR,
"alias" VARCHAR,
"pages" VARCHAR[]
)
)[]
),
"identity_document" STRUCT(
"document_index" BIGINT,
"identity_document_fields" STRUCT(
"type" STRUCT(
"text" VARCHAR,
"normalized_value" STRUCT(
"value" VARCHAR,
"value_type" VARCHAR
),
"confidence" DOUBLE
),
"value_detection" STRUCT(
"text" VARCHAR,
"normalized_value" STRUCT(
"value" VARCHAR,
"value_type" VARCHAR
),
"confidence" DOUBLE
)
)[],
"blocks" STRUCT(
"block_type" VARCHAR,
"confidence" DOUBLE,
"text" VARCHAR,
"text_type" VARCHAR,
"row_index" BIGINT,
"column_index" BIGINT,
"row_span" BIGINT,
"column_span" BIGINT,
"geometry" STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
),
"id" VARCHAR,
"relationships" STRUCT(
"type" VARCHAR,
"ids" VARCHAR[]
)[],
"entity_types" VARCHAR[],
"selection_status" VARCHAR,
"page" BIGINT,
"query" STRUCT(
"text" VARCHAR,
"alias" VARCHAR,
"pages" VARCHAR[]
)
)[]
)
)[]
)[] |
Show child fields- results[]
Show child fields- results[].extractions[]
Show child fields- results[].extractions[].expense_document
The structure holding all the information returned by AnalyzeExpense Show child fields- results[].extractions[].expense_document.blocks[]
Show child fields- results[].extractions[].expense_document.blocks[].block_type
The 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 confidence 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. The following BlockTypes are only returned for Amazon Textract Layout. -
LAYOUT_TITLE - The main title of the document. -
LAYOUT_HEADER - Text located in the top margin of the document. -
LAYOUT_FOOTER - Text located in the bottom margin of the document. -
LAYOUT_SECTION_HEADER - The titles of sections within a document. -
LAYOUT_PAGE_NUMBER - The page number of the documents. -
LAYOUT_LIST - Any information grouped together in list form. -
LAYOUT_FIGURE - Indicates the location of an image in a document. -
LAYOUT_TABLE - Indicates the location of a table in the document. -
LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document. -
LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents. - results[].extractions[].expense_document.blocks[].column_index
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. - results[].extractions[].expense_document.blocks[].column_span
The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection. - results[].extractions[].expense_document.blocks[].confidence
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text. - results[].extractions[].expense_document.blocks[].entity_types[]
- results[].extractions[].expense_document.blocks[].geometry
The 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. Show child fields- results[].extractions[].expense_document.blocks[].geometry.bounding_box
An axis-aligned coarse representation of the location of the recognized item on the document page. Show child fields- results[].extractions[].expense_document.blocks[].geometry.bounding_box.height
The height of the bounding box as a ratio of the overall document page height. - results[].extractions[].expense_document.blocks[].geometry.bounding_box.left
The left coordinate of the bounding box as a ratio of overall document page width. - results[].extractions[].expense_document.blocks[].geometry.bounding_box.top
The top coordinate of the bounding box as a ratio of overall document page height. - results[].extractions[].expense_document.blocks[].geometry.bounding_box.width
The width of the bounding box as a ratio of the overall document page width.
- results[].extractions[].expense_document.blocks[].geometry.polygon[]
Show child fields- results[].extractions[].expense_document.blocks[].geometry.polygon[].x
The value of the X coordinate for a point on a Polygon. - results[].extractions[].expense_document.blocks[].geometry.polygon[].y
The value of the Y coordinate for a point on a Polygon.
- results[].extractions[].expense_document.blocks[].id
The identifier for the recognized text. The identifier is only unique for a single operation. - results[].extractions[].expense_document.blocks[].page
The 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. - results[].extractions[].expense_document.blocks[].query
Show child fields- results[].extractions[].expense_document.blocks[].query.alias
Alias attached to the query, for ease of location. - results[].extractions[].expense_document.blocks[].query.pages[]
- results[].extractions[].expense_document.blocks[].query.text
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
- results[].extractions[].expense_document.blocks[].relationships[]
Show child fields- results[].extractions[].expense_document.blocks[].relationships[].ids[]
- results[].extractions[].expense_document.blocks[].relationships[].type
The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned. -
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. -
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type. -
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table. -
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block. -
TABLE - A list of IDs that identify associated TABLE block types. -
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table. -
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
- results[].extractions[].expense_document.blocks[].row_index
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. - results[].extractions[].expense_document.blocks[].row_span
The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection. - results[].extractions[].expense_document.blocks[].selection_status
The selection status of a selection element, such as an option button or check box. - results[].extractions[].expense_document.blocks[].text
The word or line of text that's recognized by Amazon Textract. - results[].extractions[].expense_document.blocks[].text_type
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
- results[].extractions[].expense_document.expense_index
Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on. - results[].extractions[].expense_document.line_item_groups[]
Show child fields- results[].extractions[].expense_document.line_item_groups[].line_item_group_index
The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc. - results[].extractions[].expense_document.line_item_groups[].line_items[]
Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[]
Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].currency
Shows the kind of currency, both the code and confidence associated with any monatary value detected. Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].currency.code
Currency code for detected currency. the current supported codes are: -
USD -
EUR -
GBP -
CAD -
INR -
JPY -
CHF -
AUD -
CNY -
BZR -
SEK -
HKD - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].currency.confidence
Percentage confideence in the detected currency.
- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].group_properties[]
Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].group_properties[].id
Provides a group Id number, which will be the same for each in the group. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].group_properties[].types[]
- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection
The explicitly stated label of a detected element. Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.confidence
The confidence in detection, as a percentage - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.geometry
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.geometry.bounding_box
An axis-aligned coarse representation of the location of the recognized item on the document page. Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.geometry.bounding_box.height
The height of the bounding box as a ratio of the overall document page height. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.geometry.bounding_box.left
The left coordinate of the bounding box as a ratio of overall document page width. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.geometry.bounding_box.top
The top coordinate of the bounding box as a ratio of overall document page height. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.geometry.bounding_box.width
The width of the bounding box as a ratio of the overall document page width.
- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.geometry.polygon[]
Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.geometry.polygon[].x
The value of the X coordinate for a point on a Polygon. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.geometry.polygon[].y
The value of the Y coordinate for a point on a Polygon.
- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].label_detection.text
The word or line of text recognized by Amazon Textract
- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].page_number
The page number the value was detected on. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].type
The implied label of a detected element. Present alongside LabelDetection for explicit elements. Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].type.confidence
The confidence of accuracy, as a percentage. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].type.text
The word or line of text detected by Amazon Textract.
- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection
The value of a detected element. Present in explicit and implicit elements. Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.confidence
The confidence in detection, as a percentage - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.geometry
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.geometry.bounding_box
An axis-aligned coarse representation of the location of the recognized item on the document page. Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.geometry.bounding_box.height
The height of the bounding box as a ratio of the overall document page height. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.geometry.bounding_box.left
The left coordinate of the bounding box as a ratio of overall document page width. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.geometry.bounding_box.top
The top coordinate of the bounding box as a ratio of overall document page height. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.geometry.bounding_box.width
The width of the bounding box as a ratio of the overall document page width.
- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.geometry.polygon[]
Show child fields- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.geometry.polygon[].x
The value of the X coordinate for a point on a Polygon. - results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.geometry.polygon[].y
The value of the Y coordinate for a point on a Polygon.
- results[].extractions[].expense_document.line_item_groups[].line_items[].line_item_expense_fields[].value_detection.text
The word or line of text recognized by Amazon Textract
- results[].extractions[].expense_document.summary_fields[]
Show child fields- results[].extractions[].expense_document.summary_fields[].currency
Shows the kind of currency, both the code and confidence associated with any monatary value detected. Show child fields- results[].extractions[].expense_document.summary_fields[].currency.code
Currency code for detected currency. the current supported codes are: -
USD -
EUR -
GBP -
CAD -
INR -
JPY -
CHF -
AUD -
CNY -
BZR -
SEK -
HKD - results[].extractions[].expense_document.summary_fields[].currency.confidence
Percentage confideence in the detected currency.
- results[].extractions[].expense_document.summary_fields[].group_properties[]
Show child fields- results[].extractions[].expense_document.summary_fields[].group_properties[].id
Provides a group Id number, which will be the same for each in the group. - results[].extractions[].expense_document.summary_fields[].group_properties[].types[]
- results[].extractions[].expense_document.summary_fields[].label_detection
The explicitly stated label of a detected element. Show child fields- results[].extractions[].expense_document.summary_fields[].label_detection.confidence
The confidence in detection, as a percentage - results[].extractions[].expense_document.summary_fields[].label_detection.geometry
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Show child fields- results[].extractions[].expense_document.summary_fields[].label_detection.geometry.bounding_box
An axis-aligned coarse representation of the location of the recognized item on the document page. Show child fields- results[].extractions[].expense_document.summary_fields[].label_detection.geometry.bounding_box.height
The height of the bounding box as a ratio of the overall document page height. - results[].extractions[].expense_document.summary_fields[].label_detection.geometry.bounding_box.left
The left coordinate of the bounding box as a ratio of overall document page width. - results[].extractions[].expense_document.summary_fields[].label_detection.geometry.bounding_box.top
The top coordinate of the bounding box as a ratio of overall document page height. - results[].extractions[].expense_document.summary_fields[].label_detection.geometry.bounding_box.width
The width of the bounding box as a ratio of the overall document page width.
- results[].extractions[].expense_document.summary_fields[].label_detection.geometry.polygon[]
Show child fields- results[].extractions[].expense_document.summary_fields[].label_detection.geometry.polygon[].x
The value of the X coordinate for a point on a Polygon. - results[].extractions[].expense_document.summary_fields[].label_detection.geometry.polygon[].y
The value of the Y coordinate for a point on a Polygon.
- results[].extractions[].expense_document.summary_fields[].label_detection.text
The word or line of text recognized by Amazon Textract
- results[].extractions[].expense_document.summary_fields[].page_number
The page number the value was detected on. - results[].extractions[].expense_document.summary_fields[].type
The implied label of a detected element. Present alongside LabelDetection for explicit elements. Show child fields- results[].extractions[].expense_document.summary_fields[].type.confidence
The confidence of accuracy, as a percentage. - results[].extractions[].expense_document.summary_fields[].type.text
The word or line of text detected by Amazon Textract.
- results[].extractions[].expense_document.summary_fields[].value_detection
The value of a detected element. Present in explicit and implicit elements. Show child fields- results[].extractions[].expense_document.summary_fields[].value_detection.confidence
The confidence in detection, as a percentage - results[].extractions[].expense_document.summary_fields[].value_detection.geometry
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Show child fields- results[].extractions[].expense_document.summary_fields[].value_detection.geometry.bounding_box
An axis-aligned coarse representation of the location of the recognized item on the document page. Show child fields- results[].extractions[].expense_document.summary_fields[].value_detection.geometry.bounding_box.height
The height of the bounding box as a ratio of the overall document page height. - results[].extractions[].expense_document.summary_fields[].value_detection.geometry.bounding_box.left
The left coordinate of the bounding box as a ratio of overall document page width. - results[].extractions[].expense_document.summary_fields[].value_detection.geometry.bounding_box.top
The top coordinate of the bounding box as a ratio of overall document page height. - results[].extractions[].expense_document.summary_fields[].value_detection.geometry.bounding_box.width
The width of the bounding box as a ratio of the overall document page width.
- results[].extractions[].expense_document.summary_fields[].value_detection.geometry.polygon[]
Show child fields- results[].extractions[].expense_document.summary_fields[].value_detection.geometry.polygon[].x
The value of the X coordinate for a point on a Polygon. - results[].extractions[].expense_document.summary_fields[].value_detection.geometry.polygon[].y
The value of the Y coordinate for a point on a Polygon.
- results[].extractions[].expense_document.summary_fields[].value_detection.text
The word or line of text recognized by Amazon Textract
- results[].extractions[].identity_document
The structure that lists each document processed in an AnalyzeID operation. Show child fields- results[].extractions[].identity_document.blocks[]
Show child fields- results[].extractions[].identity_document.blocks[].block_type
The 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 confidence 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. The following BlockTypes are only returned for Amazon Textract Layout. -
LAYOUT_TITLE - The main title of the document. -
LAYOUT_HEADER - Text located in the top margin of the document. -
LAYOUT_FOOTER - Text located in the bottom margin of the document. -
LAYOUT_SECTION_HEADER - The titles of sections within a document. -
LAYOUT_PAGE_NUMBER - The page number of the documents. -
LAYOUT_LIST - Any information grouped together in list form. -
LAYOUT_FIGURE - Indicates the location of an image in a document. -
LAYOUT_TABLE - Indicates the location of a table in the document. -
LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document. -
LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents. - results[].extractions[].identity_document.blocks[].column_index
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. - results[].extractions[].identity_document.blocks[].column_span
The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection. - results[].extractions[].identity_document.blocks[].confidence
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text. - results[].extractions[].identity_document.blocks[].entity_types[]
- results[].extractions[].identity_document.blocks[].geometry
The 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. Show child fields- results[].extractions[].identity_document.blocks[].geometry.bounding_box
An axis-aligned coarse representation of the location of the recognized item on the document page. Show child fields- results[].extractions[].identity_document.blocks[].geometry.bounding_box.height
The height of the bounding box as a ratio of the overall document page height. - results[].extractions[].identity_document.blocks[].geometry.bounding_box.left
The left coordinate of the bounding box as a ratio of overall document page width. - results[].extractions[].identity_document.blocks[].geometry.bounding_box.top
The top coordinate of the bounding box as a ratio of overall document page height. - results[].extractions[].identity_document.blocks[].geometry.bounding_box.width
The width of the bounding box as a ratio of the overall document page width.
- results[].extractions[].identity_document.blocks[].geometry.polygon[]
Show child fields- results[].extractions[].identity_document.blocks[].geometry.polygon[].x
The value of the X coordinate for a point on a Polygon. - results[].extractions[].identity_document.blocks[].geometry.polygon[].y
The value of the Y coordinate for a point on a Polygon.
- results[].extractions[].identity_document.blocks[].id
The identifier for the recognized text. The identifier is only unique for a single operation. - results[].extractions[].identity_document.blocks[].page
The 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. - results[].extractions[].identity_document.blocks[].query
Show child fields- results[].extractions[].identity_document.blocks[].query.alias
Alias attached to the query, for ease of location. - results[].extractions[].identity_document.blocks[].query.pages[]
- results[].extractions[].identity_document.blocks[].query.text
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
- results[].extractions[].identity_document.blocks[].relationships[]
Show child fields- results[].extractions[].identity_document.blocks[].relationships[].ids[]
- results[].extractions[].identity_document.blocks[].relationships[].type
The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned. -
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. -
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type. -
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table. -
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block. -
TABLE - A list of IDs that identify associated TABLE block types. -
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table. -
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
- results[].extractions[].identity_document.blocks[].row_index
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. - results[].extractions[].identity_document.blocks[].row_span
The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection. - results[].extractions[].identity_document.blocks[].selection_status
The selection status of a selection element, such as an option button or check box. - results[].extractions[].identity_document.blocks[].text
The word or line of text that's recognized by Amazon Textract. - results[].extractions[].identity_document.blocks[].text_type
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
- results[].extractions[].identity_document.document_index
Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on. - results[].extractions[].identity_document.identity_document_fields[]
Show child fields- results[].extractions[].identity_document.identity_document_fields[].type
Used to contain the information detected by an AnalyzeID operation. Show child fields- results[].extractions[].identity_document.identity_document_fields[].type.confidence
The confidence score of the detected text. - results[].extractions[].identity_document.identity_document_fields[].type.normalized_value
Only returned for dates, returns the type of value detected and the date written in a more machine readable way. Show child fields- results[].extractions[].identity_document.identity_document_fields[].type.normalized_value.value
The value of the date, written as Year-Month-DayTHour:Minute:Second. - results[].extractions[].identity_document.identity_document_fields[].type.normalized_value.value_type
The normalized type of the value detected. In this case, DATE.
- results[].extractions[].identity_document.identity_document_fields[].type.text
Text of either the normalized field or value associated with it.
- results[].extractions[].identity_document.identity_document_fields[].value_detection
Used to contain the information detected by an AnalyzeID operation. Show child fields- results[].extractions[].identity_document.identity_document_fields[].value_detection.confidence
The confidence score of the detected text. - results[].extractions[].identity_document.identity_document_fields[].value_detection.normalized_value
Only returned for dates, returns the type of value detected and the date written in a more machine readable way. Show child fields- results[].extractions[].identity_document.identity_document_fields[].value_detection.normalized_value.value
The value of the date, written as Year-Month-DayTHour:Minute:Second. - results[].extractions[].identity_document.identity_document_fields[].value_detection.normalized_value.value_type
The normalized type of the value detected. In this case, DATE.
- results[].extractions[].identity_document.identity_document_fields[].value_detection.text
Text of either the normalized field or value associated with it.
- results[].extractions[].lending_document
Holds the structured data returned by AnalyzeDocument for lending documents. Show child fields- results[].extractions[].lending_document.lending_fields[]
Show child fields- results[].extractions[].lending_document.lending_fields[].key_detection
The results extracted for a lending document. Show child fields- results[].extractions[].lending_document.lending_fields[].key_detection.confidence
The confidence level for the text of a detected value in a lending document. - results[].extractions[].lending_document.lending_fields[].key_detection.geometry
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Show child fields- results[].extractions[].lending_document.lending_fields[].key_detection.geometry.bounding_box
An axis-aligned coarse representation of the location of the recognized item on the document page. Show child fields- results[].extractions[].lending_document.lending_fields[].key_detection.geometry.bounding_box.height
The height of the bounding box as a ratio of the overall document page height. - results[].extractions[].lending_document.lending_fields[].key_detection.geometry.bounding_box.left
The left coordinate of the bounding box as a ratio of overall document page width. - results[].extractions[].lending_document.lending_fields[].key_detection.geometry.bounding_box.top
The top coordinate of the bounding box as a ratio of overall document page height. - results[].extractions[].lending_document.lending_fields[].key_detection.geometry.bounding_box.width
The width of the bounding box as a ratio of the overall document page width.
- results[].extractions[].lending_document.lending_fields[].key_detection.geometry.polygon[]
Show child fields- results[].extractions[].lending_document.lending_fields[].key_detection.geometry.polygon[].x
The value of the X coordinate for a point on a Polygon. - results[].extractions[].lending_document.lending_fields[].key_detection.geometry.polygon[].y
The value of the Y coordinate for a point on a Polygon.
- results[].extractions[].lending_document.lending_fields[].key_detection.selection_status
The selection status of a selection element, such as an option button or check box. - results[].extractions[].lending_document.lending_fields[].key_detection.text
The text extracted for a detected value in a lending document.
- results[].extractions[].lending_document.lending_fields[].type
The type of the lending document. - results[].extractions[].lending_document.lending_fields[].value_detections[]
Show child fields- results[].extractions[].lending_document.lending_fields[].value_detections[].confidence
The confidence level for the text of a detected value in a lending document. - results[].extractions[].lending_document.lending_fields[].value_detections[].geometry
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Show child fields- results[].extractions[].lending_document.lending_fields[].value_detections[].geometry.bounding_box
An axis-aligned coarse representation of the location of the recognized item on the document page. Show child fields- results[].extractions[].lending_document.lending_fields[].value_detections[].geometry.bounding_box.height
The height of the bounding box as a ratio of the overall document page height. - results[].extractions[].lending_document.lending_fields[].value_detections[].geometry.bounding_box.left
The left coordinate of the bounding box as a ratio of overall document page width. - results[].extractions[].lending_document.lending_fields[].value_detections[].geometry.bounding_box.top
The top coordinate of the bounding box as a ratio of overall document page height. - results[].extractions[].lending_document.lending_fields[].value_detections[].geometry.bounding_box.width
The width of the bounding box as a ratio of the overall document page width.
- results[].extractions[].lending_document.lending_fields[].value_detections[].geometry.polygon[]
Show child fields- results[].extractions[].lending_document.lending_fields[].value_detections[].geometry.polygon[].x
The value of the X coordinate for a point on a Polygon. - results[].extractions[].lending_document.lending_fields[].value_detections[].geometry.polygon[].y
The value of the Y coordinate for a point on a Polygon.
- results[].extractions[].lending_document.lending_fields[].value_detections[].selection_status
The selection status of a selection element, such as an option button or check box. - results[].extractions[].lending_document.lending_fields[].value_detections[].text
The text extracted for a detected value in a lending document.
- results[].extractions[].lending_document.signature_detections[]
Show child fields- results[].extractions[].lending_document.signature_detections[].confidence
The confidence, from 0 to 100, in the predicted values for a detected signature. - results[].extractions[].lending_document.signature_detections[].geometry
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Show child fields- results[].extractions[].lending_document.signature_detections[].geometry.bounding_box
An axis-aligned coarse representation of the location of the recognized item on the document page. Show child fields- results[].extractions[].lending_document.signature_detections[].geometry.bounding_box.height
The height of the bounding box as a ratio of the overall document page height. - results[].extractions[].lending_document.signature_detections[].geometry.bounding_box.left
The left coordinate of the bounding box as a ratio of overall document page width. - results[].extractions[].lending_document.signature_detections[].geometry.bounding_box.top
The top coordinate of the bounding box as a ratio of overall document page height. - results[].extractions[].lending_document.signature_detections[].geometry.bounding_box.width
The width of the bounding box as a ratio of the overall document page width.
- results[].extractions[].lending_document.signature_detections[].geometry.polygon[]
Show child fields- results[].extractions[].lending_document.signature_detections[].geometry.polygon[].x
The value of the X coordinate for a point on a Polygon. - results[].extractions[].lending_document.signature_detections[].geometry.polygon[].y
The value of the Y coordinate for a point on a Polygon.
- results[].page
The page number for a page, with regard to whole submission. - results[].page_classification
The classifier result for a given page. Show child fields- results[].page_classification.page_number[]
Show child fields- results[].page_classification.page_number[].confidence
Amazon Textract's confidence in its predicted value. - results[].page_classification.page_number[].value
The predicted value of a detected object.
- results[].page_classification.page_type[]
Show child fields- results[].page_classification.page_type[].confidence
Amazon Textract's confidence in its predicted value. - results[].page_classification.page_type[].value
The predicted value of a detected object.
|