[ aws . textract ]

analyze-expense

Description

AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

Information is returned as ExpenseDocuments and seperated as follows.

• LineItemGroups - A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.

• SummaryFields - Contains all other information a receipt, such as header information or the vendors name.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  analyze-expense
--document <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--document (structure)

The input document, either as bytes or as an S3 object.

You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you’re using an AWS SDK to call Amazon Textract API operations.

You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don’t need to be base64 encoded.

The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.

If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn’t supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.

For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.

Bytes -> (blob)

A blob of base64-encoded document bytes. The maximum size of a document that’s provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.

If you’re using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

S3Object -> (structure)

Identifies an S3 object as the document source. The maximum size of a document that’s stored in an S3 bucket is 5 MB.

Bucket -> (string)

The name of the S3 bucket. Note that the # character is not valid in the file name.

Name -> (string)

The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.

Version -> (string)

If the bucket has versioning enabled, you can specify the object version.

Shorthand Syntax:

Bytes=blob,S3Object={Bucket=string,Name=string,Version=string}

JSON Syntax:

{
  "Bytes": blob,
  "S3Object": {
    "Bucket": "string",
    "Name": "string",
    "Version": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

DocumentMetadata -> (structure)

Information about the input document.

Pages -> (integer)

The number of pages that are detected in the document.

ExpenseDocuments -> (list)

The expenses detected by Amazon Textract.

(structure)

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.

(structure)

Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection

Type -> (structure)

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 -> (structure)

The explicitly stated label of a detected element.

Text -> (string)

The word or line of text recognized by Amazon Textract

Geometry -> (structure)

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 -> (structure)

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.

(structure)

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 -> (structure)

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 -> (structure)

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 -> (structure)

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.

(structure)

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.

LineItemGroups -> (list)

Information detected on each table of a document, seperated into LineItems .

(structure)

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.

(structure)

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.

(structure)

Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection

Type -> (structure)

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 -> (structure)

The explicitly stated label of a detected element.

Text -> (string)

The word or line of text recognized by Amazon Textract

Geometry -> (structure)

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 -> (structure)

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.

(structure)

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 -> (structure)

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 -> (structure)

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 -> (structure)

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.

(structure)

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.