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.
The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The
left (x-coordinate) and
top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).
left values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a
left value of 0.5 (350/700) and a
top value of 0.25 (50/200).
height values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.
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.
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.
Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.
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
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.
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.
Type element provides the type of the relationship for all blocks in the
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.