Sets the configuration for the human in the loop workflow for analyzing documents.

Contains Queries and the alias for those Queries, as determined by the input.

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, PNG, PDF, or TIFF 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.

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. Add SIGNATURES to return the locations of detected signatures. To perform both forms and table analysis, add TABLES and FORMS to FeatureTypes. To detect signatures within form data and table data, add SIGNATURES to either TABLES or FORMS. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

The version of the model used to analyze the document.

The items that are detected and analyzed by AnalyzeDocument.

Metadata about the analyzed document. An example is the number of pages.

Shows the results of the human in the loop evaluation.

The response's http status code.

Undocumented member.

Undocumented member.

The expenses detected by Amazon Textract.

The response's http status code.

The document being passed to AnalyzeID.

The version of the AnalyzeIdentity API being used to process documents.

Undocumented member.

The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.

The response's http status code.

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.

An array of Block objects that contain the text that's detected in the document.

Metadata about the document. It contains the number of pages that are detected in the document.

The response's http status code.

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.

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.

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

The results of the text-analysis operation.

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

The current status of the text detection job.

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.

Returns if the detection job could not be completed. Contains explanation for what error occured.

A list of warnings that occurred during the document-analysis operation.

The response's http status code.

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.

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.

A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection. A JobId value is only valid for 7 days.

The results of the text-detection operation.

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

The current status of the text detection job.

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.

Returns if the detection job could not be completed. Contains explanation for what error occured.

A list of warnings that occurred during the text-detection operation for the document.

The response's http status code.

The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.

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.

A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

The current model version of AnalyzeExpense.

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.

The expenses detected by Amazon Textract.

The current status of the text detection job.

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.

Returns if the detection job could not be completed. Contains explanation for what error occured.

A list of warnings that occurred during the text-detection operation for the document.

The response's http status code.

The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.

If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.

A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.

The current model version of the Analyze Lending API.

Undocumented member.

The current status of the lending analysis job.

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 lending results.

Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.

Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.

A list of warnings that occurred during the lending analysis operation.

The response's http status code.

A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.

The current model version of the Analyze Lending API.

Undocumented member.

The current status of the lending analysis job.

Returns if the lending analysis could not be completed. Contains explanation for what error occurred.

Contains summary information for documents grouped by type.

A list of warnings that occurred during the lending analysis operation.

The response's http status code.

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.

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).

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.

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

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.

Undocumented member.

The location of the document to be processed.

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).

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.

The response's http status code.

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.

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).

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.

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

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.

The location of the document to be processed.

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.

The response's http status code.

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

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).

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.

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

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 GetExpenseAnalysis operation.

The location of the document to be processed.

A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

The response's http status code.

The idempotent token that you use to identify the start request. If you use the same token with multiple StartLendingAnalysis 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.

An identifier that you specify to be 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).

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.

Undocumented member.

Undocumented member.

Undocumented member.

A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.

The response's http status code.

The confidence score of the detected text.

Only returned for dates, returns the type of value detected and the date written in a more machine readable way.

Text of either the normalized field or value associated with it.

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.
• SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
• QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
• QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

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.

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.

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.

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.

The identifier for the recognized text. The identifier is only unique for a single operation.

The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an asynchronous operation, even if it contains multiple document pages, is considered a single-page document. This means that for scanned images the value of Page is always 1. Synchronous operations operations will also return a Page value of 1 because every input document is considered to be a single-page document.

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.

The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

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.

The selection status of a selection element, such as an option button or check box.

The word or line of text that's recognized by Amazon Textract.

The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

The height of the bounding box as a ratio of the overall document page height.

The left coordinate of the bounding box as a ratio of overall document page width.

The top coordinate of the bounding box as a ratio of overall document page height.

The width of the bounding box as a ratio of the overall document page width.

The page a detected signature was found on.

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.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

A list of the detected signatures found in a document group.

An array that contains information about the pages of a document, defined by logical boundary.

The type of document that Amazon Textract has detected. See LINK for a list of all types returned by Textract.

A list of any expected signatures not found in a document group.

The Amazon S3 bucket that contains the input document.

The number of pages that are detected in the document.

Currency code for detected currency. the current supported codes are:

• USD
• EUR
• GBP
• CAD
• INR
• JPY
• CHF
• AUD
• CNY
• BZR
• SEK
• HKD

Percentage confideence in the detected currency.

The confidence in detection, as a percentage

Undocumented member.

The word or line of text recognized by Amazon Textract

This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.

Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.

Information detected on each table of a document, seperated into LineItems.

Any information found outside of a table by Amazon Textract.

Shows the kind of currency, both the code and confidence associated with any monatary value detected.

Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

The explicitly stated label of a detected element.

The page number the value was detected on.

The implied label of a detected element. Present alongside LabelDetection for explicit elements.

The value of a detected element. Present in explicit and implicit elements.

Provides a group Id number, which will be the same for each in the group.

Informs you on whether the expense group is a name or an address.

The confidence of accuracy, as a percentage.

The word or line of text detected by Amazon Textract.

Undocumented member.

Undocumented member.

Holds the structured data returned by AnalyzeDocument for lending documents.

An axis-aligned coarse representation of the location of the recognized item on the document page.

Within the bounding box, a fine-grained polygon around the recognized item.

Shows the result of condition evaluations, including those conditions which activated a human review.

Shows if and why human review was needed.

The Amazon Resource Name (ARN) of the HumanLoop created.

Sets attributes of the input data.

The name of the human workflow used for this image. This should be kept unique within a region.

The Amazon Resource Name (ARN) of the flow definition.

Sets whether the input image is free of personally identifiable information or adult content.

Individual word recognition, as returned by document detection.

Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

Undocumented member.

Undocumented member.

The confidence level for the text of a detected value in a lending document.

Undocumented member.

The selection status of a selection element, such as an option button or check box.

The text extracted for a detected value in a lending document.

An array of LendingField objects.

A list of signatures detected in a lending document.

Undocumented member.

The type of the lending document.

An array of LendingDetection objects.

An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .

The page number for a page, with regard to whole submission.

The classifier result for a given page.

Contains an array of all DocumentGroup objects.

UndetectedDocumentTypes.

ExpenseFields used to show information from detected lines on a table.

The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.

The breakdown of information on a particular line of a table.

The value of the date, written as Year-Month-DayTHour:Minute:Second.

The normalized type of the value detected. In this case, DATE.

The Amazon SNS topic that Amazon Textract posts the completion status to.

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

The name of the bucket your output will go to.

The class, or document type, assigned to a detected Page object. The class, or document type, assigned to a detected Page object.

The page number the value was detected on, relative to Amazon Textract's starting position.

The value of the X coordinate for a point on a Polygon.

The value of the Y coordinate for a point on a Polygon.

Amazon Textract's confidence in its predicted value.

The predicted value of a detected object.

Alias attached to the query, for ease of location.

Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

• If a page is not specified, it is set to ["1"] by default.
• The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
• When using * to indicate all pages, it must be the only element in the list.
• You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document.
• Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"

An array of IDs for related blocks. You can get the type of the relationship from the Type element.

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.

The name of the S3 bucket. Note that the # character is not valid in the file 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 and TIFF format files.

If the bucket has versioning enabled, you can specify the object version.

The confidence, from 0 to 100, in the predicted values for a detected signature.

Undocumented member.

The index for a given document in a DocumentGroup of a specific Type.

An array of page numbers for a for a given document, ordered by logical boundary.

The page where a signature was expected but not found.

The error code for the warning.

A list of the pages that the warning applies to.