Class ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder (2.43.0)

public static final class ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder extends GeneratedMessageV3.Builder<ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder> implements ClassificationEvaluationMetrics.ConfidenceMetricsEntryOrBuilder

Metrics for a single confidence threshold.

Protobuf type google.cloud.automl.v1.ClassificationEvaluationMetrics.ConfidenceMetricsEntry

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides

build()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry build()
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry

buildPartial()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry buildPartial()
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry

clear()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clear()
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides

clearConfidenceThreshold()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearConfidenceThreshold()

Output only. Metrics are computed with an assumption that the model never returns predictions with score lower than this value.

float confidence_threshold = 1;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearF1Score()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearF1Score()

Output only. The harmonic mean of recall and precision.

float f1_score = 4;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearF1ScoreAt1()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearF1ScoreAt1()

Output only. The harmonic mean of recall_at1 and precision_at1.

float f1_score_at1 = 7;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearFalseNegativeCount()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearFalseNegativeCount()

Output only. The number of ground truth labels that are not matched by a model created label.

int64 false_negative_count = 12;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearFalsePositiveCount()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearFalsePositiveCount()

Output only. The number of model created labels that do not match a ground truth label.

int64 false_positive_count = 11;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearFalsePositiveRate()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearFalsePositiveRate()

Output only. False Positive Rate for the given confidence threshold.

float false_positive_rate = 8;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearFalsePositiveRateAt1()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearFalsePositiveRateAt1()

Output only. The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each example.

float false_positive_rate_at1 = 9;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides

clearPositionThreshold()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearPositionThreshold()

Output only. Metrics are computed with an assumption that the model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the confidence_threshold.

int32 position_threshold = 14;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearPrecision()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearPrecision()

Output only. Precision for the given confidence threshold.

float precision = 3;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearPrecisionAt1()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearPrecisionAt1()

Output only. The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each example.

float precision_at1 = 6;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearRecall()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearRecall()

Output only. Recall (True Positive Rate) for the given confidence threshold.

float recall = 2;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearRecallAt1()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearRecallAt1()

Output only. The Recall (True Positive Rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each example.

float recall_at1 = 5;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearTrueNegativeCount()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearTrueNegativeCount()

Output only. The number of labels that were not created by the model, but if they would, they would not match a ground truth label.

int64 true_negative_count = 13;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clearTruePositiveCount()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clearTruePositiveCount()

Output only. The number of model created labels that match a ground truth label.

int64 true_positive_count = 10;

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

clone()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder clone()
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides

getConfidenceThreshold()

public float getConfidenceThreshold()

Output only. Metrics are computed with an assumption that the model never returns predictions with score lower than this value.

float confidence_threshold = 1;

Returns
Type Description
float

The confidenceThreshold.

getDefaultInstanceForType()

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry getDefaultInstanceForType()
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getF1Score()

public float getF1Score()

Output only. The harmonic mean of recall and precision.

float f1_score = 4;

Returns
Type Description
float

The f1Score.

getF1ScoreAt1()

public float getF1ScoreAt1()

Output only. The harmonic mean of recall_at1 and precision_at1.

float f1_score_at1 = 7;

Returns
Type Description
float

The f1ScoreAt1.

getFalseNegativeCount()

public long getFalseNegativeCount()

Output only. The number of ground truth labels that are not matched by a model created label.

int64 false_negative_count = 12;

Returns
Type Description
long

The falseNegativeCount.

getFalsePositiveCount()

public long getFalsePositiveCount()

Output only. The number of model created labels that do not match a ground truth label.

int64 false_positive_count = 11;

Returns
Type Description
long

The falsePositiveCount.

getFalsePositiveRate()

public float getFalsePositiveRate()

Output only. False Positive Rate for the given confidence threshold.

float false_positive_rate = 8;

Returns
Type Description
float

The falsePositiveRate.

getFalsePositiveRateAt1()

public float getFalsePositiveRateAt1()

Output only. The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each example.

float false_positive_rate_at1 = 9;

Returns
Type Description
float

The falsePositiveRateAt1.

getPositionThreshold()

public int getPositionThreshold()

Output only. Metrics are computed with an assumption that the model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the confidence_threshold.

int32 position_threshold = 14;

Returns
Type Description
int

The positionThreshold.

getPrecision()

public float getPrecision()

Output only. Precision for the given confidence threshold.

float precision = 3;

Returns
Type Description
float

The precision.

getPrecisionAt1()

public float getPrecisionAt1()

Output only. The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each example.

float precision_at1 = 6;

Returns
Type Description
float

The precisionAt1.

getRecall()

public float getRecall()

Output only. Recall (True Positive Rate) for the given confidence threshold.

float recall = 2;

Returns
Type Description
float

The recall.

getRecallAt1()

public float getRecallAt1()

Output only. The Recall (True Positive Rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each example.

float recall_at1 = 5;

Returns
Type Description
float

The recallAt1.

getTrueNegativeCount()

public long getTrueNegativeCount()

Output only. The number of labels that were not created by the model, but if they would, they would not match a ground truth label.

int64 true_negative_count = 13;

Returns
Type Description
long

The trueNegativeCount.

getTruePositiveCount()

public long getTruePositiveCount()

Output only. The number of model created labels that match a ground truth label.

int64 true_positive_count = 10;

Returns
Type Description
long

The truePositiveCount.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ClassificationEvaluationMetrics.ConfidenceMetricsEntry other)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder mergeFrom(ClassificationEvaluationMetrics.ConfidenceMetricsEntry other)
Parameter
Name Description
other ClassificationEvaluationMetrics.ConfidenceMetricsEntry
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides

setConfidenceThreshold(float value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setConfidenceThreshold(float value)

Output only. Metrics are computed with an assumption that the model never returns predictions with score lower than this value.

float confidence_threshold = 1;

Parameter
Name Description
value float

The confidenceThreshold to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setF1Score(float value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setF1Score(float value)

Output only. The harmonic mean of recall and precision.

float f1_score = 4;

Parameter
Name Description
value float

The f1Score to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setF1ScoreAt1(float value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setF1ScoreAt1(float value)

Output only. The harmonic mean of recall_at1 and precision_at1.

float f1_score_at1 = 7;

Parameter
Name Description
value float

The f1ScoreAt1 to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setFalseNegativeCount(long value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setFalseNegativeCount(long value)

Output only. The number of ground truth labels that are not matched by a model created label.

int64 false_negative_count = 12;

Parameter
Name Description
value long

The falseNegativeCount to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setFalsePositiveCount(long value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setFalsePositiveCount(long value)

Output only. The number of model created labels that do not match a ground truth label.

int64 false_positive_count = 11;

Parameter
Name Description
value long

The falsePositiveCount to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setFalsePositiveRate(float value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setFalsePositiveRate(float value)

Output only. False Positive Rate for the given confidence threshold.

float false_positive_rate = 8;

Parameter
Name Description
value float

The falsePositiveRate to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setFalsePositiveRateAt1(float value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setFalsePositiveRateAt1(float value)

Output only. The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each example.

float false_positive_rate_at1 = 9;

Parameter
Name Description
value float

The falsePositiveRateAt1 to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides

setPositionThreshold(int value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setPositionThreshold(int value)

Output only. Metrics are computed with an assumption that the model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the confidence_threshold.

int32 position_threshold = 14;

Parameter
Name Description
value int

The positionThreshold to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setPrecision(float value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setPrecision(float value)

Output only. Precision for the given confidence threshold.

float precision = 3;

Parameter
Name Description
value float

The precision to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setPrecisionAt1(float value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setPrecisionAt1(float value)

Output only. The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each example.

float precision_at1 = 6;

Parameter
Name Description
value float

The precisionAt1 to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setRecall(float value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setRecall(float value)

Output only. Recall (True Positive Rate) for the given confidence threshold.

float recall = 2;

Parameter
Name Description
value float

The recall to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setRecallAt1(float value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setRecallAt1(float value)

Output only. The Recall (True Positive Rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each example.

float recall_at1 = 5;

Parameter
Name Description
value float

The recallAt1 to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides

setTrueNegativeCount(long value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setTrueNegativeCount(long value)

Output only. The number of labels that were not created by the model, but if they would, they would not match a ground truth label.

int64 true_negative_count = 13;

Parameter
Name Description
value long

The trueNegativeCount to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setTruePositiveCount(long value)

public ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setTruePositiveCount(long value)

Output only. The number of model created labels that match a ground truth label.

int64 true_positive_count = 10;

Parameter
Name Description
value long

The truePositiveCount to set.

Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry.Builder
Overrides