Skip to content

Start Expense Analysis

textract_start_expense_analysis R Documentation

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names

Description

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

start_expense_analysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket.

start_expense_analysis returns a job identifier (JobId) that you will provide to get_expense_analysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call get_expense_analysis, and pass the job identifier (JobId) that was returned by your call to start_expense_analysis.

For more information, see Analyzing Invoices and Receipts.

Usage

textract_start_expense_analysis(DocumentLocation, ClientRequestToken,
  JobTag, NotificationChannel, OutputConfig, KMSKeyId)

Arguments

DocumentLocation

[required] The location of the document to be processed.
ClientRequestToken

The idempotent token that's used to identify the start request. If you use the same token with multiple start_document_text_detection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations
JobTag

An identifier you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).
NotificationChannel

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
OutputConfig

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the get_expense_analysis operation.
KMSKeyId

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

Value

A list with the following syntax:

list(
  JobId = "string"
)

Request syntax

svc$start_expense_analysis(
  DocumentLocation = list(
    S3Object = list(
      Bucket = "string",
      Name = "string",
      Version = "string"
    )
  ),
  ClientRequestToken = "string",
  JobTag = "string",
  NotificationChannel = list(
    SNSTopicArn = "string",
    RoleArn = "string"
  ),
  OutputConfig = list(
    S3Bucket = "string",
    S3Prefix = "string"
  ),
  KMSKeyId = "string"
)