Package software.amazon.awssdk.services.comprehend.model

Class ClassifyDocumentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.comprehend.model.ComprehendRequest

software.amazon.awssdk.services.comprehend.model.ClassifyDocumentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ClassifyDocumentRequest.Builder,ClassifyDocumentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ClassifyDocumentRequest
extends ComprehendRequest
implements ToCopyableBuilder<ClassifyDocumentRequest.Builder,ClassifyDocumentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClassifyDocumentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ClassifyDocumentRequest.Builder	builder()
SdkBytes	bytes()	Use the Bytes parameter to input a text, PDF, Word or image file.
DocumentReaderConfig	documentReaderConfig()	Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
String	endpointArn()	The Amazon Resource Number (ARN) of the endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ClassifyDocumentRequest.Builder>	serializableBuilderClass()
String	text()	The document text to be analyzed.
ClassifyDocumentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

text

public final String text()

The document text to be analyzed. If you enter text using this parameter, do not use the Bytes parameter.

Returns:

The document text to be analyzed. If you enter text using this parameter, do not use the Bytes parameter.

endpointArn

public final String endpointArn()

The Amazon Resource Number (ARN) of the endpoint.

For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide

For custom classification, you create an endpoint for your custom model. For more information, see Using Amazon Comprehend endpoints.

Returns:

The Amazon Resource Number (ARN) of the endpoint.

For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide

For custom classification, you create an endpoint for your custom model. For more information, see Using Amazon Comprehend endpoints.

bytes

public final SdkBytes bytes()

Use the Bytes parameter to input a text, PDF, Word or image file.

When you classify a document using a custom model, you can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

To classify a document using the prompt safety classifier, use the Text parameter for input.

Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode the document file bytes for you.

The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.

If you use the Bytes parameter, do not use the Text parameter.

Returns:

Use the Bytes parameter to input a text, PDF, Word or image file.

When you classify a document using a custom model, you can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

To classify a document using the prompt safety classifier, use the Text parameter for input.

Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode the document file bytes for you.

The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.

If you use the Bytes parameter, do not use the Text parameter.

documentReaderConfig

public final DocumentReaderConfig documentReaderConfig()

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

Returns:

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

toBuilder

public ClassifyDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClassifyDocumentRequest.Builder,ClassifyDocumentRequest>

Specified by:

toBuilder in class ComprehendRequest

builder

public static ClassifyDocumentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ClassifyDocumentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo