/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.textract; import java.util.concurrent.Callable; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import com.amazonaws.AmazonClientException; import com.amazonaws.AmazonServiceException; import com.amazonaws.handlers.AsyncHandler; import com.amazonaws.ClientConfiguration; import com.amazonaws.auth.AWSCredentials; import com.amazonaws.auth.AWSCredentialsProvider; import com.amazonaws.auth.DefaultAWSCredentialsProviderChain; import com.amazonaws.services.textract.model.*; /** * Interface for accessing Amazon Textract asynchronously. *

* Amazon Textract detects and analyzes text in documents and converts it into * machine-readable text. This is the API reference documentation for Amazon * Textract. *

**/ public class AmazonTextractAsyncClient extends AmazonTextractClient implements AmazonTextractAsync { /** * Executor service for executing asynchronous requests. */ private ExecutorService executorService; private static final int DEFAULT_THREAD_POOL_SIZE = 10; /** * Constructs a new asynchronous client to invoke service methods on Amazon * Textract. A credentials provider chain will be used that searches for * credentials in this order: * *

* All service calls made using this new client object are blocking, and * will not return until the service call completes. * * @see DefaultAWSCredentialsProviderChain */ @Deprecated public AmazonTextractAsyncClient() { this(new DefaultAWSCredentialsProviderChain()); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Textract. A credentials provider chain will be used that searches for * credentials in this order: *

*

* All service calls made using this new client object are blocking, and * will not return until the service call completes. * * @param clientConfiguration The client configuration options controlling * how this client connects to Amazon Textract (ex: proxy * settings, retry counts, etc.). * @see DefaultAWSCredentialsProviderChain */ @Deprecated public AmazonTextractAsyncClient(ClientConfiguration clientConfiguration) { this(new DefaultAWSCredentialsProviderChain(), clientConfiguration, Executors .newFixedThreadPool(clientConfiguration.getMaxConnections())); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Textract using the specified AWS account credentials. Default client * settings will be used, and a fixed size thread pool will be created for * executing the asynchronous tasks. *

* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. */ public AmazonTextractAsyncClient(AWSCredentials awsCredentials) { this(awsCredentials, Executors.newFixedThreadPool(DEFAULT_THREAD_POOL_SIZE)); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Textract using the specified AWS account credentials and executor * service. Default client settings will be used. *

* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonTextractAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) { super(awsCredentials); this.executorService = executorService; } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Textract using the specified AWS account credentials, executor service, * and client configuration options. *

* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. * @param clientConfiguration Client configuration options (ex: max retry * limit, proxy settings, etc). * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonTextractAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) { super(awsCredentials, clientConfiguration); this.executorService = executorService; } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Textract using the specified AWS account credentials provider. Default * client settings will be used, and a fixed size thread pool will be * created for executing the asynchronous tasks. *

* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. */ public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider) { this(awsCredentialsProvider, Executors.newFixedThreadPool(DEFAULT_THREAD_POOL_SIZE)); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Textract using the specified AWS account credentials provider and * executor service. Default client settings will be used. *

* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) { this(awsCredentialsProvider, new ClientConfiguration(), executorService); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Textract using the specified AWS account credentials provider and client * configuration options. *

* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param clientConfiguration Client configuration options (ex: max retry * limit, proxy settings, etc). */ public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) { this(awsCredentialsProvider, clientConfiguration, Executors .newFixedThreadPool(clientConfiguration.getMaxConnections())); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Textract using the specified AWS account credentials provider, executor * service, and client configuration options. *

* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param clientConfiguration Client configuration options (ex: max retry * limit, proxy settings, etc). * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) { super(awsCredentialsProvider, clientConfiguration); this.executorService = executorService; } /** * Returns the executor service used by this async client to execute * requests. * * @return The executor service used by this async client to execute * requests. */ public ExecutorService getExecutorService() { return executorService; } /** * Shuts down the client, releasing all managed resources. This includes * forcibly terminating all pending asynchronous service calls. Clients who * wish to give pending asynchronous service calls time to complete should * call getExecutorService().shutdown() followed by * getExecutorService().awaitTermination() prior to calling this method. */ @Override public void shutdown() { super.shutdown(); executorService.shutdownNow(); } /** *

* Analyzes an input document for relationships between detected items. *

*

* The types of information returned are as follows: *

* *

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

* * @param analyzeDocumentRequest * @return A Java Future object containing the response from the * AnalyzeDocument service method, as returned by Amazon Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws ThrottlingException * @throws HumanLoopQuotaExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future analyzeDocumentAsync( final AnalyzeDocumentRequest analyzeDocumentRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public AnalyzeDocumentResult call() throws Exception { return analyzeDocument(analyzeDocumentRequest); } }); } /** *

* Analyzes an input document for relationships between detected items. *

*

* The types of information returned are as follows: *

* *

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

* * @param analyzeDocumentRequest * @return A Java Future object containing the response from the * AnalyzeDocument service method, as returned by Amazon Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws ThrottlingException * @throws HumanLoopQuotaExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future analyzeDocumentAsync( final AnalyzeDocumentRequest analyzeDocumentRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public AnalyzeDocumentResult call() throws Exception { AnalyzeDocumentResult result = null; try { result = analyzeDocument(analyzeDocumentRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(analyzeDocumentRequest, result); return result; } }); } /** *

* 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 containing LineItems * 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. *

    *
  • *
* * @param analyzeExpenseRequest * @return A Java Future object containing the response from the * AnalyzeExpense service method, as returned by Amazon Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future analyzeExpenseAsync( final AnalyzeExpenseRequest analyzeExpenseRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public AnalyzeExpenseResult call() throws Exception { return analyzeExpense(analyzeExpenseRequest); } }); } /** *

* 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 containing LineItems * 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. *

    *
  • *
* * @param analyzeExpenseRequest * @return A Java Future object containing the response from the * AnalyzeExpense service method, as returned by Amazon Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future analyzeExpenseAsync( final AnalyzeExpenseRequest analyzeExpenseRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public AnalyzeExpenseResult call() throws Exception { AnalyzeExpenseResult result = null; try { result = analyzeExpense(analyzeExpenseRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(analyzeExpenseRequest, result); return result; } }); } /** *

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

* * @param analyzeIDRequest * @return A Java Future object containing the response from the AnalyzeID * service method, as returned by Amazon Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future analyzeIDAsync(final AnalyzeIDRequest analyzeIDRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public AnalyzeIDResult call() throws Exception { return analyzeID(analyzeIDRequest); } }); } /** *

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

* * @param analyzeIDRequest * @return A Java Future object containing the response from the AnalyzeID * service method, as returned by Amazon Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future analyzeIDAsync(final AnalyzeIDRequest analyzeIDRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public AnalyzeIDResult call() throws Exception { AnalyzeIDResult result = null; try { result = analyzeID(analyzeIDRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(analyzeIDRequest, result); return result; } }); } /** *

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

* * @param detectDocumentTextRequest * @return A Java Future object containing the response from the * DetectDocumentText service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future detectDocumentTextAsync( final DetectDocumentTextRequest detectDocumentTextRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public DetectDocumentTextResult call() throws Exception { return detectDocumentText(detectDocumentTextRequest); } }); } /** *

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

* * @param detectDocumentTextRequest * @return A Java Future object containing the response from the * DetectDocumentText service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future detectDocumentTextAsync( final DetectDocumentTextRequest detectDocumentTextRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public DetectDocumentTextResult call() throws Exception { DetectDocumentTextResult result = null; try { result = detectDocumentText(detectDocumentTextRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(detectDocumentTextRequest, result); return result; } }); } /** *

* 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 KEY * Block object and a VALUE Block 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 CELL Block object is * returned for each cell in a table. *

    *
  • *
  • *

    * Lines and words of text. A LINE Block object contains one or * more WORD Block 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 the StartDocumentAnalysis * 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. *

* * @param getDocumentAnalysisRequest * @return A Java Future object containing the response from the * GetDocumentAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InvalidJobIdException * @throws InternalServerErrorException * @throws ThrottlingException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future getDocumentAnalysisAsync( final GetDocumentAnalysisRequest getDocumentAnalysisRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public GetDocumentAnalysisResult call() throws Exception { return getDocumentAnalysis(getDocumentAnalysisRequest); } }); } /** *

* 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 KEY * Block object and a VALUE Block 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 CELL Block object is * returned for each cell in a table. *

    *
  • *
  • *

    * Lines and words of text. A LINE Block object contains one or * more WORD Block 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 the StartDocumentAnalysis * 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. *

* * @param getDocumentAnalysisRequest * @return A Java Future object containing the response from the * GetDocumentAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InvalidJobIdException * @throws InternalServerErrorException * @throws ThrottlingException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future getDocumentAnalysisAsync( final GetDocumentAnalysisRequest getDocumentAnalysisRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public GetDocumentAnalysisResult call() throws Exception { GetDocumentAnalysisResult result = null; try { result = getDocumentAnalysis(getDocumentAnalysisRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(getDocumentAnalysisRequest, result); return result; } }); } /** *

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

* * @param getDocumentTextDetectionRequest * @return A Java Future object containing the response from the * GetDocumentTextDetection service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InvalidJobIdException * @throws InternalServerErrorException * @throws ThrottlingException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future getDocumentTextDetectionAsync( final GetDocumentTextDetectionRequest getDocumentTextDetectionRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public GetDocumentTextDetectionResult call() throws Exception { return getDocumentTextDetection(getDocumentTextDetectionRequest); } }); } /** *

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

* * @param getDocumentTextDetectionRequest * @return A Java Future object containing the response from the * GetDocumentTextDetection service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InvalidJobIdException * @throws InternalServerErrorException * @throws ThrottlingException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future getDocumentTextDetectionAsync( final GetDocumentTextDetectionRequest getDocumentTextDetectionRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public GetDocumentTextDetectionResult call() throws Exception { GetDocumentTextDetectionResult result = null; try { result = getDocumentTextDetection(getDocumentTextDetectionRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(getDocumentTextDetectionRequest, result); return result; } }); } /** *

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

* * @param getExpenseAnalysisRequest * @return A Java Future object containing the response from the * GetExpenseAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InvalidJobIdException * @throws InternalServerErrorException * @throws ThrottlingException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future getExpenseAnalysisAsync( final GetExpenseAnalysisRequest getExpenseAnalysisRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public GetExpenseAnalysisResult call() throws Exception { return getExpenseAnalysis(getExpenseAnalysisRequest); } }); } /** *

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

* * @param getExpenseAnalysisRequest * @return A Java Future object containing the response from the * GetExpenseAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InvalidJobIdException * @throws InternalServerErrorException * @throws ThrottlingException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future getExpenseAnalysisAsync( final GetExpenseAnalysisRequest getExpenseAnalysisRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public GetExpenseAnalysisResult call() throws Exception { GetExpenseAnalysisResult result = null; try { result = getExpenseAnalysis(getExpenseAnalysisRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(getExpenseAnalysisRequest, result); return result; } }); } /** *

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

* * @param getLendingAnalysisRequest * @return A Java Future object containing the response from the * GetLendingAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InvalidJobIdException * @throws InternalServerErrorException * @throws ThrottlingException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future getLendingAnalysisAsync( final GetLendingAnalysisRequest getLendingAnalysisRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public GetLendingAnalysisResult call() throws Exception { return getLendingAnalysis(getLendingAnalysisRequest); } }); } /** *

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

* * @param getLendingAnalysisRequest * @return A Java Future object containing the response from the * GetLendingAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InvalidJobIdException * @throws InternalServerErrorException * @throws ThrottlingException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future getLendingAnalysisAsync( final GetLendingAnalysisRequest getLendingAnalysisRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public GetLendingAnalysisResult call() throws Exception { GetLendingAnalysisResult result = null; try { result = getLendingAnalysis(getLendingAnalysisRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(getLendingAnalysisRequest, result); return result; } }); } /** *

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

* * @param getLendingAnalysisSummaryRequest * @return A Java Future object containing the response from the * GetLendingAnalysisSummary service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InvalidJobIdException * @throws InternalServerErrorException * @throws ThrottlingException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future getLendingAnalysisSummaryAsync( final GetLendingAnalysisSummaryRequest getLendingAnalysisSummaryRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public GetLendingAnalysisSummaryResult call() throws Exception { return getLendingAnalysisSummary(getLendingAnalysisSummaryRequest); } }); } /** *

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

* * @param getLendingAnalysisSummaryRequest * @return A Java Future object containing the response from the * GetLendingAnalysisSummary service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InvalidJobIdException * @throws InternalServerErrorException * @throws ThrottlingException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future getLendingAnalysisSummaryAsync( final GetLendingAnalysisSummaryRequest getLendingAnalysisSummaryRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public GetLendingAnalysisSummaryResult call() throws Exception { GetLendingAnalysisSummaryResult result = null; try { result = getLendingAnalysisSummary(getLendingAnalysisSummaryRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(getLendingAnalysisSummaryRequest, result); return result; } }); } /** *

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

* * @param startDocumentAnalysisRequest * @return A Java Future object containing the response from the * StartDocumentAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws IdempotentParameterMismatchException * @throws ThrottlingException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future startDocumentAnalysisAsync( final StartDocumentAnalysisRequest startDocumentAnalysisRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public StartDocumentAnalysisResult call() throws Exception { return startDocumentAnalysis(startDocumentAnalysisRequest); } }); } /** *

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

* * @param startDocumentAnalysisRequest * @return A Java Future object containing the response from the * StartDocumentAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws IdempotentParameterMismatchException * @throws ThrottlingException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future startDocumentAnalysisAsync( final StartDocumentAnalysisRequest startDocumentAnalysisRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public StartDocumentAnalysisResult call() throws Exception { StartDocumentAnalysisResult result = null; try { result = startDocumentAnalysis(startDocumentAnalysisRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(startDocumentAnalysisRequest, result); return result; } }); } /** *

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

* * @param startDocumentTextDetectionRequest * @return A Java Future object containing the response from the * StartDocumentTextDetection service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws IdempotentParameterMismatchException * @throws ThrottlingException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future startDocumentTextDetectionAsync( final StartDocumentTextDetectionRequest startDocumentTextDetectionRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public StartDocumentTextDetectionResult call() throws Exception { return startDocumentTextDetection(startDocumentTextDetectionRequest); } }); } /** *

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

* * @param startDocumentTextDetectionRequest * @return A Java Future object containing the response from the * StartDocumentTextDetection service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws IdempotentParameterMismatchException * @throws ThrottlingException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future startDocumentTextDetectionAsync( final StartDocumentTextDetectionRequest startDocumentTextDetectionRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public StartDocumentTextDetectionResult call() throws Exception { StartDocumentTextDetectionResult result = null; try { result = startDocumentTextDetection(startDocumentTextDetectionRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(startDocumentTextDetectionRequest, result); return result; } }); } /** *

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

* * @param startExpenseAnalysisRequest * @return A Java Future object containing the response from the * StartExpenseAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws IdempotentParameterMismatchException * @throws ThrottlingException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future startExpenseAnalysisAsync( final StartExpenseAnalysisRequest startExpenseAnalysisRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public StartExpenseAnalysisResult call() throws Exception { return startExpenseAnalysis(startExpenseAnalysisRequest); } }); } /** *

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

* * @param startExpenseAnalysisRequest * @return A Java Future object containing the response from the * StartExpenseAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws IdempotentParameterMismatchException * @throws ThrottlingException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future startExpenseAnalysisAsync( final StartExpenseAnalysisRequest startExpenseAnalysisRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public StartExpenseAnalysisResult call() throws Exception { StartExpenseAnalysisResult result = null; try { result = startExpenseAnalysis(startExpenseAnalysisRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(startExpenseAnalysisRequest, result); return result; } }); } /** *

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

    *
  • *
* * @param startLendingAnalysisRequest * @return A Java Future object containing the response from the * StartLendingAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws IdempotentParameterMismatchException * @throws ThrottlingException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future startLendingAnalysisAsync( final StartLendingAnalysisRequest startLendingAnalysisRequest) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public StartLendingAnalysisResult call() throws Exception { return startLendingAnalysis(startLendingAnalysisRequest); } }); } /** *

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

    *
  • *
* * @param startLendingAnalysisRequest * @return A Java Future object containing the response from the * StartLendingAnalysis service method, as returned by Amazon * Textract. * @throws InvalidParameterException * @throws InvalidS3ObjectException * @throws InvalidKMSKeyException * @throws UnsupportedDocumentException * @throws DocumentTooLargeException * @throws BadDocumentException * @throws AccessDeniedException * @throws ProvisionedThroughputExceededException * @throws InternalServerErrorException * @throws IdempotentParameterMismatchException * @throws ThrottlingException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Textract indicating either a problem with the data in the * request, or a server side issue. */ public Future startLendingAnalysisAsync( final StartLendingAnalysisRequest startLendingAnalysisRequest, final AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException { return executorService.submit(new Callable() { public StartLendingAnalysisResult call() throws Exception { StartLendingAnalysisResult result = null; try { result = startLendingAnalysis(startLendingAnalysisRequest); } catch (Exception ex) { asyncHandler.onError(ex); throw ex; } asyncHandler.onSuccess(startLendingAnalysisRequest, result); return result; } }); } }