Document document
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are
passed using the Bytes field.
List<E> featureTypes
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that
are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis,
add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in
the response (including text that isn't related to the value of FeatureTypes).
HumanLoopConfig humanLoopConfig
Sets the configuration for the human in the loop workflow for analyzing documents.
DocumentMetadata documentMetadata
Metadata about the analyzed document. An example is the number of pages.
List<E> blocks
The items that are detected and analyzed by AnalyzeDocument.
HumanLoopActivationOutput humanLoopActivationOutput
Shows the results of the human in the loop evaluation.
String analyzeDocumentModelVersion
The version of the model used to analyze the document.
Document document
DocumentMetadata documentMetadata
List<E> expenseDocuments
The expenses detected by Amazon Textract.
String blockType
The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a
document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY
Block object or a VALUE Block object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's
detected on a document page. Use the value of SelectionStatus to determine the status of the
selection element.
Float confidence
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
String text
The word or line of text that's recognized by Amazon Textract.
String textType
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
Integer rowIndex
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by
DetectDocumentText and GetDocumentTextDetection.
Integer columnIndex
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned
by DetectDocumentText and GetDocumentTextDetection.
Integer rowSpan
The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned
is greater than 1. RowSpan isn't returned by DetectDocumentText and
GetDocumentTextDetection.
Integer columnSpan
The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns
spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and
GetDocumentTextDetection.
Geometry geometry
The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
String id
The identifier for the recognized text. The identifier is only unique for a single operation.
List<E> relationships
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
0 - The block has no child blocks.
1 - The block has child blocks.
List<E> entityTypes
The type of entity. The following can be returned:
KEY - An identifier for a field on the document.
VALUE - The field text.
EntityTypes isn't returned by DetectDocumentText and
GetDocumentTextDetection.
String selectionStatus
The selection status of a selection element, such as an option button or check box.
Integer page
The page on which a block was detected. Page is returned by asynchronous operations. Page values
greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even
if it contains multiple document pages, is considered to be a single-page document. The value of
Page is always 1. Synchronous operations don't return Page because every input document
is considered to be a single-page document.
Float width
The width of the bounding box as a ratio of the overall document page width.
Float height
The height of the bounding box as a ratio of the overall document page height.
Float left
The left coordinate of the bounding box as a ratio of overall document page width.
Float top
The top coordinate of the bounding box as a ratio of overall document page height.
Document document
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are
passed using the Bytes field.
DocumentMetadata documentMetadata
Metadata about the document. It contains the number of pages that are detected in the document.
List<E> blocks
An array of Block objects that contain the text that's detected in the document.
String detectDocumentTextModelVersion
ByteBuffer bytes
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 s3Object
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
S3Object s3Object
The Amazon S3 bucket that contains the input document.
Integer pages
The number of pages that are detected in the document.
Integer expenseIndex
Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.
List<E> summaryFields
Any information found outside of a table by Amazon Textract.
List<E> lineItemGroups
Information detected on each table of a document, seperated into LineItems.
ExpenseType type
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
ExpenseDetection labelDetection
The explicitly stated label of a detected element.
ExpenseDetection valueDetection
The value of a detected element. Present in explicit and implicit elements.
Integer pageNumber
The page number the value was detected on.
BoundingBox boundingBox
An axis-aligned coarse representation of the location of the recognized item on the document page.
List<E> polygon
Within the bounding box, a fine-grained polygon around the recognized item.
String jobId
A unique identifier for the text-detection job. The JobId is returned from
StartDocumentAnalysis. A JobId value is only valid for 7 days.
Integer maxResults
The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
String nextToken
If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
DocumentMetadata documentMetadata
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every
page of paginated responses from an Amazon Textract video operation.
String jobStatus
The current status of the text detection job.
String nextToken
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
List<E> blocks
The results of the text-analysis operation.
List<E> warnings
A list of warnings that occurred during the document-analysis operation.
String statusMessage
Returns if the detection job could not be completed. Contains explanation for what error occured.
String analyzeDocumentModelVersion
String jobId
A unique identifier for the text detection job. The JobId is returned from
StartDocumentTextDetection. A JobId value is only valid for 7 days.
Integer maxResults
The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
String nextToken
If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
DocumentMetadata documentMetadata
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every
page of paginated responses from an Amazon Textract video operation.
String jobStatus
The current status of the text detection job.
String nextToken
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.
List<E> blocks
The results of the text-detection operation.
List<E> warnings
A list of warnings that occurred during the text-detection operation for the document.
String statusMessage
Returns if the detection job could not be completed. Contains explanation for what error occured.
String detectDocumentTextModelVersion
String humanLoopArn
The Amazon Resource Name (ARN) of the HumanLoop created.
List<E> humanLoopActivationReasons
Shows if and why human review was needed.
String humanLoopActivationConditionsEvaluationResults
Shows the result of condition evaluations, including those conditions which activated a human review.
String humanLoopName
The name of the human workflow used for this image. This should be kept unique within a region.
String flowDefinitionArn
The Amazon Resource Name (ARN) of the flow definition.
HumanLoopDataAttributes dataAttributes
Sets attributes of the input data.
String type
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be
VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the
VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs
that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of
Selection Elements.
List<E> ids
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
String bucket
The name of the S3 bucket. Note that the # character is not valid in the file name.
String name
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 format files.
String version
If the bucket has versioning enabled, you can specify the object version.
DocumentLocation documentLocation
The location of the document to be processed.
List<E> featureTypes
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that
are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis,
add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in
the response (including text that isn't related to the value of FeatureTypes).
String clientRequestToken
The idempotent token that you use to identify the start request. If you use the same token with multiple
StartDocumentAnalysis 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.
String jobTag
An identifier that 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 notificationChannel
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
OutputConfig 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 GetDocumentAnalysis operation.
String 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.
String jobId
The identifier for the document text detection job. Use JobId to identify the job in a subsequent
call to GetDocumentAnalysis. A JobId value is only valid for 7 days.
DocumentLocation documentLocation
The location of the document to be processed.
String clientRequestToken
The idempotent token that's used to identify the start request. If you use the same token with multiple
StartDocumentTextDetection 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.
String jobTag
An identifier that 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 notificationChannel
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
OutputConfig outputConfig
Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.
String 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.
String jobId
The identifier of the text detection job for the document. Use JobId to identify the job in a
subsequent call to GetDocumentTextDetection. A JobId value is only valid for 7 days.
Copyright © 2021. All rights reserved.