Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
An array of
For more information, see How Amazon Textract Works.
The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The
The input document, either as bytes or as an S3 object.
You pass image bytes to an Amazon Textract API operation by using the
You pass images stored in an S3 bucket to an Amazon Textract API operation by using the
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.
The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations such as StartDocumentTextDetection.
The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.
Information about the input document.
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.
Sets up the human review workflow the document will be sent to if one of the conditions is met. You can also set certain attributes of the image before review.
Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information and adult content.
The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation, such as StartDocumentTextDetection.
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
Information about how blocks are related to each other. A
The S3 bucket name and file name that identifies the document.
The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.
For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.
A client for the Amazon Textract API.
Errors returned by AnalyzeDocument
Errors returned by DetectDocumentText
Errors returned by GetDocumentAnalysis
Errors returned by GetDocumentTextDetection
Errors returned by StartDocumentAnalysis
Errors returned by StartDocumentTextDetection
Trait representing the capabilities of the Amazon Textract API. Amazon Textract clients implement this trait.