AnalyzeDocumentRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.textract.model.AnalyzeDocumentRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class AnalyzeDocumentRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
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).
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.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AnalyzeDocumentRequest()

Constructors
Constructor and Description
`AnalyzeDocumentRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`Document`	`getDocument()` The input document as base64-encoded bytes or an Amazon S3 object.
`java.util.List<java.lang.String>`	`getFeatureTypes()` A list of the types of analysis to perform.
`HumanLoopConfig`	`getHumanLoopConfig()` Sets the configuration for the human in the loop workflow for analyzing documents.
`int`	`hashCode()`
`void`	`setDocument(Document document)` The input document as base64-encoded bytes or an Amazon S3 object.
`void`	`setFeatureTypes(java.util.Collection<java.lang.String> featureTypes)` A list of the types of analysis to perform.
`void`	`setHumanLoopConfig(HumanLoopConfig humanLoopConfig)` Sets the configuration for the human in the loop workflow for analyzing documents.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AnalyzeDocumentRequest`	`withDocument(Document document)` The input document as base64-encoded bytes or an Amazon S3 object.
`AnalyzeDocumentRequest`	`withFeatureTypes(java.util.Collection<java.lang.String> featureTypes)` A list of the types of analysis to perform.
`AnalyzeDocumentRequest`	`withFeatureTypes(java.lang.String... featureTypes)` A list of the types of analysis to perform.
`AnalyzeDocumentRequest`	`withHumanLoopConfig(HumanLoopConfig humanLoopConfig)` Sets the configuration for the human in the loop workflow for analyzing documents.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AnalyzeDocumentRequest
```
public AnalyzeDocumentRequest()
```
- Method Detail
  - getDocument
```
public Document getDocument()
```
    The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
    
    If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
    
    Returns:
    
    The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
    
    If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
  - setDocument
```
public void setDocument(Document document)
```
    The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
    
    If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
    
    Parameters:
    
    document -
    The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
    
    If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
  - withDocument
```
public AnalyzeDocumentRequest withDocument(Document document)
```
    The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
    
    If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    document -
    The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
    
    If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFeatureTypes
```
public java.util.List<java.lang.String> getFeatureTypes()
```
    A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
    
    Returns:
    
    A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
  - setFeatureTypes
```
public void setFeatureTypes(java.util.Collection<java.lang.String> featureTypes)
```
    A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
    
    Parameters:
    
    featureTypes -
    A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
  - withFeatureTypes
```
public AnalyzeDocumentRequest withFeatureTypes(java.lang.String... featureTypes)
```
    A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    featureTypes -
    A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withFeatureTypes
```
public AnalyzeDocumentRequest withFeatureTypes(java.util.Collection<java.lang.String> featureTypes)
```
    A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    featureTypes -
    A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getHumanLoopConfig
```
public HumanLoopConfig getHumanLoopConfig()
```
    Sets the configuration for the human in the loop workflow for analyzing documents.
    
    Returns:
    
    Sets the configuration for the human in the loop workflow for analyzing documents.
  - setHumanLoopConfig
```
public void setHumanLoopConfig(HumanLoopConfig humanLoopConfig)
```
    Sets the configuration for the human in the loop workflow for analyzing documents.
    
    Parameters:
    
    humanLoopConfig -
    Sets the configuration for the human in the loop workflow for analyzing documents.
  - withHumanLoopConfig
```
public AnalyzeDocumentRequest withHumanLoopConfig(HumanLoopConfig humanLoopConfig)
```
    Sets the configuration for the human in the loop workflow for analyzing documents.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    humanLoopConfig -
    Sets the configuration for the human in the loop workflow for analyzing documents.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class AnalyzeDocumentRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AnalyzeDocumentRequest

Method Detail

getDocument

setDocument

withDocument

getFeatureTypes

setFeatureTypes

withFeatureTypes

withFeatureTypes

getHumanLoopConfig

setHumanLoopConfig

withHumanLoopConfig

toString

hashCode

equals