software.amazon.awssdk.services.comprehend.model

Interface ClassifyDocumentResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, ComprehendResponse.Builder, CopyableBuilder<ClassifyDocumentResponse.Builder,ClassifyDocumentResponse>, SdkBuilder<ClassifyDocumentResponse.Builder,ClassifyDocumentResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ClassifyDocumentResponse

public static interface ClassifyDocumentResponse.Builder
extends ComprehendResponse.Builder, SdkPojo, CopyableBuilder<ClassifyDocumentResponse.Builder,ClassifyDocumentResponse>

Method Summary

Modifier and Type	Method and Description
ClassifyDocumentResponse.Builder	classes(Collection<DocumentClass> classes) The classes used by the document being analyzed.
ClassifyDocumentResponse.Builder	classes(Consumer<DocumentClass.Builder>... classes) The classes used by the document being analyzed.
ClassifyDocumentResponse.Builder	classes(DocumentClass... classes) The classes used by the document being analyzed.
default ClassifyDocumentResponse.Builder	documentMetadata(Consumer<DocumentMetadata.Builder> documentMetadata) Extraction information about the document.
ClassifyDocumentResponse.Builder	documentMetadata(DocumentMetadata documentMetadata) Extraction information about the document.
ClassifyDocumentResponse.Builder	documentType(Collection<DocumentTypeListItem> documentType) The document type for each page in the input document.
ClassifyDocumentResponse.Builder	documentType(Consumer<DocumentTypeListItem.Builder>... documentType) The document type for each page in the input document.
ClassifyDocumentResponse.Builder	documentType(DocumentTypeListItem... documentType) The document type for each page in the input document.
ClassifyDocumentResponse.Builder	errors(Collection<ErrorsListItem> errors) Page-level errors that the system detected while processing the input document.
ClassifyDocumentResponse.Builder	errors(Consumer<ErrorsListItem.Builder>... errors) Page-level errors that the system detected while processing the input document.
ClassifyDocumentResponse.Builder	errors(ErrorsListItem... errors) Page-level errors that the system detected while processing the input document.
ClassifyDocumentResponse.Builder	labels(Collection<DocumentLabel> labels) The labels used the document being analyzed.
ClassifyDocumentResponse.Builder	labels(Consumer<DocumentLabel.Builder>... labels) The labels used the document being analyzed.
ClassifyDocumentResponse.Builder	labels(DocumentLabel... labels) The labels used the document being analyzed.
ClassifyDocumentResponse.Builder	warnings(Collection<WarningsListItem> warnings) Warnings detected while processing the input document.
ClassifyDocumentResponse.Builder	warnings(Consumer<WarningsListItem.Builder>... warnings) Warnings detected while processing the input document.
ClassifyDocumentResponse.Builder	warnings(WarningsListItem... warnings) Warnings detected while processing the input document.

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

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

classes

ClassifyDocumentResponse.Builder classes(Collection<DocumentClass> classes)

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

Parameters:

classes - The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

Returns:

Returns a reference to this object so that method calls can be chained together.

classes

ClassifyDocumentResponse.Builder classes(DocumentClass... classes)

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

Parameters:

classes - The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

Returns:

Returns a reference to this object so that method calls can be chained together.

classes

ClassifyDocumentResponse.Builder classes(Consumer<DocumentClass.Builder>... classes)

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #classes(List).

Parameters:

classes - a consumer that will call methods on DocumentClass.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#classes(java.util.Collection)

labels

ClassifyDocumentResponse.Builder labels(Collection<DocumentLabel> labels)

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

Parameters:

labels - The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

Returns:

Returns a reference to this object so that method calls can be chained together.

labels

ClassifyDocumentResponse.Builder labels(DocumentLabel... labels)

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

Parameters:

labels - The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

Returns:

Returns a reference to this object so that method calls can be chained together.

labels

ClassifyDocumentResponse.Builder labels(Consumer<DocumentLabel.Builder>... labels)

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #labels(List).

Parameters:

labels - a consumer that will call methods on DocumentLabel.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#labels(java.util.Collection)

documentMetadata

ClassifyDocumentResponse.Builder documentMetadata(DocumentMetadata documentMetadata)

Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.

Parameters:

documentMetadata - Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentMetadata

default ClassifyDocumentResponse.Builder documentMetadata(Consumer<DocumentMetadata.Builder> documentMetadata)

Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.

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

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

Parameters:

documentMetadata - a consumer that will call methods on DocumentMetadata.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

documentMetadata(DocumentMetadata)

documentType

ClassifyDocumentResponse.Builder documentType(Collection<DocumentTypeListItem> documentType)

The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

Parameters:

documentType - The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentType

ClassifyDocumentResponse.Builder documentType(DocumentTypeListItem... documentType)

The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

Parameters:

documentType - The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentType

ClassifyDocumentResponse.Builder documentType(Consumer<DocumentTypeListItem.Builder>... documentType)

The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #documentType(List).

Parameters:

documentType - a consumer that will call methods on DocumentTypeListItem.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#documentType(java.util.Collection)

errors

ClassifyDocumentResponse.Builder errors(Collection<ErrorsListItem> errors)

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

Parameters:

errors - Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

Returns:

Returns a reference to this object so that method calls can be chained together.

errors

ClassifyDocumentResponse.Builder errors(ErrorsListItem... errors)

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

Parameters:

errors - Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

Returns:

Returns a reference to this object so that method calls can be chained together.

errors

ClassifyDocumentResponse.Builder errors(Consumer<ErrorsListItem.Builder>... errors)

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #errors(List).

Parameters:

errors - a consumer that will call methods on ErrorsListItem.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#errors(java.util.Collection)

warnings

ClassifyDocumentResponse.Builder warnings(Collection<WarningsListItem> warnings)

Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

The field is empty if the system generated no warnings.

Parameters:

warnings - Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

The field is empty if the system generated no warnings.

Returns:

Returns a reference to this object so that method calls can be chained together.

warnings

ClassifyDocumentResponse.Builder warnings(WarningsListItem... warnings)

Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

The field is empty if the system generated no warnings.

Parameters:

warnings - Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

The field is empty if the system generated no warnings.

Returns:

Returns a reference to this object so that method calls can be chained together.

warnings

ClassifyDocumentResponse.Builder warnings(Consumer<WarningsListItem.Builder>... warnings)

Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

The field is empty if the system generated no warnings.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #warnings(List).

Parameters:

warnings - a consumer that will call methods on WarningsListItem.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#warnings(java.util.Collection)