Amazon Textract 2018-06-27
- Client: Aws\Textract\TextractClient
- Service ID: textract
- Version: 2018-06-27
This page describes the parameters and results for the operations of the Amazon Textract (2018-06-27), and shows how to use the Aws\Textract\TextractClient object to call the described operations. This documentation is specific to the 2018-06-27 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AnalyzeDocument ( array $params = [] )
Analyzes an input document for relationships between detected items.
- AnalyzeExpense ( array $params = [] )
AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.
- AnalyzeID ( array $params = [] )
Analyzes identity documents for relevant information.
- DetectDocumentText ( array $params = [] )
Detects text in the input document.
- GetDocumentAnalysis ( array $params = [] )
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
- GetDocumentTextDetection ( array $params = [] )
Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
- GetExpenseAnalysis ( array $params = [] )
Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.
- GetLendingAnalysis ( array $params = [] )
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.
- GetLendingAnalysisSummary ( array $params = [] )
Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document.
- StartDocumentAnalysis ( array $params = [] )
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
- StartDocumentTextDetection ( array $params = [] )
Starts the asynchronous detection of text in a document.
- StartExpenseAnalysis ( array $params = [] )
Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
- StartLendingAnalysis ( array $params = [] )
Starts the classification and analysis of an input document.
Operations
AnalyzeDocument
$result = $client->analyzeDocument([/* ... */]); $promise = $client->analyzeDocumentAsync([/* ... */]);
Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
-
Form data (key-value pairs). The related information is returned in two Block objects, each of type
KEY_VALUE_SET: a KEYBlockobject and a VALUEBlockobject. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. -
Table and table cell data. A TABLE
Blockobject contains information about a detected table. A CELLBlockobject is returned for each cell in a table. -
Lines and words of text. A LINE
Blockobject contains one or more WORDBlockobjects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value ofFeatureTypes). -
Signatures. A SIGNATURE
Blockobject contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table. -
Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
-
Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.
You can choose which type of analysis to perform by specifying the FeatureTypes list.
The output is returned in a list of Block objects.
AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.
For more information, see Document Text Analysis.
Parameter Syntax
$result = $client->analyzeDocument([
'Document' => [ // REQUIRED
'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
'S3Object' => [
'Bucket' => '<string>',
'Name' => '<string>',
'Version' => '<string>',
],
],
'FeatureTypes' => ['<string>', ...], // REQUIRED
'HumanLoopConfig' => [
'DataAttributes' => [
'ContentClassifiers' => ['<string>', ...],
],
'FlowDefinitionArn' => '<string>', // REQUIRED
'HumanLoopName' => '<string>', // REQUIRED
],
'QueriesConfig' => [
'Queries' => [ // REQUIRED
[
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>', // REQUIRED
],
// ...
],
],
]);
Parameter Details
Members
- Document
-
- Required: Yes
- Type: Document structure
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
Bytesfield. - FeatureTypes
-
- Required: Yes
- Type: Array of strings
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 ofFeatureTypes). - HumanLoopConfig
-
- Type: HumanLoopConfig structure
Sets the configuration for the human in the loop workflow for analyzing documents.
- QueriesConfig
-
- Type: QueriesConfig structure
Contains Queries and the alias for those Queries, as determined by the input.
Result Syntax
[
'AnalyzeDocumentModelVersion' => '<string>',
'Blocks' => [
[
'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE',
'ColumnIndex' => <integer>,
'ColumnSpan' => <integer>,
'Confidence' => <float>,
'EntityTypes' => ['<string>', ...],
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Id' => '<string>',
'Page' => <integer>,
'Query' => [
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>',
],
'Relationships' => [
[
'Ids' => ['<string>', ...],
'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER',
],
// ...
],
'RowIndex' => <integer>,
'RowSpan' => <integer>,
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
'TextType' => 'HANDWRITING|PRINTED',
],
// ...
],
'DocumentMetadata' => [
'Pages' => <integer>,
],
'HumanLoopActivationOutput' => [
'HumanLoopActivationConditionsEvaluationResults' => '<string>',
'HumanLoopActivationReasons' => ['<string>', ...],
'HumanLoopArn' => '<string>',
],
]
Result Details
Members
- AnalyzeDocumentModelVersion
-
- Type: string
The version of the model used to analyze the document.
- Blocks
-
- Type: Array of Block structures
The items that are detected and analyzed by
AnalyzeDocument. - DocumentMetadata
-
- Type: DocumentMetadata structure
Metadata about the analyzed document. An example is the number of pages.
- HumanLoopActivationOutput
-
- Type: HumanLoopActivationOutput structure
Shows the results of the human in the loop evaluation.
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
-
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
Amazon Textract experienced a service issue. Try your call again.
-
Amazon Textract is temporarily unable to process the request. Try your call again.
-
HumanLoopQuotaExceededException:
Indicates you have exceeded the maximum number of active human in the loop workflows available
AnalyzeExpense
$result = $client->analyzeExpense([/* ... */]); $promise = $client->analyzeExpenseAsync([/* ... */]);
AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.
Information is returned as ExpenseDocuments and seperated as follows:
-
LineItemGroups- A data set containingLineItemswhich store information about the lines of text, such as an item purchased and its price on a receipt. -
SummaryFields- Contains all other information a receipt, such as header information or the vendors name.
Parameter Syntax
$result = $client->analyzeExpense([
'Document' => [ // REQUIRED
'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
'S3Object' => [
'Bucket' => '<string>',
'Name' => '<string>',
'Version' => '<string>',
],
],
]);
Parameter Details
Members
- Document
-
- Required: Yes
- Type: Document structure
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.
Result Syntax
[
'DocumentMetadata' => [
'Pages' => <integer>,
],
'ExpenseDocuments' => [
[
'Blocks' => [
[
'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE',
'ColumnIndex' => <integer>,
'ColumnSpan' => <integer>,
'Confidence' => <float>,
'EntityTypes' => ['<string>', ...],
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Id' => '<string>',
'Page' => <integer>,
'Query' => [
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>',
],
'Relationships' => [
[
'Ids' => ['<string>', ...],
'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER',
],
// ...
],
'RowIndex' => <integer>,
'RowSpan' => <integer>,
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
'TextType' => 'HANDWRITING|PRINTED',
],
// ...
],
'ExpenseIndex' => <integer>,
'LineItemGroups' => [
[
'LineItemGroupIndex' => <integer>,
'LineItems' => [
[
'LineItemExpenseFields' => [
[
'Currency' => [
'Code' => '<string>',
'Confidence' => <float>,
],
'GroupProperties' => [
[
'Id' => '<string>',
'Types' => ['<string>', ...],
],
// ...
],
'LabelDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
'PageNumber' => <integer>,
'Type' => [
'Confidence' => <float>,
'Text' => '<string>',
],
'ValueDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
],
// ...
],
],
// ...
],
],
// ...
],
'SummaryFields' => [
[
'Currency' => [
'Code' => '<string>',
'Confidence' => <float>,
],
'GroupProperties' => [
[
'Id' => '<string>',
'Types' => ['<string>', ...],
],
// ...
],
'LabelDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
'PageNumber' => <integer>,
'Type' => [
'Confidence' => <float>,
'Text' => '<string>',
],
'ValueDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
],
// ...
],
],
// ...
],
]
Result Details
Members
- DocumentMetadata
-
- Type: DocumentMetadata structure
Information about the input document.
- ExpenseDocuments
-
- Type: Array of ExpenseDocument structures
The expenses detected by Amazon Textract.
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
-
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
Amazon Textract experienced a service issue. Try your call again.
-
Amazon Textract is temporarily unable to process the request. Try your call again.
AnalyzeID
$result = $client->analyzeID([/* ... */]); $promise = $client->analyzeIDAsync([/* ... */]);
Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text.Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data.
Parameter Syntax
$result = $client->analyzeID([
'DocumentPages' => [ // REQUIRED
[
'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
'S3Object' => [
'Bucket' => '<string>',
'Name' => '<string>',
'Version' => '<string>',
],
],
// ...
],
]);
Parameter Details
Members
- DocumentPages
-
- Required: Yes
- Type: Array of Document structures
The document being passed to AnalyzeID.
Result Syntax
[
'AnalyzeIDModelVersion' => '<string>',
'DocumentMetadata' => [
'Pages' => <integer>,
],
'IdentityDocuments' => [
[
'Blocks' => [
[
'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE',
'ColumnIndex' => <integer>,
'ColumnSpan' => <integer>,
'Confidence' => <float>,
'EntityTypes' => ['<string>', ...],
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Id' => '<string>',
'Page' => <integer>,
'Query' => [
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>',
],
'Relationships' => [
[
'Ids' => ['<string>', ...],
'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER',
],
// ...
],
'RowIndex' => <integer>,
'RowSpan' => <integer>,
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
'TextType' => 'HANDWRITING|PRINTED',
],
// ...
],
'DocumentIndex' => <integer>,
'IdentityDocumentFields' => [
[
'Type' => [
'Confidence' => <float>,
'NormalizedValue' => [
'Value' => '<string>',
'ValueType' => 'DATE',
],
'Text' => '<string>',
],
'ValueDetection' => [
'Confidence' => <float>,
'NormalizedValue' => [
'Value' => '<string>',
'ValueType' => 'DATE',
],
'Text' => '<string>',
],
],
// ...
],
],
// ...
],
]
Result Details
Members
- AnalyzeIDModelVersion
-
- Type: string
The version of the AnalyzeIdentity API being used to process documents.
- DocumentMetadata
-
- Type: DocumentMetadata structure
Information about the input document.
- IdentityDocuments
-
- Type: Array of IdentityDocument structures
The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
-
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
Amazon Textract experienced a service issue. Try your call again.
-
Amazon Textract is temporarily unable to process the request. Try your call again.
DetectDocumentText
$result = $client->detectDocumentText([/* ... */]); $promise = $client->detectDocumentTextAsync([/* ... */]);
Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects.
Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.
DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.
For more information, see Document Text Detection.
Parameter Syntax
$result = $client->detectDocumentText([
'Document' => [ // REQUIRED
'Bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
'S3Object' => [
'Bucket' => '<string>',
'Name' => '<string>',
'Version' => '<string>',
],
],
]);
Parameter Details
Members
- Document
-
- Required: Yes
- Type: Document structure
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
Bytesfield.
Result Syntax
[
'Blocks' => [
[
'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE',
'ColumnIndex' => <integer>,
'ColumnSpan' => <integer>,
'Confidence' => <float>,
'EntityTypes' => ['<string>', ...],
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Id' => '<string>',
'Page' => <integer>,
'Query' => [
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>',
],
'Relationships' => [
[
'Ids' => ['<string>', ...],
'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER',
],
// ...
],
'RowIndex' => <integer>,
'RowSpan' => <integer>,
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
'TextType' => 'HANDWRITING|PRINTED',
],
// ...
],
'DetectDocumentTextModelVersion' => '<string>',
'DocumentMetadata' => [
'Pages' => <integer>,
],
]
Result Details
Members
- Blocks
-
- Type: Array of Block structures
An array of
Blockobjects that contain the text that's detected in the document. - DetectDocumentTextModelVersion
-
- Type: string
- DocumentMetadata
-
- Type: DocumentMetadata structure
Metadata about the document. It contains the number of pages that are detected in the document.
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
-
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
Amazon Textract experienced a service issue. Try your call again.
-
Amazon Textract is temporarily unable to process the request. Try your call again.
GetDocumentAnalysis
$result = $client->getDocumentAnalysis([/* ... */]); $promise = $client->getDocumentAnalysisAsync([/* ... */]);
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.
GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:
-
Form data (key-value pairs). The related information is returned in two Block objects, each of type
KEY_VALUE_SET: a KEYBlockobject and a VALUEBlockobject. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. -
Table and table cell data. A TABLE
Blockobject contains information about a detected table. A CELLBlockobject is returned for each cell in a table. -
Lines and words of text. A LINE
Blockobject contains one or more WORDBlockobjects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of theStartDocumentAnalysisFeatureTypesinput parameter). -
Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
-
Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.
While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist.
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.
Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis.
For more information, see Document Text Analysis.
Parameter Syntax
$result = $client->getDocumentAnalysis([
'JobId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- JobId
-
- Required: Yes
- Type: string
A unique identifier for the text-detection job. The
JobIdis returned fromStartDocumentAnalysis. AJobIdvalue is only valid for 7 days. - MaxResults
-
- Type: int
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.
- NextToken
-
- Type: string
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.
Result Syntax
[
'AnalyzeDocumentModelVersion' => '<string>',
'Blocks' => [
[
'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE',
'ColumnIndex' => <integer>,
'ColumnSpan' => <integer>,
'Confidence' => <float>,
'EntityTypes' => ['<string>', ...],
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Id' => '<string>',
'Page' => <integer>,
'Query' => [
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>',
],
'Relationships' => [
[
'Ids' => ['<string>', ...],
'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER',
],
// ...
],
'RowIndex' => <integer>,
'RowSpan' => <integer>,
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
'TextType' => 'HANDWRITING|PRINTED',
],
// ...
],
'DocumentMetadata' => [
'Pages' => <integer>,
],
'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED|PARTIAL_SUCCESS',
'NextToken' => '<string>',
'StatusMessage' => '<string>',
'Warnings' => [
[
'ErrorCode' => '<string>',
'Pages' => [<integer>, ...],
],
// ...
],
]
Result Details
Members
- AnalyzeDocumentModelVersion
-
- Type: string
- Blocks
-
- Type: Array of Block structures
The results of the text-analysis operation.
- DocumentMetadata
-
- Type: DocumentMetadata structure
Information about a document that Amazon Textract processed.
DocumentMetadatais returned in every page of paginated responses from an Amazon Textract video operation. - JobStatus
-
- Type: string
The current status of the text detection job.
- NextToken
-
- Type: string
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.
- StatusMessage
-
- Type: string
Returns if the detection job could not be completed. Contains explanation for what error occured.
- Warnings
-
- Type: Array of Warning structures
A list of warnings that occurred during the document-analysis operation.
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
An invalid job identifier was passed to an asynchronous analysis operation.
-
Amazon Textract experienced a service issue. Try your call again.
-
Amazon Textract is temporarily unable to process the request. Try your call again.
-
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
GetDocumentTextDetection
$result = $client->getDocumentTextDetection([/* ... */]); $promise = $client->getDocumentTextDetectionAsync([/* ... */]);
Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.
GetDocumentTextDetection returns an array of Block objects.
Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.
Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentTextDetection.
For more information, see Document Text Detection.
Parameter Syntax
$result = $client->getDocumentTextDetection([
'JobId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- JobId
-
- Required: Yes
- Type: string
A unique identifier for the text detection job. The
JobIdis returned fromStartDocumentTextDetection. AJobIdvalue is only valid for 7 days. - MaxResults
-
- Type: int
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.
- NextToken
-
- Type: string
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.
Result Syntax
[
'Blocks' => [
[
'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE',
'ColumnIndex' => <integer>,
'ColumnSpan' => <integer>,
'Confidence' => <float>,
'EntityTypes' => ['<string>', ...],
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Id' => '<string>',
'Page' => <integer>,
'Query' => [
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>',
],
'Relationships' => [
[
'Ids' => ['<string>', ...],
'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER',
],
// ...
],
'RowIndex' => <integer>,
'RowSpan' => <integer>,
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
'TextType' => 'HANDWRITING|PRINTED',
],
// ...
],
'DetectDocumentTextModelVersion' => '<string>',
'DocumentMetadata' => [
'Pages' => <integer>,
],
'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED|PARTIAL_SUCCESS',
'NextToken' => '<string>',
'StatusMessage' => '<string>',
'Warnings' => [
[
'ErrorCode' => '<string>',
'Pages' => [<integer>, ...],
],
// ...
],
]
Result Details
Members
- Blocks
-
- Type: Array of Block structures
The results of the text-detection operation.
- DetectDocumentTextModelVersion
-
- Type: string
- DocumentMetadata
-
- Type: DocumentMetadata structure
Information about a document that Amazon Textract processed.
DocumentMetadatais returned in every page of paginated responses from an Amazon Textract video operation. - JobStatus
-
- Type: string
The current status of the text detection job.
- NextToken
-
- Type: string
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.
- StatusMessage
-
- Type: string
Returns if the detection job could not be completed. Contains explanation for what error occured.
- Warnings
-
- Type: Array of Warning structures
A list of warnings that occurred during the text-detection operation for the document.
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
An invalid job identifier was passed to an asynchronous analysis operation.
-
Amazon Textract experienced a service issue. Try your call again.
-
Amazon Textract is temporarily unable to process the request. Try your call again.
-
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
GetExpenseAnalysis
$result = $client->getExpenseAnalysis([/* ... */]); $promise = $client->getExpenseAnalysisAsync([/* ... */]);
Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.
You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the initial call to StartExpenseAnalysis.
Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetExpenseAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetExpenseAnalysis.
For more information, see Analyzing Invoices and Receipts.
Parameter Syntax
$result = $client->getExpenseAnalysis([
'JobId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- JobId
-
- Required: Yes
- Type: string
A unique identifier for the text detection job. The
JobIdis returned fromStartExpenseAnalysis. AJobIdvalue is only valid for 7 days. - MaxResults
-
- Type: int
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.
- NextToken
-
- Type: string
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.
Result Syntax
[
'AnalyzeExpenseModelVersion' => '<string>',
'DocumentMetadata' => [
'Pages' => <integer>,
],
'ExpenseDocuments' => [
[
'Blocks' => [
[
'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE',
'ColumnIndex' => <integer>,
'ColumnSpan' => <integer>,
'Confidence' => <float>,
'EntityTypes' => ['<string>', ...],
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Id' => '<string>',
'Page' => <integer>,
'Query' => [
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>',
],
'Relationships' => [
[
'Ids' => ['<string>', ...],
'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER',
],
// ...
],
'RowIndex' => <integer>,
'RowSpan' => <integer>,
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
'TextType' => 'HANDWRITING|PRINTED',
],
// ...
],
'ExpenseIndex' => <integer>,
'LineItemGroups' => [
[
'LineItemGroupIndex' => <integer>,
'LineItems' => [
[
'LineItemExpenseFields' => [
[
'Currency' => [
'Code' => '<string>',
'Confidence' => <float>,
],
'GroupProperties' => [
[
'Id' => '<string>',
'Types' => ['<string>', ...],
],
// ...
],
'LabelDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
'PageNumber' => <integer>,
'Type' => [
'Confidence' => <float>,
'Text' => '<string>',
],
'ValueDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
],
// ...
],
],
// ...
],
],
// ...
],
'SummaryFields' => [
[
'Currency' => [
'Code' => '<string>',
'Confidence' => <float>,
],
'GroupProperties' => [
[
'Id' => '<string>',
'Types' => ['<string>', ...],
],
// ...
],
'LabelDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
'PageNumber' => <integer>,
'Type' => [
'Confidence' => <float>,
'Text' => '<string>',
],
'ValueDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
],
// ...
],
],
// ...
],
'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED|PARTIAL_SUCCESS',
'NextToken' => '<string>',
'StatusMessage' => '<string>',
'Warnings' => [
[
'ErrorCode' => '<string>',
'Pages' => [<integer>, ...],
],
// ...
],
]
Result Details
Members
- AnalyzeExpenseModelVersion
-
- Type: string
The current model version of AnalyzeExpense.
- DocumentMetadata
-
- Type: DocumentMetadata structure
Information about a document that Amazon Textract processed.
DocumentMetadatais returned in every page of paginated responses from an Amazon Textract operation. - ExpenseDocuments
-
- Type: Array of ExpenseDocument structures
The expenses detected by Amazon Textract.
- JobStatus
-
- Type: string
The current status of the text detection job.
- NextToken
-
- Type: string
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.
- StatusMessage
-
- Type: string
Returns if the detection job could not be completed. Contains explanation for what error occured.
- Warnings
-
- Type: Array of Warning structures
A list of warnings that occurred during the text-detection operation for the document.
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
An invalid job identifier was passed to an asynchronous analysis operation.
-
Amazon Textract experienced a service issue. Try your call again.
-
Amazon Textract is temporarily unable to process the request. Try your call again.
-
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
GetLendingAnalysis
$result = $client->getLendingAnalysis([/* ... */]); $promise = $client->getLendingAnalysisAsync([/* ... */]);
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.
You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartLendingAnalysis.
To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.
Parameter Syntax
$result = $client->getLendingAnalysis([
'JobId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- JobId
-
- Required: Yes
- Type: string
A unique identifier for the lending or text-detection job. The
JobIdis returned fromStartLendingAnalysis. AJobIdvalue is only valid for 7 days. - MaxResults
-
- Type: int
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.
- NextToken
-
- Type: string
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.
Result Syntax
[
'AnalyzeLendingModelVersion' => '<string>',
'DocumentMetadata' => [
'Pages' => <integer>,
],
'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED|PARTIAL_SUCCESS',
'NextToken' => '<string>',
'Results' => [
[
'Extractions' => [
[
'ExpenseDocument' => [
'Blocks' => [
[
'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE',
'ColumnIndex' => <integer>,
'ColumnSpan' => <integer>,
'Confidence' => <float>,
'EntityTypes' => ['<string>', ...],
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Id' => '<string>',
'Page' => <integer>,
'Query' => [
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>',
],
'Relationships' => [
[
'Ids' => ['<string>', ...],
'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER',
],
// ...
],
'RowIndex' => <integer>,
'RowSpan' => <integer>,
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
'TextType' => 'HANDWRITING|PRINTED',
],
// ...
],
'ExpenseIndex' => <integer>,
'LineItemGroups' => [
[
'LineItemGroupIndex' => <integer>,
'LineItems' => [
[
'LineItemExpenseFields' => [
[
'Currency' => [
'Code' => '<string>',
'Confidence' => <float>,
],
'GroupProperties' => [
[
'Id' => '<string>',
'Types' => ['<string>', ...],
],
// ...
],
'LabelDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
'PageNumber' => <integer>,
'Type' => [
'Confidence' => <float>,
'Text' => '<string>',
],
'ValueDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
],
// ...
],
],
// ...
],
],
// ...
],
'SummaryFields' => [
[
'Currency' => [
'Code' => '<string>',
'Confidence' => <float>,
],
'GroupProperties' => [
[
'Id' => '<string>',
'Types' => ['<string>', ...],
],
// ...
],
'LabelDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
'PageNumber' => <integer>,
'Type' => [
'Confidence' => <float>,
'Text' => '<string>',
],
'ValueDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Text' => '<string>',
],
],
// ...
],
],
'IdentityDocument' => [
'Blocks' => [
[
'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE',
'ColumnIndex' => <integer>,
'ColumnSpan' => <integer>,
'Confidence' => <float>,
'EntityTypes' => ['<string>', ...],
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'Id' => '<string>',
'Page' => <integer>,
'Query' => [
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>',
],
'Relationships' => [
[
'Ids' => ['<string>', ...],
'Type' => 'VALUE|CHILD|COMPLEX_FEATURES|MERGED_CELL|TITLE|ANSWER',
],
// ...
],
'RowIndex' => <integer>,
'RowSpan' => <integer>,
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
'TextType' => 'HANDWRITING|PRINTED',
],
// ...
],
'DocumentIndex' => <integer>,
'IdentityDocumentFields' => [
[
'Type' => [
'Confidence' => <float>,
'NormalizedValue' => [
'Value' => '<string>',
'ValueType' => 'DATE',
],
'Text' => '<string>',
],
'ValueDetection' => [
'Confidence' => <float>,
'NormalizedValue' => [
'Value' => '<string>',
'ValueType' => 'DATE',
],
'Text' => '<string>',
],
],
// ...
],
],
'LendingDocument' => [
'LendingFields' => [
[
'KeyDetection' => [
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
],
'Type' => '<string>',
'ValueDetections' => [
[
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
'SelectionStatus' => 'SELECTED|NOT_SELECTED',
'Text' => '<string>',
],
// ...
],
],
// ...
],
'SignatureDetections' => [
[
'Confidence' => <float>,
'Geometry' => [
'BoundingBox' => [
'Height' => <float>,
'Left' => <float>,
'Top' => <float>,
'Width' => <float>,
],
'Polygon' => [
[
'X' => <float>,
'Y' => <float>,
],
// ...
],
],
],
// ...
],
],
],
// ...
],
'Page' => <integer>,
'PageClassification' => [
'PageNumber' => [
[
'Confidence' => <float>,
'Value' => '<string>',
],
// ...
],
'PageType' => [
[
'Confidence' => <float>,
'Value' => '<string>',
],
// ...
],
],
],
// ...
],
'StatusMessage' => '<string>',
'Warnings' => [
[
'ErrorCode' => '<string>',
'Pages' => [<integer>, ...],
],
// ...
],
]
Result Details
Members
- AnalyzeLendingModelVersion
-
- Type: string
The current model version of the Analyze Lending API.
- DocumentMetadata
-
- Type: DocumentMetadata structure
Information about the input document.
- JobStatus
-
- Type: string
The current status of the lending analysis job.
- NextToken
-
- Type: string
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.
- Results
-
- Type: Array of LendingResult structures
Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.
- StatusMessage
-
- Type: string
Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.
- Warnings
-
- Type: Array of Warning structures
A list of warnings that occurred during the lending analysis operation.
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
An invalid job identifier was passed to an asynchronous analysis operation.
-
Amazon Textract experienced a service issue. Try your call again.
-
Amazon Textract is temporarily unable to process the request. Try your call again.
-
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
GetLendingAnalysisSummary
$result = $client->getLendingAnalysisSummary([/* ... */]); $promise = $client->getLendingAnalysisSummaryAsync([/* ... */]);
Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.
You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartLendingAnalysis.
To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysisSummary, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.
Parameter Syntax
$result = $client->getLendingAnalysisSummary([
'JobId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AnalyzeLendingModelVersion' => '<string>',
'DocumentMetadata' => [
'Pages' => <integer>,
],
'JobStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED|PARTIAL_SUCCESS',
'StatusMessage' => '<string>',
'Summary' => [
'DocumentGroups' => [
[
'DetectedSignatures' => [
[
'Page' => <integer>,
],
// ...
],
'SplitDocuments' => [
[
'Index' => <integer>,
'Pages' => [<integer>, ...],
],
// ...
],
'Type' => '<string>',
'UndetectedSignatures' => [
[
'Page' => <integer>,
],
// ...
],
],
// ...
],
'UndetectedDocumentTypes' => ['<string>', ...],
],
'Warnings' => [
[
'ErrorCode' => '<string>',
'Pages' => [<integer>, ...],
],
// ...
],
]
Result Details
Members
- AnalyzeLendingModelVersion
-
- Type: string
The current model version of the Analyze Lending API.
- DocumentMetadata
-
- Type: DocumentMetadata structure
Information about the input document.
- JobStatus
-
- Type: string
The current status of the lending analysis job.
- StatusMessage
-
- Type: string
Returns if the lending analysis could not be completed. Contains explanation for what error occurred.
- Summary
-
- Type: LendingSummary structure
Contains summary information for documents grouped by type.
- Warnings
-
- Type: Array of Warning structures
A list of warnings that occurred during the lending analysis operation.
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
An invalid job identifier was passed to an asynchronous analysis operation.
-
Amazon Textract experienced a service issue. Try your call again.
-
Amazon Textract is temporarily unable to process the request. Try your call again.
-
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
StartDocumentAnalysis
$result = $client->startDocumentAnalysis([/* ... */]); $promise = $client->startDocumentAnalysisAsync([/* ... */]);
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.
StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.
For more information, see Document Text Analysis.
Parameter Syntax
$result = $client->startDocumentAnalysis([
'ClientRequestToken' => '<string>',
'DocumentLocation' => [ // REQUIRED
'S3Object' => [
'Bucket' => '<string>',
'Name' => '<string>',
'Version' => '<string>',
],
],
'FeatureTypes' => ['<string>', ...], // REQUIRED
'JobTag' => '<string>',
'KMSKeyId' => '<string>',
'NotificationChannel' => [
'RoleArn' => '<string>', // REQUIRED
'SNSTopicArn' => '<string>', // REQUIRED
],
'OutputConfig' => [
'S3Bucket' => '<string>', // REQUIRED
'S3Prefix' => '<string>',
],
'QueriesConfig' => [
'Queries' => [ // REQUIRED
[
'Alias' => '<string>',
'Pages' => ['<string>', ...],
'Text' => '<string>', // REQUIRED
],
// ...
],
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
The idempotent token that you use to identify the start request. If you use the same token with multiple
StartDocumentAnalysisrequests, the sameJobIdis returned. UseClientRequestTokento prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations. - DocumentLocation
-
- Required: Yes
- Type: DocumentLocation structure
The location of the document to be processed.
- FeatureTypes
-
- Required: Yes
- Type: Array of strings
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 ofFeatureTypes). - JobTag
-
- Type: string
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use
JobTagto identify the type of document that the completion notification corresponds to (such as a tax form or a receipt). - KMSKeyId
-
- Type: string
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.
- NotificationChannel
-
- Type: NotificationChannel structure
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
- OutputConfig
-
- Type: OutputConfig structure
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.
- QueriesConfig
-
- Type: QueriesConfig structure
Result Syntax
[
'JobId' => '<string>',
]
Result Details
Members
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
-
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
-
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
Amazon Textract experienced a service issue. Try your call again.
-
IdempotentParameterMismatchException:
A
ClientRequestTokeninput parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation. -
Amazon Textract is temporarily unable to process the request. Try your call again.
-
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (
StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.
StartDocumentTextDetection
$result = $client->startDocumentTextDetection([/* ... */]); $promise = $client->startDocumentTextDetectionAsync([/* ... */]);
Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.
StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.
For more information, see Document Text Detection.
Parameter Syntax
$result = $client->startDocumentTextDetection([
'ClientRequestToken' => '<string>',
'DocumentLocation' => [ // REQUIRED
'S3Object' => [
'Bucket' => '<string>',
'Name' => '<string>',
'Version' => '<string>',
],
],
'JobTag' => '<string>',
'KMSKeyId' => '<string>',
'NotificationChannel' => [
'RoleArn' => '<string>', // REQUIRED
'SNSTopicArn' => '<string>', // REQUIRED
],
'OutputConfig' => [
'S3Bucket' => '<string>', // REQUIRED
'S3Prefix' => '<string>',
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
The idempotent token that's used to identify the start request. If you use the same token with multiple
StartDocumentTextDetectionrequests, the sameJobIdis returned. UseClientRequestTokento prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations. - DocumentLocation
-
- Required: Yes
- Type: DocumentLocation structure
The location of the document to be processed.
- JobTag
-
- Type: string
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use
JobTagto identify the type of document that the completion notification corresponds to (such as a tax form or a receipt). - KMSKeyId
-
- Type: string
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.
- NotificationChannel
-
- Type: NotificationChannel structure
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
- OutputConfig
-
- Type: OutputConfig structure
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.
Result Syntax
[
'JobId' => '<string>',
]
Result Details
Members
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
-
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
-
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
Amazon Textract experienced a service issue. Try your call again.
-
IdempotentParameterMismatchException:
A
ClientRequestTokeninput parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation. -
Amazon Textract is temporarily unable to process the request. Try your call again.
-
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (
StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.
StartExpenseAnalysis
$result = $client->startExpenseAnalysis([/* ... */]); $promise = $client->startExpenseAnalysisAsync([/* ... */]);
Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket.
StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis.
For more information, see Analyzing Invoices and Receipts.
Parameter Syntax
$result = $client->startExpenseAnalysis([
'ClientRequestToken' => '<string>',
'DocumentLocation' => [ // REQUIRED
'S3Object' => [
'Bucket' => '<string>',
'Name' => '<string>',
'Version' => '<string>',
],
],
'JobTag' => '<string>',
'KMSKeyId' => '<string>',
'NotificationChannel' => [
'RoleArn' => '<string>', // REQUIRED
'SNSTopicArn' => '<string>', // REQUIRED
],
'OutputConfig' => [
'S3Bucket' => '<string>', // REQUIRED
'S3Prefix' => '<string>',
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
The idempotent token that's used to identify the start request. If you use the same token with multiple
StartDocumentTextDetectionrequests, the sameJobIdis returned. UseClientRequestTokento prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations - DocumentLocation
-
- Required: Yes
- Type: DocumentLocation structure
The location of the document to be processed.
- JobTag
-
- Type: string
An identifier you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use
JobTagto identify the type of document that the completion notification corresponds to (such as a tax form or a receipt). - KMSKeyId
-
- Type: string
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.
- NotificationChannel
-
- Type: NotificationChannel structure
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
- OutputConfig
-
- Type: OutputConfig structure
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
GetExpenseAnalysisoperation.
Result Syntax
[
'JobId' => '<string>',
]
Result Details
Members
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
-
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
-
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
Amazon Textract experienced a service issue. Try your call again.
-
IdempotentParameterMismatchException:
A
ClientRequestTokeninput parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation. -
Amazon Textract is temporarily unable to process the request. Try your call again.
-
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (
StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.
StartLendingAnalysis
$result = $client->startLendingAnalysis([/* ... */]); $promise = $client->startLendingAnalysisAsync([/* ... */]);
Starts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket.
StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document.
StartLendingAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When the text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis.
If using OutputConfig to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories:
-
detailedResponse (contains the GetLendingAnalysis response)
-
summaryResponse (for the GetLendingAnalysisSummary response)
-
splitDocuments (documents split across logical boundaries)
Parameter Syntax
$result = $client->startLendingAnalysis([
'ClientRequestToken' => '<string>',
'DocumentLocation' => [ // REQUIRED
'S3Object' => [
'Bucket' => '<string>',
'Name' => '<string>',
'Version' => '<string>',
],
],
'JobTag' => '<string>',
'KMSKeyId' => '<string>',
'NotificationChannel' => [
'RoleArn' => '<string>', // REQUIRED
'SNSTopicArn' => '<string>', // REQUIRED
],
'OutputConfig' => [
'S3Bucket' => '<string>', // REQUIRED
'S3Prefix' => '<string>',
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
The idempotent token that you use to identify the start request. If you use the same token with multiple
StartLendingAnalysisrequests, the sameJobIdis returned. UseClientRequestTokento prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations. - DocumentLocation
-
- Required: Yes
- Type: DocumentLocation structure
The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.
The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.
- JobTag
-
- Type: string
An identifier that you specify to be included in the completion notification published to the Amazon SNS topic. For example, you can use
JobTagto identify the type of document that the completion notification corresponds to (such as a tax form or a receipt). - KMSKeyId
-
- Type: string
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.
- NotificationChannel
-
- Type: NotificationChannel structure
The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.
- OutputConfig
-
- Type: OutputConfig structure
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.
OutputConfigis an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. WithOutputConfigenabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set theKMSKeyIDparameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.
For more information on data privacy, see the Data Privacy FAQ.
Result Syntax
[
'JobId' => '<string>',
]
Result Details
Members
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again. -
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
-
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
-
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
-
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
Amazon Textract experienced a service issue. Try your call again.
-
IdempotentParameterMismatchException:
A
ClientRequestTokeninput parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation. -
Amazon Textract is temporarily unable to process the request. Try your call again.
-
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (
StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.
Shapes
AccessDeniedException
Description
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
Members
AnalyzeIDDetections
Description
Used to contain the information detected by an AnalyzeID operation.
Members
- Confidence
-
- Type: float
The confidence score of the detected text.
- NormalizedValue
-
- Type: NormalizedValue structure
Only returned for dates, returns the type of value detected and the date written in a more machine readable way.
- Text
-
- Required: Yes
- Type: string
Text of either the normalized field or value associated with it.
BadDocumentException
Description
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
Members
Block
Description
A 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.
Members
- BlockType
-
- Type: string
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
Blockobjects 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
Blockobjects that are detected on a document page. -
KEY_VALUE_SET - Stores the KEY and VALUE
Blockobjects for linked text that's detected on a document page. Use theEntityTypefield to determine if a KEY_VALUE_SET object is a KEYBlockobject or a VALUEBlockobject. -
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
SelectionStatusto 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.
- ColumnIndex
-
- Type: int
The column in which a table cell appears. The first column position is 1.
ColumnIndexisn't returned byDetectDocumentTextandGetDocumentTextDetection. - ColumnSpan
-
- Type: int
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.
ColumnSpanisn't returned byDetectDocumentTextandGetDocumentTextDetection. - Confidence
-
- Type: float
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.
- EntityTypes
-
- Type: Array of strings
The type of entity. The following can be returned:
-
KEY - An identifier for a field on the document.
-
VALUE - The field text.
EntityTypesisn't returned byDetectDocumentTextandGetDocumentTextDetection. - Geometry
-
- Type: Geometry structure
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.
- Id
-
- Type: string
The identifier for the recognized text. The identifier is only unique for a single operation.
- Page
-
- Type: int
The page on which a block was detected.
Pageis 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 ofPageis always 1. Synchronous operations operations will also return aPagevalue of 1 because every input document is considered to be a single-page document. - Query
-
- Type: Query structure
- Relationships
-
- Type: Array of Relationship structures
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.
- RowIndex
-
- Type: int
The row in which a table cell is located. The first row position is 1.
RowIndexisn't returned byDetectDocumentTextandGetDocumentTextDetection. - RowSpan
-
- Type: int
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.
RowSpanisn't returned byDetectDocumentTextandGetDocumentTextDetection. - SelectionStatus
-
- Type: string
The selection status of a selection element, such as an option button or check box.
- Text
-
- Type: string
The word or line of text that's recognized by Amazon Textract.
- TextType
-
- Type: string
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
BoundingBox
Description
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).
The top and 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).
The width and 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.
Members
- Height
-
- Type: float
The height of the bounding box as a ratio of the overall document page height.
- Left
-
- Type: float
The left coordinate of the bounding box as a ratio of overall document page width.
- Top
-
- Type: float
The top coordinate of the bounding box as a ratio of overall document page height.
- Width
-
- Type: float
The width of the bounding box as a ratio of the overall document page width.
DetectedSignature
Description
A structure that holds information regarding a detected signature on a page.
Members
Document
Description
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.
Members
- Bytes
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
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
Bytesfield. - S3Object
-
- Type: S3Object structure
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
DocumentGroup
Description
Summary information about documents grouped by the same document type.
Members
- DetectedSignatures
-
- Type: Array of DetectedSignature structures
A list of the detected signatures found in a document group.
- SplitDocuments
-
- Type: Array of SplitDocument structures
An array that contains information about the pages of a document, defined by logical boundary.
- Type
-
- Type: string
The type of document that Amazon Textract has detected. See LINK for a list of all types returned by Textract.
- UndetectedSignatures
-
- Type: Array of UndetectedSignature structures
A list of any expected signatures not found in a document group.
DocumentLocation
Description
The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.
The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.
Members
- S3Object
-
- Type: S3Object structure
The Amazon S3 bucket that contains the input document.
DocumentMetadata
Description
Information about the input document.
Members
DocumentTooLargeException
Description
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
Members
ExpenseCurrency
Description
Returns the kind of currency detected.
Members
ExpenseDetection
Description
An object used to store information about the Value or Label detected by Amazon Textract.
Members
- Confidence
-
- Type: float
The confidence in detection, as a percentage
- Geometry
-
- Type: Geometry structure
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
- Text
-
- Type: string
The word or line of text recognized by Amazon Textract
ExpenseDocument
Description
The structure holding all the information returned by AnalyzeExpense
Members
- Blocks
-
- Type: Array of Block structures
This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.
- ExpenseIndex
-
- Type: int
Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.
- LineItemGroups
-
- Type: Array of LineItemGroup structures
Information detected on each table of a document, seperated into
LineItems. - SummaryFields
-
- Type: Array of ExpenseField structures
Any information found outside of a table by Amazon Textract.
ExpenseField
Description
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
Members
- Currency
-
- Type: ExpenseCurrency structure
Shows the kind of currency, both the code and confidence associated with any monatary value detected.
- GroupProperties
-
- Type: Array of ExpenseGroupProperty structures
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.
- LabelDetection
-
- Type: ExpenseDetection structure
The explicitly stated label of a detected element.
- PageNumber
-
- Type: int
The page number the value was detected on.
- Type
-
- Type: ExpenseType structure
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
- ValueDetection
-
- Type: ExpenseDetection structure
The value of a detected element. Present in explicit and implicit elements.
ExpenseGroupProperty
Description
Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.
Members
ExpenseType
Description
An object used to store information about the Type detected by Amazon Textract.
Members
Extraction
Description
Contains information extracted by an analysis operation after using StartLendingAnalysis.
Members
- ExpenseDocument
-
- Type: ExpenseDocument structure
The structure holding all the information returned by AnalyzeExpense
- IdentityDocument
-
- Type: IdentityDocument structure
The structure that lists each document processed in an AnalyzeID operation.
- LendingDocument
-
- Type: LendingDocument structure
Holds the structured data returned by AnalyzeDocument for lending documents.
Geometry
Description
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
Members
- BoundingBox
-
- Type: BoundingBox structure
An axis-aligned coarse representation of the location of the recognized item on the document page.
- Polygon
-
- Type: Array of Point structures
Within the bounding box, a fine-grained polygon around the recognized item.
HumanLoopActivationOutput
Description
Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.
Members
- HumanLoopActivationConditionsEvaluationResults
-
- Type: string (string|number|array|map or anything parsable by json_encode)
Shows the result of condition evaluations, including those conditions which activated a human review.
- HumanLoopActivationReasons
-
- Type: Array of strings
Shows if and why human review was needed.
- HumanLoopArn
-
- Type: string
The Amazon Resource Name (ARN) of the HumanLoop created.
HumanLoopConfig
Description
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.
Members
- DataAttributes
-
- Type: HumanLoopDataAttributes structure
Sets attributes of the input data.
- FlowDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow definition.
- HumanLoopName
-
- Required: Yes
- Type: string
The name of the human workflow used for this image. This should be kept unique within a region.
HumanLoopDataAttributes
Description
Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information and adult content.
Members
HumanLoopQuotaExceededException
Description
Indicates you have exceeded the maximum number of active human in the loop workflows available
Members
IdempotentParameterMismatchException
Description
A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.
Members
IdentityDocument
Description
The structure that lists each document processed in an AnalyzeID operation.
Members
- Blocks
-
- Type: Array of Block structures
Individual word recognition, as returned by document detection.
- DocumentIndex
-
- Type: int
Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.
- IdentityDocumentFields
-
- Type: Array of IdentityDocumentField structures
The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.
IdentityDocumentField
Description
Structure containing both the normalized type of the extracted information and the text associated with it. These are extracted as Type and Value respectively.
Members
- Type
-
- Type: AnalyzeIDDetections structure
Used to contain the information detected by an AnalyzeID operation.
- ValueDetection
-
- Type: AnalyzeIDDetections structure
Used to contain the information detected by an AnalyzeID operation.
InternalServerError
Description
Amazon Textract experienced a service issue. Try your call again.
Members
InvalidJobIdException
Description
An invalid job identifier was passed to an asynchronous analysis operation.
Members
InvalidKMSKeyException
Description
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
Members
InvalidParameterException
Description
An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.
Members
InvalidS3ObjectException
Description
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
Members
LendingDetection
Description
The results extracted for a lending document.
Members
- Confidence
-
- Type: float
The confidence level for the text of a detected value in a lending document.
- Geometry
-
- Type: Geometry structure
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
- SelectionStatus
-
- Type: string
The selection status of a selection element, such as an option button or check box.
- Text
-
- Type: string
The text extracted for a detected value in a lending document.
LendingDocument
Description
Holds the structured data returned by AnalyzeDocument for lending documents.
Members
- LendingFields
-
- Type: Array of LendingField structures
An array of LendingField objects.
- SignatureDetections
-
- Type: Array of SignatureDetection structures
A list of signatures detected in a lending document.
LendingField
Description
Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.
Members
- KeyDetection
-
- Type: LendingDetection structure
The results extracted for a lending document.
- Type
-
- Type: string
The type of the lending document.
- ValueDetections
-
- Type: Array of LendingDetection structures
An array of LendingDetection objects.
LendingResult
Description
Contains the detections for each page analyzed through the Analyze Lending API.
Members
- Extractions
-
- Type: Array of Extraction structures
An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .
- Page
-
- Type: int
The page number for a page, with regard to whole submission.
- PageClassification
-
- Type: PageClassification structure
The classifier result for a given page.
LendingSummary
Description
Contains information regarding DocumentGroups and UndetectedDocumentTypes.
Members
- DocumentGroups
-
- Type: Array of DocumentGroup structures
Contains an array of all DocumentGroup objects.
- UndetectedDocumentTypes
-
- Type: Array of strings
UndetectedDocumentTypes.
LimitExceededException
Description
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.
Members
LineItemFields
Description
A structure that holds information about the different lines found in a document's tables.
Members
- LineItemExpenseFields
-
- Type: Array of ExpenseField structures
ExpenseFields used to show information from detected lines on a table.
LineItemGroup
Description
A grouping of tables which contain LineItems, with each table identified by the table's LineItemGroupIndex.
Members
- LineItemGroupIndex
-
- Type: int
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.
- LineItems
-
- Type: Array of LineItemFields structures
The breakdown of information on a particular line of a table.
NormalizedValue
Description
Contains information relating to dates in a document, including the type of value, and the value.
Members
NotificationChannel
Description
The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.
Members
OutputConfig
Description
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.
OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.
Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.
For more information on data privacy, see the Data Privacy FAQ.
Members
PageClassification
Description
The class assigned to a Page object detected in an input document. Contains information regarding the predicted type/class of a document's page and the page number that the Page object was detected on.
Members
- PageNumber
-
- Required: Yes
- Type: Array of Prediction structures
The page number the value was detected on, relative to Amazon Textract's starting position.
- PageType
-
- Required: Yes
- Type: Array of Prediction structures
The class, or document type, assigned to a detected Page object. The class, or document type, assigned to a detected Page object.
Point
Description
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 Point objects, 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.
Members
Prediction
Description
Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the confidence in the predicted value.
Members
ProvisionedThroughputExceededException
Description
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
Members
QueriesConfig
Query
Description
Each query contains the question you want to ask in the Text and the alias you want to associate.
Members
- Alias
-
- Type: string
Alias attached to the query, for ease of location.
- Pages
-
- Type: Array of strings
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.
- Text
-
- Required: Yes
- Type: string
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Relationship
Description
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.
The Type element provides the type of the relationship for all blocks in the IDs array.
Members
- Ids
-
- Type: Array of strings
An array of IDs for related blocks. You can get the type of the relationship from the
Typeelement. - Type
-
- Type: string
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be
VALUEorCHILD. 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.
S3Object
Description
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.
Members
- Bucket
-
- Type: string
The name of the S3 bucket. Note that the # character is not valid in the file name.
- Name
-
- Type: string
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.
- Version
-
- Type: string
If the bucket has versioning enabled, you can specify the object version.
SignatureDetection
Description
Information regarding a detected signature on a page.
Members
- Confidence
-
- Type: float
The confidence, from 0 to 100, in the predicted values for a detected signature.
- Geometry
-
- Type: Geometry structure
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
SplitDocument
Description
Contains information about the pages of a document, defined by logical boundary.
Members
ThrottlingException
Description
Amazon Textract is temporarily unable to process the request. Try your call again.
Members
UndetectedSignature
Description
A structure containing information about an undetected signature on a page where it was expected but not found.
Members
UnsupportedDocumentException
Description
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
Members
Warning
Description
A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).