Skip to content

aws.textract.get_expense_analysis

Example SQL Queries

SELECT * FROM
aws.textract.get_expense_analysis
WHERE
"job_id" = 'VALUE';

Description

Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.

You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the initial call to StartExpenseAnalysis.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetExpenseAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

Table Definition

Column NameColumn Data Type
job_id Required Input Column

A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

VARCHAR
max_results Input Column

The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.

BIGINT
next_token Input Column

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
analyze_expense_model_version

The current model version of AnalyzeExpense.

VARCHAR
document_metadata

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.

STRUCT(
"pages" BIGINT
)
Show child fields
document_metadata.pages

The number of pages that are detected in the document.

expense_documents

The expenses detected by Amazon Textract.

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[]
)
)[]
)[]
Show child fields
expense_documents[]
Show child fields
expense_documents[].blocks[]
Show child fields
expense_documents[].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.

expense_documents[].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.

expense_documents[].blocks[].column_span

The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

expense_documents[].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.

expense_documents[].blocks[].entity_types[]
expense_documents[].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
expense_documents[].blocks[].geometry.bounding_box

An axis-aligned coarse representation of the location of the recognized item on the document page.

Show child fields
expense_documents[].blocks[].geometry.bounding_box.height

The height of the bounding box as a ratio of the overall document page height.

expense_documents[].blocks[].geometry.bounding_box.left

The left coordinate of the bounding box as a ratio of overall document page width.

expense_documents[].blocks[].geometry.bounding_box.top

The top coordinate of the bounding box as a ratio of overall document page height.

expense_documents[].blocks[].geometry.bounding_box.width

The width of the bounding box as a ratio of the overall document page width.

expense_documents[].blocks[].geometry.polygon[]
Show child fields
expense_documents[].blocks[].geometry.polygon[].x

The value of the X coordinate for a point on a Polygon.

expense_documents[].blocks[].geometry.polygon[].y

The value of the Y coordinate for a point on a Polygon.

expense_documents[].blocks[].id

The identifier for the recognized text. The identifier is only unique for a single operation.

expense_documents[].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.

expense_documents[].blocks[].query

Show child fields
expense_documents[].blocks[].query.alias

Alias attached to the query, for ease of location.

expense_documents[].blocks[].query.pages[]
expense_documents[].blocks[].query.text

Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"

expense_documents[].blocks[].relationships[]
Show child fields
expense_documents[].blocks[].relationships[].ids[]
expense_documents[].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.

expense_documents[].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.

expense_documents[].blocks[].row_span

The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

expense_documents[].blocks[].selection_status

The selection status of a selection element, such as an option button or check box.

expense_documents[].blocks[].text

The word or line of text that's recognized by Amazon Textract.

expense_documents[].blocks[].text_type

The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

expense_documents[].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.

expense_documents[].line_item_groups[]
Show child fields
expense_documents[].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.

expense_documents[].line_item_groups[].line_items[]
Show child fields
expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[]
Show child fields
expense_documents[].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
expense_documents[].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

expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].currency.confidence

Percentage confideence in the detected currency.

expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].group_properties[]
Show child fields
expense_documents[].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.

expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].group_properties[].types[]
expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].label_detection

The explicitly stated label of a detected element.

Show child fields
expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].label_detection.confidence

The confidence in detection, as a percentage

expense_documents[].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
expense_documents[].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
expense_documents[].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.

expense_documents[].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.

expense_documents[].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.

expense_documents[].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.

expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].label_detection.geometry.polygon[]
Show child fields
expense_documents[].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.

expense_documents[].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.

expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].label_detection.text

The word or line of text recognized by Amazon Textract

expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].page_number

The page number the value was detected on.

expense_documents[].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
expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].type.confidence

The confidence of accuracy, as a percentage.

expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].type.text

The word or line of text detected by Amazon Textract.

expense_documents[].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
expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].value_detection.confidence

The confidence in detection, as a percentage

expense_documents[].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
expense_documents[].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
expense_documents[].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.

expense_documents[].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.

expense_documents[].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.

expense_documents[].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.

expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].value_detection.geometry.polygon[]
Show child fields
expense_documents[].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.

expense_documents[].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.

expense_documents[].line_item_groups[].line_items[].line_item_expense_fields[].value_detection.text

The word or line of text recognized by Amazon Textract

expense_documents[].summary_fields[]
Show child fields
expense_documents[].summary_fields[].currency

Shows the kind of currency, both the code and confidence associated with any monatary value detected.

Show child fields
expense_documents[].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

expense_documents[].summary_fields[].currency.confidence

Percentage confideence in the detected currency.

expense_documents[].summary_fields[].group_properties[]
Show child fields
expense_documents[].summary_fields[].group_properties[].id

Provides a group Id number, which will be the same for each in the group.

expense_documents[].summary_fields[].group_properties[].types[]
expense_documents[].summary_fields[].label_detection

The explicitly stated label of a detected element.

Show child fields
expense_documents[].summary_fields[].label_detection.confidence

The confidence in detection, as a percentage

expense_documents[].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
expense_documents[].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
expense_documents[].summary_fields[].label_detection.geometry.bounding_box.height

The height of the bounding box as a ratio of the overall document page height.

expense_documents[].summary_fields[].label_detection.geometry.bounding_box.left

The left coordinate of the bounding box as a ratio of overall document page width.

expense_documents[].summary_fields[].label_detection.geometry.bounding_box.top

The top coordinate of the bounding box as a ratio of overall document page height.

expense_documents[].summary_fields[].label_detection.geometry.bounding_box.width

The width of the bounding box as a ratio of the overall document page width.

expense_documents[].summary_fields[].label_detection.geometry.polygon[]
Show child fields
expense_documents[].summary_fields[].label_detection.geometry.polygon[].x

The value of the X coordinate for a point on a Polygon.

expense_documents[].summary_fields[].label_detection.geometry.polygon[].y

The value of the Y coordinate for a point on a Polygon.

expense_documents[].summary_fields[].label_detection.text

The word or line of text recognized by Amazon Textract

expense_documents[].summary_fields[].page_number

The page number the value was detected on.

expense_documents[].summary_fields[].type

The implied label of a detected element. Present alongside LabelDetection for explicit elements.

Show child fields
expense_documents[].summary_fields[].type.confidence

The confidence of accuracy, as a percentage.

expense_documents[].summary_fields[].type.text

The word or line of text detected by Amazon Textract.

expense_documents[].summary_fields[].value_detection

The value of a detected element. Present in explicit and implicit elements.

Show child fields
expense_documents[].summary_fields[].value_detection.confidence

The confidence in detection, as a percentage

expense_documents[].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
expense_documents[].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
expense_documents[].summary_fields[].value_detection.geometry.bounding_box.height

The height of the bounding box as a ratio of the overall document page height.

expense_documents[].summary_fields[].value_detection.geometry.bounding_box.left

The left coordinate of the bounding box as a ratio of overall document page width.

expense_documents[].summary_fields[].value_detection.geometry.bounding_box.top

The top coordinate of the bounding box as a ratio of overall document page height.

expense_documents[].summary_fields[].value_detection.geometry.bounding_box.width

The width of the bounding box as a ratio of the overall document page width.

expense_documents[].summary_fields[].value_detection.geometry.polygon[]
Show child fields
expense_documents[].summary_fields[].value_detection.geometry.polygon[].x

The value of the X coordinate for a point on a Polygon.

expense_documents[].summary_fields[].value_detection.geometry.polygon[].y

The value of the Y coordinate for a point on a Polygon.

expense_documents[].summary_fields[].value_detection.text

The word or line of text recognized by Amazon Textract

job_status

The current status of the text detection job.

VARCHAR
status_message

Returns if the detection job could not be completed. Contains explanation for what error occured.

VARCHAR
warnings

A list of warnings that occurred during the text-detection operation for the document.

STRUCT(
"error_code" VARCHAR,
"pages" BIGINT[]
)[]
Show child fields
warnings[]
Show child fields
warnings[].error_code

The error code for the warning.

warnings[].pages[]