Interface ClassifyDocumentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ComprehendRequest.Builder, CopyableBuilder<ClassifyDocumentRequest.Builder,ClassifyDocumentRequest>, SdkBuilder<ClassifyDocumentRequest.Builder,ClassifyDocumentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ClassifyDocumentRequest
@Mutable @NotThreadSafe public static interface ClassifyDocumentRequest.Builder extends ComprehendRequest.Builder, SdkPojo, CopyableBuilder<ClassifyDocumentRequest.Builder,ClassifyDocumentRequest>

  • Method Details

    • text

      ClassifyDocumentRequest.Builder text(String text)

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

      Parameters:
      text - The document text to be analyzed. If you enter text using this parameter, do not use the Bytes parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointArn

      ClassifyDocumentRequest.Builder endpointArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • bytes

      ClassifyDocumentRequest.Builder bytes(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • documentReaderConfig

      ClassifyDocumentRequest.Builder documentReaderConfig(DocumentReaderConfig documentReaderConfig)

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

      Parameters:
      documentReaderConfig - Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentReaderConfig

      default ClassifyDocumentRequest.Builder documentReaderConfig(Consumer<DocumentReaderConfig.Builder> documentReaderConfig)

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

      This is a convenience method that creates an instance of the DocumentReaderConfig.Builder avoiding the need to create one manually via DocumentReaderConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentReaderConfig(DocumentReaderConfig).

      Parameters:
      documentReaderConfig - a consumer that will call methods on DocumentReaderConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ClassifyDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ClassifyDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.