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:

  • Method Details

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.