get_expense_analysis(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_expense_analysis(
JobId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis . A JobId value is only valid for 7 days.
dict
Response Syntax
{
'DocumentMetadata': {
'Pages': 123
},
'JobStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'PARTIAL_SUCCESS',
'NextToken': 'string',
'ExpenseDocuments': [
{
'ExpenseIndex': 123,
'SummaryFields': [
{
'Type': {
'Text': 'string',
'Confidence': ...
},
'LabelDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'ValueDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'PageNumber': 123,
'Currency': {
'Code': 'string',
'Confidence': ...
},
'GroupProperties': [
{
'Types': [
'string',
],
'Id': 'string'
},
]
},
],
'LineItemGroups': [
{
'LineItemGroupIndex': 123,
'LineItems': [
{
'LineItemExpenseFields': [
{
'Type': {
'Text': 'string',
'Confidence': ...
},
'LabelDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'ValueDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'PageNumber': 123,
'Currency': {
'Code': 'string',
'Confidence': ...
},
'GroupProperties': [
{
'Types': [
'string',
],
'Id': 'string'
},
]
},
]
},
]
},
],
'Blocks': [
{
'BlockType': 'KEY_VALUE_SET'|'PAGE'|'LINE'|'WORD'|'TABLE'|'CELL'|'SELECTION_ELEMENT'|'MERGED_CELL'|'TITLE'|'QUERY'|'QUERY_RESULT'|'SIGNATURE',
'Confidence': ...,
'Text': 'string',
'TextType': 'HANDWRITING'|'PRINTED',
'RowIndex': 123,
'ColumnIndex': 123,
'RowSpan': 123,
'ColumnSpan': 123,
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Id': 'string',
'Relationships': [
{
'Type': 'VALUE'|'CHILD'|'COMPLEX_FEATURES'|'MERGED_CELL'|'TITLE'|'ANSWER',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE'|'COLUMN_HEADER',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123,
'Query': {
'Text': 'string',
'Alias': 'string',
'Pages': [
'string',
]
}
},
]
},
],
'Warnings': [
{
'ErrorCode': 'string',
'Pages': [
123,
]
},
],
'StatusMessage': 'string',
'AnalyzeExpenseModelVersion': 'string'
}
Response Structure
(dict) --
DocumentMetadata (dict) --
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.
Pages (integer) --
The number of pages that are detected in the document.
JobStatus (string) --
The current status of the text detection job.
NextToken (string) --
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.
ExpenseDocuments (list) --
The expenses detected by Amazon Textract.
(dict) --
The structure holding all the information returned by AnalyzeExpense
ExpenseIndex (integer) --
Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.
SummaryFields (list) --
Any information found outside of a table by Amazon Textract.
(dict) --
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
Type (dict) --
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
Text (string) --
The word or line of text detected by Amazon Textract.
Confidence (float) --
The confidence of accuracy, as a percentage.
LabelDetection (dict) --
The explicitly stated label of a detected element.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
ValueDetection (dict) --
The value of a detected element. Present in explicit and implicit elements.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
PageNumber (integer) --
The page number the value was detected on.
Currency (dict) --
Shows the kind of currency, both the code and confidence associated with any monatary value detected.
Code (string) --
Currency code for detected currency. the current supported codes are:
Confidence (float) --
Percentage confideence in the detected currency.
GroupProperties (list) --
Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.
(dict) --
Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.
Types (list) --
Informs you on whether the expense group is a name or an address.
Id (string) --
Provides a group Id number, which will be the same for each in the group.
LineItemGroups (list) --
Information detected on each table of a document, seperated into LineItems .
(dict) --
A grouping of tables which contain LineItems, with each table identified by the table's LineItemGroupIndex .
LineItemGroupIndex (integer) --
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.
LineItems (list) --
The breakdown of information on a particular line of a table.
(dict) --
A structure that holds information about the different lines found in a document's tables.
LineItemExpenseFields (list) --
ExpenseFields used to show information from detected lines on a table.
(dict) --
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
Type (dict) --
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
Text (string) --
The word or line of text detected by Amazon Textract.
Confidence (float) --
The confidence of accuracy, as a percentage.
LabelDetection (dict) --
The explicitly stated label of a detected element.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
ValueDetection (dict) --
The value of a detected element. Present in explicit and implicit elements.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
PageNumber (integer) --
The page number the value was detected on.
Currency (dict) --
Shows the kind of currency, both the code and confidence associated with any monatary value detected.
Code (string) --
Currency code for detected currency. the current supported codes are:
Confidence (float) --
Percentage confideence in the detected currency.
GroupProperties (list) --
Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.
(dict) --
Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.
Types (list) --
Informs you on whether the expense group is a name or an address.
Id (string) --
Provides a group Id number, which will be the same for each in the group.
Blocks (list) --
This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.
(dict) --
A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block 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 of Block 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.
BlockType (string) --
The type of text item that's recognized. In operations for text detection, the following types are returned:
Block objects that are detected on a document page.In text analysis operations, the following types are returned:
Block objects that are detected on a document page.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.SelectionStatus to determine the status of the selection element.Confidence (float) --
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.
Text (string) --
The word or line of text that's recognized by Amazon Textract.
TextType (string) --
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
RowIndex (integer) --
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnIndex (integer) --
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
RowSpan (integer) --
The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnSpan (integer) --
The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
Geometry (dict) --
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.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Id (string) --
The identifier for the recognized text. The identifier is only unique for a single operation.
Relationships (list) --
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of 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. The list size can be the following:
(dict) --
Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships . For more information, see Block.
The Type element provides the type of the relationship for all blocks in the IDs array.
Type (string) --
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD . A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
Ids (list) --
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
EntityTypes (list) --
The type of entity. The following can be returned:
EntityTypesisn't returned byDetectDocumentTextandGetDocumentTextDetection.
SelectionStatus (string) --
The selection status of a selection element, such as an option button or check box.
Page (integer) --
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. Synchronous operations operations will also return a Page value of 1 because every input document is considered to be a single-page document.
Query (dict) --
Text (string) --
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias (string) --
Alias attached to the query, for ease of location.
Pages (list) --
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
["1"] by default.0 1 2 3 4 5 6 7 8 9 - * . No whitespace is allowed.[“1-3”, “1-1”, “4-*”] . Where * indicates last page of document.Warnings (list) --
A list of warnings that occurred during the text-detection operation for the document.
(dict) --
A warning about an issue that occurred during asynchronous text analysis ( StartDocumentAnalysis ) or asynchronous document text detection ( StartDocumentTextDetection ).
ErrorCode (string) --
The error code for the warning.
Pages (list) --
A list of the pages that the warning applies to.
StatusMessage (string) --
Returns if the detection job could not be completed. Contains explanation for what error occured.
AnalyzeExpenseModelVersion (string) --
The current model version of AnalyzeExpense.
Exceptions
Textract.Client.exceptions.InvalidParameterExceptionTextract.Client.exceptions.AccessDeniedExceptionTextract.Client.exceptions.ProvisionedThroughputExceededExceptionTextract.Client.exceptions.InvalidJobIdExceptionTextract.Client.exceptions.InternalServerErrorTextract.Client.exceptions.ThrottlingExceptionTextract.Client.exceptions.InvalidS3ObjectExceptionTextract.Client.exceptions.InvalidKMSKeyException