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.
- 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.
- 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.
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 KEYBlock
object and a VALUEBlock
object. 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
Block
object contains information about a detected table. A CELLBlock
object is returned for each cell in a table. -
Lines and words of text. A LINE
Block
object contains one or more WORDBlock
objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value ofFeatureTypes
).
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 ], ]);
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
Bytes
field. - 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
). - HumanLoopConfig
-
- Type: HumanLoopConfig structure
Sets the configuration for the human in the loop workflow for analyzing documents.
Result Syntax
[ 'AnalyzeDocumentModelVersion' => '<string>', 'Blocks' => [ [ 'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT', '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>, 'Relationships' => [ [ 'Ids' => ['<string>', ...], 'Type' => 'VALUE|CHILD|COMPLEX_FEATURES', ], // ... ], '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
InvalidParameterException
exception occurs when neither of theS3Object
orBytes
values are supplied in theDocument
request 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 synchronous operations can be in PNG or JPEG format. Documents for asynchronous operations can also be in PDF 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
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 an image in JPEG or PNG format. 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
Bytes
field.
Result Syntax
[ 'Blocks' => [ [ 'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT', '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>, 'Relationships' => [ [ 'Ids' => ['<string>', ...], 'Type' => 'VALUE|CHILD|COMPLEX_FEATURES', ], // ... ], '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
Block
objects 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
InvalidParameterException
exception occurs when neither of theS3Object
orBytes
values are supplied in theDocument
request 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 synchronous operations can be in PNG or JPEG format. Documents for asynchronous operations can also be in PDF 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 KEYBlock
object and a VALUEBlock
object. 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
Block
object contains information about a detected table. A CELLBlock
object is returned for each cell in a table. -
Lines and words of text. A LINE
Block
object contains one or more WORDBlock
objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of theStartDocumentAnalysis
FeatureTypes
input parameter).
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
JobId
is returned fromStartDocumentAnalysis
. AJobId
value 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', '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>, 'Relationships' => [ [ 'Ids' => ['<string>', ...], 'Type' => 'VALUE|CHILD|COMPLEX_FEATURES', ], // ... ], '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.
DocumentMetadata
is 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
InvalidParameterException
exception occurs when neither of theS3Object
orBytes
values are supplied in theDocument
request 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 GetDocumentAnalysis or to GetDocumentAnalysis.
-
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
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
JobId
is returned fromStartDocumentTextDetection
. AJobId
value 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', '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>, 'Relationships' => [ [ 'Ids' => ['<string>', ...], 'Type' => 'VALUE|CHILD|COMPLEX_FEATURES', ], // ... ], '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.
DocumentMetadata
is 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
InvalidParameterException
exception occurs when neither of theS3Object
orBytes
values are supplied in theDocument
request 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 GetDocumentAnalysis or to GetDocumentAnalysis.
-
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
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, 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>', ], ]);
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
StartDocumentAnalysis
requests, the sameJobId
is returned. UseClientRequestToken
to 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
JobTag
to 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.
Result Syntax
[ 'JobId' => '<string>', ]
Result Details
Members
Errors
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterException
exception occurs when neither of theS3Object
orBytes
values are supplied in theDocument
request 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 synchronous operations can be in PNG or JPEG format. Documents for asynchronous operations can also be in PDF 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
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. -
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, 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
StartDocumentTextDetection
requests, the sameJobId
is returned. UseClientRequestToken
to 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
JobTag
to 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
InvalidParameterException
exception occurs when neither of theS3Object
orBytes
values are supplied in theDocument
request 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 synchronous operations can be in PNG or JPEG format. Documents for asynchronous operations can also be in PDF 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
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. -
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
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
Block
objects that are detected on a document page. -
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
-
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
-
PAGE - Contains a list of child
Block
objects that are detected on a document page. -
KEY_VALUE_SET - Stores the KEY and VALUE
Block
objects for linked text that's detected on a document page. Use theEntityType
field to determine if a KEY_VALUE_SET object is a KEYBlock
object or a VALUEBlock
object. -
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
-
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
-
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
-
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
-
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of
SelectionStatus
to determine the status of the selection element.
- ColumnIndex
-
- Type: int
The column in which a table cell appears. The first column position is 1.
ColumnIndex
isn't returned byDetectDocumentText
andGetDocumentTextDetection
. - 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.
ColumnSpan
isn't returned byDetectDocumentText
andGetDocumentTextDetection
. - 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.
EntityTypes
isn't returned byDetectDocumentText
andGetDocumentTextDetection
. - 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.
Page
is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value ofPage
is always 1. Synchronous operations don't returnPage
because every input document is considered to be a single-page document. - 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.
RowIndex
isn't returned byDetectDocumentText
andGetDocumentTextDetection
. - 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.
RowSpan
isn't returned byDetectDocumentText
andGetDocumentTextDetection
. - 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.
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
Bytes
field. - 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.
DocumentLocation
Description
The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations such as StartDocumentTextDetection.
The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.
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
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
InternalServerError
Description
Amazon Textract experienced a service issue. Try your call again.
Members
InvalidJobIdException
Description
An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.
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
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
NotificationChannel
Description
The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation, such as StartDocumentTextDetection.
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.
Members
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
ProvisionedThroughputExceededException
Description
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
Members
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
Type
element. - Type
-
- Type: string
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be
VALUE
orCHILD
. 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.
- 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 format files.
- Version
-
- Type: string
If the bucket has versioning enabled, you can specify the object version.
ThrottlingException
Description
Amazon Textract is temporarily unable to process the request. Try your call again.
Members
UnsupportedDocumentException
Description
The format of the input document isn't supported. Documents for synchronous operations can be in PNG or JPEG format. Documents for asynchronous operations can also be in PDF format.
Members
Warning
Description
A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).