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>

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ClassifyDocumentRequest.Builder,ClassifyDocumentRequest>
      Specified by:
      toBuilder in class ComprehendRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.