Package 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("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	Description
static interface	ClassifierMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static ClassifierMetadata.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(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()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

numberOfLabels

public final Integer numberOfLabels()

The number of labels in the input data.

Returns:

The number of labels in the input data.

numberOfTrainedDocuments

public final 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 final 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, up to 10,000 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, up to 10,000 documents.

evaluationMetrics

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<ClassifierMetadata.Builder,ClassifierMetadata>

builder

public static ClassifierMetadata.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo