software.amazon.awssdk.services.comprehend.model

Class ClassifierMetadata

java.lang.Object

software.amazon.awssdk.services.comprehend.model.ClassifierMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClassifierMetadata.Builder,ClassifierMetadata>

@Generated(value="software.amazon.awssdk:codegen")
public final class ClassifierMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClassifierMetadata.Builder,ClassifierMetadata>

Provides information about a document classifier.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClassifierMetadata.Builder

Method Summary

Modifier and Type	Method and Description
static ClassifierMetadata.Builder	builder()
boolean	equals(Object obj)
ClassifierEvaluationMetrics	evaluationMetrics() Describes the result metrics for the test data associated with an documentation classifier.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	numberOfLabels() The number of labels in the input data.
Integer	numberOfTestDocuments() The number of documents in the input data that were used to test the classifier.
Integer	numberOfTrainedDocuments() The number of documents in the input data that were used to train the classifier.
List<SdkField<?>>	sdkFields()
static Class<? extends ClassifierMetadata.Builder>	serializableBuilderClass()
ClassifierMetadata.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

numberOfLabels

public Integer numberOfLabels()

The number of labels in the input data.

Returns:

The number of labels in the input data.

numberOfTrainedDocuments

public Integer numberOfTrainedDocuments()

The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.

Returns:

The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.

numberOfTestDocuments

public Integer numberOfTestDocuments()

The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents.

Returns:

The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents.

evaluationMetrics

public ClassifierEvaluationMetrics evaluationMetrics()

Describes the result metrics for the test data associated with an documentation classifier.

Returns:

Describes the result metrics for the test data associated with an documentation classifier.

toBuilder

public ClassifierMetadata.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<ClassifierMetadata.Builder,ClassifierMetadata>

Returns:

a builder for type T

builder

public static ClassifierMetadata.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public 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.