Package software.amazon.awssdk.services.comprehend.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntityRecognizerEvaluationMetrics.Builder

Method Summary

Modifier and Type	Method	Description
static EntityRecognizerEvaluationMetrics.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Double	f1Score()	A measure of how accurate the recognizer results are for the test data.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Double	precision()	A measure of the usefulness of the recognizer results in the test data.
Double	recall()	A measure of how complete the recognizer results are for the test data.
List<SdkField<?>>	sdkFields()
static Class<? extends EntityRecognizerEvaluationMetrics.Builder>	serializableBuilderClass()
EntityRecognizerEvaluationMetrics.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

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

Specified by:

toBuilder in interface ToCopyableBuilder<EntityRecognizerEvaluationMetrics.Builder,EntityRecognizerEvaluationMetrics>

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)

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