@Generated(value="software.amazon.awssdk:codegen") public final class AnalyzeDocumentRequest extends TextractRequest implements ToCopyableBuilder<AnalyzeDocumentRequest.Builder,AnalyzeDocumentRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
AnalyzeDocumentRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static AnalyzeDocumentRequest.Builder |
builder() |
Document |
document()
The input document as base64-encoded bytes or an Amazon S3 object.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<FeatureType> |
featureTypes()
A list of the types of analysis to perform.
|
List<String> |
featureTypesAsStrings()
A list of the types of analysis to perform.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasFeatureTypes()
For responses, this returns true if the service returned a value for the FeatureTypes property.
|
int |
hashCode() |
HumanLoopConfig |
humanLoopConfig()
Sets the configuration for the human in the loop workflow for analyzing documents.
|
QueriesConfig |
queriesConfig()
Contains Queries and the alias for those Queries, as determined by the input.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AnalyzeDocumentRequest.Builder> |
serializableBuilderClass() |
AnalyzeDocumentRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final 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, PNG, PDF, or TIFF format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are
passed using the Bytes field.
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.
public final List<FeatureType> 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. Add SIGNATURES to return the
locations of detected signatures. To perform both forms and table analysis, add TABLES and FORMS to
FeatureTypes. To detect signatures within form data and table data, add SIGNATURES to either TABLES
or FORMS. All lines and words detected in the document are included in the response (including text that isn't
related to the value of FeatureTypes).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasFeatureTypes() method.
FeatureTypes. To detect signatures within form data and table data, add SIGNATURES to either
TABLES or FORMS. All lines and words detected in the document are included in the response (including
text that isn't related to the value of FeatureTypes).public final boolean hasFeatureTypes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> featureTypesAsStrings()
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that
are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the
locations of detected signatures. To perform both forms and table analysis, add TABLES and FORMS to
FeatureTypes. To detect signatures within form data and table data, add SIGNATURES to either TABLES
or FORMS. All lines and words detected in the document are included in the response (including text that isn't
related to the value of FeatureTypes).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasFeatureTypes() method.
FeatureTypes. To detect signatures within form data and table data, add SIGNATURES to either
TABLES or FORMS. All lines and words detected in the document are included in the response (including
text that isn't related to the value of FeatureTypes).public final HumanLoopConfig humanLoopConfig()
Sets the configuration for the human in the loop workflow for analyzing documents.
public final QueriesConfig queriesConfig()
Contains Queries and the alias for those Queries, as determined by the input.
public AnalyzeDocumentRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<AnalyzeDocumentRequest.Builder,AnalyzeDocumentRequest>toBuilder in class TextractRequestpublic static AnalyzeDocumentRequest.Builder builder()
public static Class<? extends AnalyzeDocumentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.