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.
- CreateAdapter ( array $params = [] )
- Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents.
- CreateAdapterVersion ( array $params = [] )
- Creates a new version of an adapter.
- DeleteAdapter ( array $params = [] )
- Deletes an Amazon Textract adapter.
- DeleteAdapterVersion ( array $params = [] )
- Deletes an Amazon Textract adapter version.
- DetectDocumentText ( array $params = [] )
- Detects text in the input document.
- GetAdapter ( array $params = [] )
- Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.
- GetAdapterVersion ( array $params = [] )
- Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.
- 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.
- ListAdapterVersions ( array $params = [] )
- List all version of an adapter that meet the specified filtration criteria.
- ListAdapters ( array $params = [] )
- Lists all adapters that match the specified filtration criteria.
- ListTagsForResource ( array $params = [] )
- Lists all tags for an Amazon Textract resource.
- 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.
- TagResource ( array $params = [] )
- Adds one or more tags to the specified resource.
- UntagResource ( array $params = [] )
- Removes any tags with the specified keys from the specified resource.
- UpdateAdapter ( array $params = [] )
- Update the configuration for an adapter.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
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
). -
Signatures. A SIGNATURE
Block
object 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([ 'AdaptersConfig' => [ 'Adapters' => [ // REQUIRED [ 'AdapterId' => '<string>', // REQUIRED 'Pages' => ['<string>', ...], 'Version' => '<string>', // REQUIRED ], // ... ], ], '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
- AdaptersConfig
-
- Type: AdaptersConfig structure
Specifies the adapter to be used when analyzing a document.
- 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
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. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of
FeatureTypes
). - HumanLoopConfig
-
- 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|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE', '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|TABLE|TABLE_TITLE|TABLE_FOOTER', ], // ... ], '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
-
InvalidParameterException:
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. -
InvalidS3ObjectException:
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
-
UnsupportedDocumentException:
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
DocumentTooLargeException:
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.
-
BadDocumentException:
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
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 containingLineItems
which 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
Bytes
property. For example, you would use theBytes
property to pass a document loaded from a local file system. Image bytes passed by using theBytes
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.
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|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE', '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|TABLE|TABLE_TITLE|TABLE_FOOTER', ], // ... ], '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
-
InvalidParameterException:
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. -
InvalidS3ObjectException:
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
-
UnsupportedDocumentException:
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
DocumentTooLargeException:
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.
-
BadDocumentException:
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
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|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE', '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|TABLE|TABLE_TITLE|TABLE_FOOTER', ], // ... ], '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
-
InvalidParameterException:
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. -
InvalidS3ObjectException:
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
-
UnsupportedDocumentException:
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
DocumentTooLargeException:
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.
-
BadDocumentException:
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
CreateAdapter
$result = $client->createAdapter
([/* ... */]); $promise = $client->createAdapterAsync
([/* ... */]);
Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES
. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.
Parameter Syntax
$result = $client->createAdapter([ 'AdapterName' => '<string>', // REQUIRED 'AutoUpdate' => 'ENABLED|DISABLED', 'ClientRequestToken' => '<string>', 'Description' => '<string>', 'FeatureTypes' => ['<string>', ...], // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- AdapterName
-
- Required: Yes
- Type: string
The name to be assigned to the adapter being created.
- AutoUpdate
-
- Type: string
Controls whether or not the adapter should automatically update.
- ClientRequestToken
-
- Type: string
Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.
- Description
-
- Type: string
The description to be assigned to the adapter being created.
- FeatureTypes
-
- Required: Yes
- Type: Array of strings
The type of feature that the adapter is being trained on. Currrenly, supported feature types are:
QUERIES
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to be added to the adapter.
Result Syntax
[ 'AdapterId' => '<string>', ]
Result Details
Members
- AdapterId
-
- Type: string
A string containing the unique ID for the adapter that has been created.
Errors
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
ConflictException:
Updating or deleting a resource can cause an inconsistent state.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
InternalServerError:
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. -
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
LimitExceededException:
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. -
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
-
ServiceQuotaExceededException:
Returned when a request cannot be completed as it would exceed a maximum service quota.
CreateAdapterVersion
$result = $client->createAdapterVersion
([/* ... */]); $promise = $client->createAdapterVersionAsync
([/* ... */]);
Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.
Parameter Syntax
$result = $client->createAdapterVersion([ 'AdapterId' => '<string>', // REQUIRED 'ClientRequestToken' => '<string>', 'DatasetConfig' => [ // REQUIRED 'ManifestS3Object' => [ 'Bucket' => '<string>', 'Name' => '<string>', 'Version' => '<string>', ], ], 'KMSKeyId' => '<string>', 'OutputConfig' => [ // REQUIRED 'S3Bucket' => '<string>', // REQUIRED 'S3Prefix' => '<string>', ], 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- AdapterId
-
- Required: Yes
- Type: string
A string containing a unique ID for the adapter that will receive a new version.
- ClientRequestToken
-
- Type: string
Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.
- DatasetConfig
-
- Required: Yes
- Type: AdapterVersionDatasetConfig structure
Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the value.
- KMSKeyId
-
- Type: string
The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
- OutputConfig
-
- Required: Yes
- 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.
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. WithOutputConfig
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 theKMSKeyID
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.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A set of tags (key-value pairs) that you want to attach to the adapter version.
Result Syntax
[ 'AdapterId' => '<string>', 'AdapterVersion' => '<string>', ]
Result Details
Members
- AdapterId
-
- Type: string
A string containing the unique ID for the adapter that has received a new version.
- AdapterVersion
-
- Type: string
A string describing the new version of the adapter.
Errors
-
InvalidParameterException:
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. -
InvalidS3ObjectException:
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
-
InvalidKMSKeyException:
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
-
AccessDeniedException:
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.
-
InternalServerError:
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. -
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
LimitExceededException:
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. -
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
-
ServiceQuotaExceededException:
Returned when a request cannot be completed as it would exceed a maximum service quota.
-
ResourceNotFoundException:
Returned when an operation tried to access a nonexistent resource.
-
ConflictException:
Updating or deleting a resource can cause an inconsistent state.
DeleteAdapter
$result = $client->deleteAdapter
([/* ... */]); $promise = $client->deleteAdapterAsync
([/* ... */]);
Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.
Parameter Syntax
$result = $client->deleteAdapter([ 'AdapterId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AdapterId
-
- Required: Yes
- Type: string
A string containing a unique ID for the adapter to be deleted.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
ConflictException:
Updating or deleting a resource can cause an inconsistent state.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
-
ResourceNotFoundException:
Returned when an operation tried to access a nonexistent resource.
DeleteAdapterVersion
$result = $client->deleteAdapterVersion
([/* ... */]); $promise = $client->deleteAdapterVersionAsync
([/* ... */]);
Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.
Parameter Syntax
$result = $client->deleteAdapterVersion([ 'AdapterId' => '<string>', // REQUIRED 'AdapterVersion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AdapterId
-
- Required: Yes
- Type: string
A string containing a unique ID for the adapter version that will be deleted.
- AdapterVersion
-
- Required: Yes
- Type: string
Specifies the adapter version to be deleted.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
ConflictException:
Updating or deleting a resource can cause an inconsistent state.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
-
ResourceNotFoundException:
Returned when an operation tried to access a nonexistent resource.
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
Bytes
field.
Result Syntax
[ 'Blocks' => [ [ 'BlockType' => 'KEY_VALUE_SET|PAGE|LINE|WORD|TABLE|CELL|SELECTION_ELEMENT|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE', '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|TABLE|TABLE_TITLE|TABLE_FOOTER', ], // ... ], '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
-
InvalidParameterException:
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. -
InvalidS3ObjectException:
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
-
UnsupportedDocumentException:
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
DocumentTooLargeException:
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.
-
BadDocumentException:
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
GetAdapter
$result = $client->getAdapter
([/* ... */]); $promise = $client->getAdapterAsync
([/* ... */]);
Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.
Parameter Syntax
$result = $client->getAdapter([ 'AdapterId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AdapterId
-
- Required: Yes
- Type: string
A string containing a unique ID for the adapter.
Result Syntax
[ 'AdapterId' => '<string>', 'AdapterName' => '<string>', 'AutoUpdate' => 'ENABLED|DISABLED', 'CreationTime' => <DateTime>, 'Description' => '<string>', 'FeatureTypes' => ['<string>', ...], 'Tags' => ['<string>', ...], ]
Result Details
Members
- AdapterId
-
- Type: string
A string identifying the adapter that information has been retrieved for.
- AdapterName
-
- Type: string
The name of the requested adapter.
- AutoUpdate
-
- Type: string
Binary value indicating if the adapter is being automatically updated or not.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the requested adapter was created at.
- Description
-
- Type: string
The description for the requested adapter.
- FeatureTypes
-
- Type: Array of strings
List of the targeted feature types for the requested adapter.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A set of tags (key-value pairs) associated with the adapter that has been retrieved.
Errors
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
-
ResourceNotFoundException:
Returned when an operation tried to access a nonexistent resource.
GetAdapterVersion
$result = $client->getAdapterVersion
([/* ... */]); $promise = $client->getAdapterVersionAsync
([/* ... */]);
Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.
Parameter Syntax
$result = $client->getAdapterVersion([ 'AdapterId' => '<string>', // REQUIRED 'AdapterVersion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AdapterId
-
- Required: Yes
- Type: string
A string specifying a unique ID for the adapter version you want to retrieve information for.
- AdapterVersion
-
- Required: Yes
- Type: string
A string specifying the adapter version you want to retrieve information for.
Result Syntax
[ 'AdapterId' => '<string>', 'AdapterVersion' => '<string>', 'CreationTime' => <DateTime>, 'DatasetConfig' => [ 'ManifestS3Object' => [ 'Bucket' => '<string>', 'Name' => '<string>', 'Version' => '<string>', ], ], 'EvaluationMetrics' => [ [ 'AdapterVersion' => [ 'F1Score' => <float>, 'Precision' => <float>, 'Recall' => <float>, ], 'Baseline' => [ 'F1Score' => <float>, 'Precision' => <float>, 'Recall' => <float>, ], 'FeatureType' => 'TABLES|FORMS|QUERIES|SIGNATURES|LAYOUT', ], // ... ], 'FeatureTypes' => ['<string>', ...], 'KMSKeyId' => '<string>', 'OutputConfig' => [ 'S3Bucket' => '<string>', 'S3Prefix' => '<string>', ], 'Status' => 'ACTIVE|AT_RISK|DEPRECATED|CREATION_ERROR|CREATION_IN_PROGRESS', 'StatusMessage' => '<string>', 'Tags' => ['<string>', ...], ]
Result Details
Members
- AdapterId
-
- Type: string
A string containing a unique ID for the adapter version being retrieved.
- AdapterVersion
-
- Type: string
A string containing the adapter version that has been retrieved.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the adapter version was created.
- DatasetConfig
-
- Type: AdapterVersionDatasetConfig structure
Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.
- EvaluationMetrics
-
- Type: Array of AdapterVersionEvaluationMetric structures
The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
- FeatureTypes
-
- Type: Array of strings
List of the targeted feature types for the requested adapter version.
- KMSKeyId
-
- Type: string
The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
- 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.
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. WithOutputConfig
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 theKMSKeyID
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.
- Status
-
- Type: string
The status of the adapter version that has been requested.
- StatusMessage
-
- Type: string
A message that describes the status of the requested adapter version.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A set of tags (key-value pairs) that are associated with the adapter version.
Errors
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
-
ResourceNotFoundException:
Returned when an operation tried to access a nonexistent resource.
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). -
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
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|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE', '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|TABLE|TABLE_TITLE|TABLE_FOOTER', ], // ... ], '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
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InvalidJobIdException:
An invalid job identifier was passed to an asynchronous analysis operation.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
InvalidS3ObjectException:
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
-
InvalidKMSKeyException:
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
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|MERGED_CELL|TITLE|QUERY|QUERY_RESULT|SIGNATURE|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE', '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|TABLE|TABLE_TITLE|TABLE_FOOTER', ], // ... ], '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
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InvalidJobIdException:
An invalid job identifier was passed to an asynchronous analysis operation.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
InvalidS3ObjectException:
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
-
InvalidKMSKeyException:
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
JobId
is returned fromStartExpenseAnalysis
. 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 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|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE', '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|TABLE|TABLE_TITLE|TABLE_FOOTER', ], // ... ], '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.
DocumentMetadata
is 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
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InvalidJobIdException:
An invalid job identifier was passed to an asynchronous analysis operation.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
InvalidS3ObjectException:
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
-
InvalidKMSKeyException:
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
JobId
is returned fromStartLendingAnalysis
. 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 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|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE', '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|TABLE|TABLE_TITLE|TABLE_FOOTER', ], // ... ], '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|TABLE_TITLE|TABLE_FOOTER|LAYOUT_TEXT|LAYOUT_TITLE|LAYOUT_HEADER|LAYOUT_FOOTER|LAYOUT_SECTION_HEADER|LAYOUT_PAGE_NUMBER|LAYOUT_LIST|LAYOUT_FIGURE|LAYOUT_TABLE|LAYOUT_KEY_VALUE', '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|TABLE|TABLE_TITLE|TABLE_FOOTER', ], // ... ], '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
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InvalidJobIdException:
An invalid job identifier was passed to an asynchronous analysis operation.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
InvalidS3ObjectException:
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
-
InvalidKMSKeyException:
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
- JobId
-
- Required: Yes
- Type: string
A unique identifier for the lending or text-detection job. The
JobId
is returned from StartLendingAnalysis. AJobId
value is only valid for 7 days.
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
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InvalidJobIdException:
An invalid job identifier was passed to an asynchronous analysis operation.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
InvalidS3ObjectException:
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
-
InvalidKMSKeyException:
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
ListAdapterVersions
$result = $client->listAdapterVersions
([/* ... */]); $promise = $client->listAdapterVersionsAsync
([/* ... */]);
List all version of an adapter that meet the specified filtration criteria.
Parameter Syntax
$result = $client->listAdapterVersions([ 'AdapterId' => '<string>', 'AfterCreationTime' => <integer || string || DateTime>, 'BeforeCreationTime' => <integer || string || DateTime>, 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AdapterId
-
- Type: string
A string containing a unique ID for the adapter to match for when listing adapter versions.
- AfterCreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the lower bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.
- BeforeCreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the upper bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.
- MaxResults
-
- Type: int
The maximum number of results to return when listing adapter versions.
- NextToken
-
- Type: string
Identifies the next page of results to return when listing adapter versions.
Result Syntax
[ 'AdapterVersions' => [ [ 'AdapterId' => '<string>', 'AdapterVersion' => '<string>', 'CreationTime' => <DateTime>, 'FeatureTypes' => ['<string>', ...], 'Status' => 'ACTIVE|AT_RISK|DEPRECATED|CREATION_ERROR|CREATION_IN_PROGRESS', 'StatusMessage' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AdapterVersions
-
- Type: Array of AdapterVersionOverview structures
Adapter versions that match the filtering criteria specified when calling ListAdapters.
- NextToken
-
- Type: string
Identifies the next page of results to return when listing adapter versions.
Errors
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
-
ResourceNotFoundException:
Returned when an operation tried to access a nonexistent resource.
ListAdapters
$result = $client->listAdapters
([/* ... */]); $promise = $client->listAdaptersAsync
([/* ... */]);
Lists all adapters that match the specified filtration criteria.
Parameter Syntax
$result = $client->listAdapters([ 'AfterCreationTime' => <integer || string || DateTime>, 'BeforeCreationTime' => <integer || string || DateTime>, 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AfterCreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time.
- BeforeCreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time.
- MaxResults
-
- Type: int
The maximum number of results to return when listing adapters.
- NextToken
-
- Type: string
Identifies the next page of results to return when listing adapters.
Result Syntax
[ 'Adapters' => [ [ 'AdapterId' => '<string>', 'AdapterName' => '<string>', 'CreationTime' => <DateTime>, 'FeatureTypes' => ['<string>', ...], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Adapters
-
- Type: Array of AdapterOverview structures
A list of adapters that matches the filtering criteria specified when calling ListAdapters.
- NextToken
-
- Type: string
Identifies the next page of results to return when listing adapters.
Errors
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Lists all tags for an Amazon Textract resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'ResourceARN' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that specifies the resource to list tags for.
Result Syntax
[ 'Tags' => ['<string>', ...], ]
Result Details
Members
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A set of tags (key-value pairs) that are part of the requested resource.
Errors
-
ResourceNotFoundException:
Returned when an operation tried to access a nonexistent resource.
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
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([ 'AdaptersConfig' => [ 'Adapters' => [ // REQUIRED [ 'AdapterId' => '<string>', // REQUIRED 'Pages' => ['<string>', ...], 'Version' => '<string>', // REQUIRED ], // ... ], ], '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
- AdaptersConfig
-
- Type: AdaptersConfig structure
Specifies the adapter to be used when analyzing a document.
- 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.
- QueriesConfig
-
- Type: QueriesConfig structure
Result Syntax
[ 'JobId' => '<string>', ]
Result Details
Members
- JobId
-
- Type: string
The identifier for the document text detection job. Use
JobId
to identify the job in a subsequent call toGetDocumentAnalysis
. AJobId
value is only valid for 7 days.
Errors
-
InvalidParameterException:
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. -
InvalidS3ObjectException:
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
-
InvalidKMSKeyException:
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
-
UnsupportedDocumentException:
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
DocumentTooLargeException:
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.
-
BadDocumentException:
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
AccessDeniedException:
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.
-
InternalServerError:
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. -
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
LimitExceededException:
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
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
- JobId
-
- Type: string
The identifier of the text detection job for the document. Use
JobId
to identify the job in a subsequent call toGetDocumentTextDetection
. AJobId
value is only valid for 7 days.
Errors
-
InvalidParameterException:
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. -
InvalidS3ObjectException:
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
-
InvalidKMSKeyException:
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
-
UnsupportedDocumentException:
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
DocumentTooLargeException:
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.
-
BadDocumentException:
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
AccessDeniedException:
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.
-
InternalServerError:
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. -
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
LimitExceededException:
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
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 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
GetExpenseAnalysis
operation.
Result Syntax
[ 'JobId' => '<string>', ]
Result Details
Members
- JobId
-
- Type: string
A unique identifier for the text detection job. The
JobId
is returned fromStartExpenseAnalysis
. AJobId
value is only valid for 7 days.
Errors
-
InvalidParameterException:
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. -
InvalidS3ObjectException:
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
-
InvalidKMSKeyException:
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
-
UnsupportedDocumentException:
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
DocumentTooLargeException:
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.
-
BadDocumentException:
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
AccessDeniedException:
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.
-
InternalServerError:
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. -
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
LimitExceededException:
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
StartLendingAnalysis
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 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
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 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.
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. WithOutputConfig
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 theKMSKeyID
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.
Result Syntax
[ 'JobId' => '<string>', ]
Result Details
Members
- JobId
-
- Type: string
A unique identifier for the lending or text-detection job. The
JobId
is returned fromStartLendingAnalysis
. AJobId
value is only valid for 7 days.
Errors
-
InvalidParameterException:
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. -
InvalidS3ObjectException:
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
-
InvalidKMSKeyException:
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
-
UnsupportedDocumentException:
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
-
DocumentTooLargeException:
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.
-
BadDocumentException:
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
-
AccessDeniedException:
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.
-
InternalServerError:
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. -
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
LimitExceededException:
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.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds one or more tags to the specified resource.
Parameter Syntax
$result = $client->tagResource([ 'ResourceARN' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that specifies the resource to be tagged.
- Tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
A set of tags (key-value pairs) that you want to assign to the resource.
Result Syntax
[]
Result Details
Errors
-
ResourceNotFoundException:
Returned when an operation tried to access a nonexistent resource.
-
InvalidParameterException:
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. -
ServiceQuotaExceededException:
Returned when a request cannot be completed as it would exceed a maximum service quota.
-
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes any tags with the specified keys from the specified resource.
Parameter Syntax
$result = $client->untagResource([ 'ResourceARN' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that specifies the resource to be untagged.
- TagKeys
-
- Required: Yes
- Type: Array of strings
Specifies the tags to be removed from the resource specified by the ResourceARN.
Result Syntax
[]
Result Details
Errors
-
ResourceNotFoundException:
Returned when an operation tried to access a nonexistent resource.
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
UpdateAdapter
$result = $client->updateAdapter
([/* ... */]); $promise = $client->updateAdapterAsync
([/* ... */]);
Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.
Parameter Syntax
$result = $client->updateAdapter([ 'AdapterId' => '<string>', // REQUIRED 'AdapterName' => '<string>', 'AutoUpdate' => 'ENABLED|DISABLED', 'Description' => '<string>', ]);
Parameter Details
Members
- AdapterId
-
- Required: Yes
- Type: string
A string containing a unique ID for the adapter that will be updated.
- AdapterName
-
- Type: string
The new name to be applied to the adapter.
- AutoUpdate
-
- Type: string
The new auto-update status to be applied to the adapter.
- Description
-
- Type: string
The new description to be applied to the adapter.
Result Syntax
[ 'AdapterId' => '<string>', 'AdapterName' => '<string>', 'AutoUpdate' => 'ENABLED|DISABLED', 'CreationTime' => <DateTime>, 'Description' => '<string>', 'FeatureTypes' => ['<string>', ...], ]
Result Details
Members
- AdapterId
-
- Type: string
A string containing a unique ID for the adapter that has been updated.
- AdapterName
-
- Type: string
A string containing the name of the adapter that has been updated.
- AutoUpdate
-
- Type: string
The auto-update status of the adapter that has been updated.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
An object specifying the creation time of the the adapter that has been updated.
- Description
-
- Type: string
A string containing the description of the adapter that has been updated.
- FeatureTypes
-
- Type: Array of strings
List of the targeted feature types for the updated adapter.
Errors
-
InvalidParameterException:
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. -
AccessDeniedException:
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.
-
ConflictException:
Updating or deleting a resource can cause an inconsistent state.
-
ProvisionedThroughputExceededException:
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
-
InternalServerError:
Amazon Textract experienced a service issue. Try your call again.
-
ThrottlingException:
Amazon Textract is temporarily unable to process the request. Try your call again.
-
ValidationException:
Indicates that a request was not valid. Check request for proper formatting.
-
ResourceNotFoundException:
Returned when an operation tried to access a nonexistent resource.
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
Adapter
Description
An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. Contains information on pages selected for analysis when analyzing documents asychronously.
Members
- AdapterId
-
- Required: Yes
- Type: string
A unique identifier for the adapter resource.
- Pages
-
- Type: Array of strings
Pages is a parameter that the user inputs to specify which pages to apply an adapter 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.
- Version
-
- Required: Yes
- Type: string
A string that identifies the version of the adapter.
AdapterOverview
Description
Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.
Members
- AdapterId
-
- Type: string
A unique identifier for the adapter resource.
- AdapterName
-
- Type: string
A string naming the adapter resource.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the adapter was created.
- FeatureTypes
-
- Type: Array of strings
The feature types that the adapter is operating on.
AdapterVersionDatasetConfig
Description
The dataset configuration options for a given version of an adapter. Can include an Amazon S3 bucket if specified.
Members
- ManifestS3Object
-
- Type: S3Object structure
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.
AdapterVersionEvaluationMetric
Description
Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for baseline model performance and individual adapter version perfromance.
Members
- AdapterVersion
-
- Type: EvaluationMetric structure
The F1 score, precision, and recall metrics for the baseline model.
- Baseline
-
- Type: EvaluationMetric structure
The F1 score, precision, and recall metrics for the baseline model.
- FeatureType
-
- Type: string
Indicates the feature type being analyzed by a given adapter version.
AdapterVersionOverview
Description
Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.
Members
- AdapterId
-
- Type: string
A unique identifier for the adapter associated with a given adapter version.
- AdapterVersion
-
- Type: string
An identified for a given adapter version.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that a given adapter version was created.
- FeatureTypes
-
- Type: Array of strings
The feature types that the adapter version is operating on.
- Status
-
- Type: string
Contains information on the status of a given adapter version.
- StatusMessage
-
- Type: string
A message explaining the status of a given adapter vesion.
AdaptersConfig
Description
Contains information about adapters used when analyzing a document, with each adapter specified using an AdapterId and version
Members
- Adapters
-
- Required: Yes
- Type: Array of Adapter structures
A list of adapters to be used when analyzing the specified document.
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
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.
-
TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.
-
TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.
-
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
-
MERGED_CELL - A cell in a table whose content spans more than one row or column. The
Relationships
array for this cell contain data from individual cells. -
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of
SelectionStatus
to determine the status of the selection element. -
SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
-
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
-
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
The following BlockTypes are only returned for Amazon Textract Layout.
-
LAYOUT_TITLE
- The main title of the document. -
LAYOUT_HEADER
- Text located in the top margin of the document. -
LAYOUT_FOOTER
- Text located in the bottom margin of the document. -
LAYOUT_SECTION_HEADER
- The titles of sections within a document. -
LAYOUT_PAGE_NUMBER
- The page number of the documents. -
LAYOUT_LIST
- Any information grouped together in list form. -
LAYOUT_FIGURE
- Indicates the location of an image in a document. -
LAYOUT_TABLE
- Indicates the location of a table in the document. -
LAYOUT_KEY_VALUE
- Indicates the location of form key-values in a document. -
LAYOUT_TEXT
- Text that is present typically as a part of paragraphs in documents.
- 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.
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 entity types can be returned by FORMS analysis:
-
KEY - An identifier for a field on the document.
-
VALUE - The field text.
The following entity types can be returned by TABLES analysis:
-
COLUMN_HEADER - Identifies a cell that is a header of a column.
-
TABLE_TITLE - Identifies a cell that is a title within the table.
-
TABLE_SECTION_TITLE - Identifies a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section.
-
TABLE_FOOTER - Identifies a cell that is a footer of a table.
-
TABLE_SUMMARY - Identifies a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.
-
STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.
-
SEMI_STRUCTURED_TABLE - Identifies a non-structured table.
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 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 ofPage
is always 1. - Query
-
- Type: Query structure
- Relationships
-
- Type: Array of Relationship structures
A list of relationship objects that describe how blocks are related to each other. For example, a LINE block object contains a CHILD relationship type with the WORD blocks that make up 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.
- 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.
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.
ConflictException
Description
Updating or deleting a resource can cause an inconsistent state.
Members
DetectedSignature
Description
A structure that holds information regarding a detected signature on a page.
Members
- Page
-
- Type: int
The page a detected signature was found on.
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.
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 Analyze Lending Response Objects 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
- Pages
-
- Type: int
The number of pages that are detected in the document.
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
EvaluationMetric
Description
The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.
Members
- F1Score
-
- Type: float
The F1 score for an adapter version.
- Precision
-
- Type: float
The Precision score for an adapter version.
- Recall
-
- Type: float
The Recall score for an adapter version.
ExpenseCurrency
Description
Returns the kind of currency detected.
Members
- Code
-
- Type: string
Currency code for detected currency. the current supported codes are:
-
USD
-
EUR
-
GBP
-
CAD
-
INR
-
JPY
-
CHF
-
AUD
-
CNY
-
BZR
-
SEK
-
HKD
- Confidence
-
- Type: float
Percentage confideence in the detected currency.
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
- Id
-
- Type: string
Provides a group Id number, which will be the same for each in the group.
- Types
-
- Type: Array of strings
Informs you on whether the expense group is a name or an address.
ExpenseType
Description
An object used to store information about the Type detected by Amazon Textract.
Members
- Confidence
-
- Type: float
The confidence of accuracy, as a percentage.
- Text
-
- Type: string
The word or line of text detected by Amazon Textract.
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
- ContentClassifiers
-
- Type: Array of strings
Sets whether the input image is free of personally identifiable information or adult content.
HumanLoopQuotaExceededException
Description
Indicates you have exceeded the maximum number of active human in the loop workflows available
Members
- QuotaCode
-
- Type: string
The quota code.
- ResourceType
-
- Type: string
The resource type.
- ServiceCode
-
- Type: string
The service code.
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
- Value
-
- Type: string
The value of the date, written as Year-Month-DayTHour:Minute:Second.
- ValueType
-
- Type: string
The normalized type of the value detected. In this case, DATE.
NotificationChannel
Description
The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.
Members
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
- SNSTopicArn
-
- Required: Yes
- Type: string
The Amazon SNS topic that Amazon Textract posts the completion status to.
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
- S3Bucket
-
- Required: Yes
- Type: string
The name of the bucket your output will go to.
- S3Prefix
-
- Type: string
The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".
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
- X
-
- Type: float
The value of the X coordinate for a point on a
Polygon
. - Y
-
- Type: float
The value of the Y coordinate for a point on a
Polygon
.
Prediction
Description
Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the confidence in the predicted value.
Members
- Confidence
-
- Type: float
Amazon Textract's confidence in its predicted value.
- Value
-
- Type: string
The predicted value of a detected object.
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
Type
element. - Type
-
- Type: string
The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.
-
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.
-
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.
-
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.
-
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.
-
TABLE - A list of IDs that identify associated TABLE block types.
-
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.
-
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
ResourceNotFoundException
Description
Returned when an operation tried to access a nonexistent resource.
Members
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.
ServiceQuotaExceededException
Description
Returned when a request cannot be completed as it would exceed a maximum service quota.
Members
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
- Index
-
- Type: int
The index for a given document in a DocumentGroup of a specific Type.
- Pages
-
- Type: Array of ints
An array of page numbers for a for a given document, ordered by logical boundary.
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
- Page
-
- Type: int
The page where a signature was expected but not found.
UnsupportedDocumentException
Description
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
Members
ValidationException
Description
Indicates that a request was not valid. Check request for proper formatting.
Members
Warning
Description
A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).
Members
- ErrorCode
-
- Type: string
The error code for the warning.
- Pages
-
- Type: Array of ints
A list of the pages that the warning applies to.