AbstractAmazonTextract (AWS Java SDK for Amazon Textract 1.12.285 API)

java.lang.Object
- com.amazonaws.services.textract.AbstractAmazonTextract

All Implemented Interfaces:

AmazonTextract

Direct Known Subclasses:

AbstractAmazonTextractAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonTextract
extends Object
implements AmazonTextract
```
Abstract implementation of AmazonTextract. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.textract.AmazonTextract
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAmazonTextract()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAmazonTextract()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalyzeDocumentResult`	`analyzeDocument(AnalyzeDocumentRequest request)` Analyzes an input document for relationships between detected items.
`AnalyzeExpenseResult`	`analyzeExpense(AnalyzeExpenseRequest request)` `AnalyzeExpense` synchronously analyzes an input document for financially related relationships between text.
`AnalyzeIDResult`	`analyzeID(AnalyzeIDRequest request)` Analyzes identity documents for relevant information.
`DetectDocumentTextResult`	`detectDocumentText(DetectDocumentTextRequest request)` Detects text in the input document.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDocumentAnalysisResult`	`getDocumentAnalysis(GetDocumentAnalysisRequest request)` Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
`GetDocumentTextDetectionResult`	`getDocumentTextDetection(GetDocumentTextDetectionRequest request)` Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
`GetExpenseAnalysisResult`	`getExpenseAnalysis(GetExpenseAnalysisRequest request)` Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDocumentAnalysisResult`	`startDocumentAnalysis(StartDocumentAnalysisRequest request)` Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
`StartDocumentTextDetectionResult`	`startDocumentTextDetection(StartDocumentTextDetectionRequest request)` Starts the asynchronous detection of text in a document.
`StartExpenseAnalysisResult`	`startExpenseAnalysis(StartExpenseAnalysisRequest request)` Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAmazonTextract
```
protected AbstractAmazonTextract()
```
- Method Detail
  - analyzeDocument
```
public AnalyzeDocumentResult analyzeDocument(AnalyzeDocumentRequest request)
```
    Description copied from interface: AmazonTextract
    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 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 FeatureTypes).
    - Queries.A QUERIES_RESULT Block object contains the answer to the query, the alias associated and an ID that connect it to the query asked. This Block also contains a location and attached 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.
    Specified by:
    
    analyzeDocument in interface AmazonTextract
    
    Returns:
    
    Result of the AnalyzeDocument operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - analyzeExpense
```
public AnalyzeExpenseResult analyzeExpense(AnalyzeExpenseRequest request)
```
    Description copied from interface: AmazonTextract
    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.
    Specified by:
    
    analyzeExpense in interface AmazonTextract
    
    Returns:
    
    Result of the AnalyzeExpense operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - analyzeID
```
public AnalyzeIDResult analyzeID(AnalyzeIDRequest request)
```
    Description copied from interface: AmazonTextract
    
    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.
    
    Specified by:
    
    analyzeID in interface AmazonTextract
    
    Returns:
    
    Result of the AnalyzeID operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectDocumentText
```
public DetectDocumentTextResult detectDocumentText(DetectDocumentTextRequest request)
```
    Description copied from interface: AmazonTextract
    
    Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPEG, PNG, PDF, or TIFF format. DetectDocumentText returns the detected text in an array of Block objects.
    
    Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.
    
    DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.
    
    For more information, see Document Text Detection.
    
    Specified by:
    
    detectDocumentText in interface AmazonTextract
    
    Returns:
    
    Result of the DetectDocumentText operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDocumentAnalysis
```
public GetDocumentAnalysisResult getDocumentAnalysis(GetDocumentAnalysisRequest request)
```
    Description copied from interface: AmazonTextract
    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).
    - Queries. A QUERIES_RESULT Block object contains the answer to the query, the alias associated and an ID that connect it to the query asked. This Block also contains a location and attached 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.
    
    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.
    Specified by:
    
    getDocumentAnalysis in interface AmazonTextract
    
    Returns:
    
    Result of the GetDocumentAnalysis operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDocumentTextDetection
```
public GetDocumentTextDetectionResult getDocumentTextDetection(GetDocumentTextDetectionRequest request)
```
    Description copied from interface: AmazonTextract
    
    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.
    
    Specified by:
    
    getDocumentTextDetection in interface AmazonTextract
    
    Returns:
    
    Result of the GetDocumentTextDetection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getExpenseAnalysis
```
public GetExpenseAnalysisResult getExpenseAnalysis(GetExpenseAnalysisRequest request)
```
    Description copied from interface: AmazonTextract
    
    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.
    
    Specified by:
    
    getExpenseAnalysis in interface AmazonTextract
    
    Returns:
    
    Result of the GetExpenseAnalysis operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startDocumentAnalysis
```
public StartDocumentAnalysisResult startDocumentAnalysis(StartDocumentAnalysisRequest request)
```
    Description copied from interface: AmazonTextract
    
    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.
    
    Specified by:
    
    startDocumentAnalysis in interface AmazonTextract
    
    Returns:
    
    Result of the StartDocumentAnalysis operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startDocumentTextDetection
```
public StartDocumentTextDetectionResult startDocumentTextDetection(StartDocumentTextDetectionRequest request)
```
    Description copied from interface: AmazonTextract
    
    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.
    
    Specified by:
    
    startDocumentTextDetection in interface AmazonTextract
    
    Returns:
    
    Result of the StartDocumentTextDetection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startExpenseAnalysis
```
public StartExpenseAnalysisResult startExpenseAnalysis(StartExpenseAnalysisRequest request)
```
    Description copied from interface: AmazonTextract
    
    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.
    
    Specified by:
    
    startExpenseAnalysis in interface AmazonTextract
    
    Returns:
    
    Result of the StartExpenseAnalysis operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonTextract
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonTextract
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonTextract
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonTextract
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AbstractAmazonTextract

Field Summary

Fields inherited from interface com.amazonaws.services.textract.AmazonTextract

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAmazonTextract

Method Detail

analyzeDocument

analyzeExpense

analyzeID

detectDocumentText

getDocumentAnalysis

getDocumentTextDetection

getExpenseAnalysis

startDocumentAnalysis

startDocumentTextDetection

startExpenseAnalysis

shutdown

getCachedResponseMetadata