Expand description
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
If you’re using the service, you’re probably looking for TextractClient and Textract.
Structs§
- Analyze
Document Request - Analyze
Document Response - Block
A
Blockrepresents items that are recognized in a document within a group of pixels close to each other. The information returned in aBlockobject 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
Blockobjects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array ofBlockobjects 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.
- Bounding
Box 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) andtop(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).The
topandleftvalues 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 aleftvalue of 0.5 (350/700) and atopvalue of 0.25 (50/200).The
widthandheightvalues 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.- Detect
Document Text Request - Detect
Document Text Response - Document
The input document, either as bytes or as an S3 object.
You pass image bytes to an Amazon Textract API operation by using the
Bytesproperty. For example, you would use theBytesproperty to pass a document loaded from a local file system. Image bytes passed by using theBytesproperty 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
S3Objectproperty. 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.
- Document
Location 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.
- Document
Metadata Information about the input document.
- Geometry
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
- GetDocument
Analysis Request - GetDocument
Analysis Response - GetDocument
Text Detection Request - GetDocument
Text Detection Response - Human
Loop Activation Output Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.
- Human
Loop Config 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.
- Human
Loop Data Attributes Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information and adult content.
- Notification
Channel The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation, such as StartDocumentTextDetection.
- Output
Config 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.
- Point
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
Pointobjects,Polygon, is returned by DetectDocumentText.Polygonrepresents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.- Relationship
Information about how blocks are related to each other. A
Blockobject contains 0 or moreRelationobjects in a list,Relationships. For more information, see Block.The
Typeelement provides the type of the relationship for all blocks in theIDsarray.- S3Object
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.
- Start
Document Analysis Request - Start
Document Analysis Response - Start
Document Text Detection Request - Start
Document Text Detection Response - Textract
Client - A client for the Amazon Textract API.
- Warning
A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).
Enums§
- Analyze
Document Error - Errors returned by AnalyzeDocument
- Detect
Document Text Error - Errors returned by DetectDocumentText
- GetDocument
Analysis Error - Errors returned by GetDocumentAnalysis
- GetDocument
Text Detection Error - Errors returned by GetDocumentTextDetection
- Start
Document Analysis Error - Errors returned by StartDocumentAnalysis
- Start
Document Text Detection Error - Errors returned by StartDocumentTextDetection
Traits§
- Textract
- Trait representing the capabilities of the Amazon Textract API. Amazon Textract clients implement this trait.