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

Interface EntityTypesEvaluationMetrics.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EntityTypesEvaluationMetrics.Builder,EntityTypesEvaluationMetrics>, SdkBuilder<EntityTypesEvaluationMetrics.Builder,EntityTypesEvaluationMetrics>, SdkPojo

Enclosing class:

EntityTypesEvaluationMetrics

public static interface EntityTypesEvaluationMetrics.Builder
extends SdkPojo, CopyableBuilder<EntityTypesEvaluationMetrics.Builder,EntityTypesEvaluationMetrics>

Method Summary

Modifier and Type	Method	Description
EntityTypesEvaluationMetrics.Builder	f1Score(Double f1Score)	A measure of how accurate the recognizer results are for a specific entity type in the test data.
EntityTypesEvaluationMetrics.Builder	precision(Double precision)	A measure of the usefulness of the recognizer results for a specific entity type in the test data.
EntityTypesEvaluationMetrics.Builder	recall(Double recall)	A measure of how complete the recognizer results are for a specific entity type in the test data.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

precision

EntityTypesEvaluationMetrics.Builder precision(Double precision)

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

Parameters:

precision - A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

Returns:

Returns a reference to this object so that method calls can be chained together.

recall

EntityTypesEvaluationMetrics.Builder recall(Double recall)

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

Parameters:

recall - A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

Returns:

Returns a reference to this object so that method calls can be chained together.

f1Score

EntityTypesEvaluationMetrics.Builder f1Score(Double f1Score)

A measure of how accurate the recognizer results are for a specific entity type in 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.

Parameters:

f1Score - A measure of how accurate the recognizer results are for a specific entity type in 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:

Returns a reference to this object so that method calls can be chained together.