Class EntityRecognizerEvaluationMetrics

java.lang.Object
software.amazon.awssdk.services.comprehend.model.EntityRecognizerEvaluationMetrics
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EntityRecognizerEvaluationMetrics.Builder,EntityRecognizerEvaluationMetrics>
@Generated("software.amazon.awssdk:codegen") public final class EntityRecognizerEvaluationMetrics extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EntityRecognizerEvaluationMetrics.Builder,EntityRecognizerEvaluationMetrics>

Detailed information about the accuracy of an entity recognizer.

See Also:

  • Method Details

    • precision

      public final Double precision()

      A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

      Returns:
      A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

    • recall

      public final Double recall()

      A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.

      Returns:
      A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.

    • f1Score

      public final Double f1Score()

      A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.

      Returns:
      A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.

    • toBuilder

      public EntityRecognizerEvaluationMetrics.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<EntityRecognizerEvaluationMetrics.Builder,EntityRecognizerEvaluationMetrics>
      Returns:
      a builder for type T

    • builder

      public static EntityRecognizerEvaluationMetrics.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EntityRecognizerEvaluationMetrics.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.