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(value="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 and Description
static interface	EntityRecognizerEvaluationMetrics.Builder

Method Summary

Modifier and Type	Method and Description
static EntityRecognizerEvaluationMetrics.Builder	builder()
boolean	equals(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() 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

precision

public 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 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 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. The highest score is 1, and the worst score is 0.

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. The highest score is 1, and the worst score is 0.

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