software.amazon.awssdk.services.comprehend.model

Interface ClassifyDocumentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ComprehendRequest.Builder, CopyableBuilder<ClassifyDocumentRequest.Builder,ClassifyDocumentRequest>, SdkBuilder<ClassifyDocumentRequest.Builder,ClassifyDocumentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ClassifyDocumentRequest

public static interface ClassifyDocumentRequest.Builder
extends ComprehendRequest.Builder, SdkPojo, CopyableBuilder<ClassifyDocumentRequest.Builder,ClassifyDocumentRequest>

Method Summary

Modifier and Type	Method and Description
ClassifyDocumentRequest.Builder	bytes(SdkBytes bytes) Use the Bytes parameter to input a text, PDF, Word or image file.
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.
ClassifyDocumentRequest.Builder	documentReaderConfig(DocumentReaderConfig documentReaderConfig) Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
ClassifyDocumentRequest.Builder	endpointArn(String endpointArn) The Amazon Resource Number (ARN) of the endpoint.
ClassifyDocumentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ClassifyDocumentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ClassifyDocumentRequest.Builder	text(String text) The document text to be analyzed.

Methods inherited from interface software.amazon.awssdk.services.comprehend.model.ComprehendRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

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 information about endpoints, see Managing endpoints.

Parameters:

endpointArn - The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see Managing 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. You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

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. You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

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:

documentReaderConfig(DocumentReaderConfig)

overrideConfiguration

ClassifyDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ClassifyDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder