Class Evaluation.Metrics.Builder (2.20.0)

public static final class Evaluation.Metrics.Builder extends GeneratedMessageV3.Builder<Evaluation.Metrics.Builder> implements Evaluation.MetricsOrBuilder

Evaluation metrics, either in aggregate or about a specific entity.

Protobuf type google.cloud.documentai.v1.Evaluation.Metrics

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.Metrics.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides

build()

public Evaluation.Metrics build()
Returns
TypeDescription
Evaluation.Metrics

buildPartial()

public Evaluation.Metrics buildPartial()
Returns
TypeDescription
Evaluation.Metrics

clear()

public Evaluation.Metrics.Builder clear()
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides

clearF1Score()

public Evaluation.Metrics.Builder clearF1Score()

The calculated f1 score.

float f1_score = 3;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clearFalseNegativesCount()

public Evaluation.Metrics.Builder clearFalseNegativesCount()

The amount of false negatives.

int32 false_negatives_count = 8;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clearFalsePositivesCount()

public Evaluation.Metrics.Builder clearFalsePositivesCount()

The amount of false positives.

int32 false_positives_count = 7;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Evaluation.Metrics.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides

clearGroundTruthDocumentCount()

public Evaluation.Metrics.Builder clearGroundTruthDocumentCount()

The amount of documents with a ground truth occurrence.

int32 ground_truth_document_count = 11;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clearGroundTruthOccurrencesCount()

public Evaluation.Metrics.Builder clearGroundTruthOccurrencesCount()

The amount of occurrences in ground truth documents.

int32 ground_truth_occurrences_count = 5;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Evaluation.Metrics.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides

clearPrecision()

public Evaluation.Metrics.Builder clearPrecision()

The calculated precision.

float precision = 1;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clearPredictedDocumentCount()

public Evaluation.Metrics.Builder clearPredictedDocumentCount()

The amount of documents with a predicted occurrence.

int32 predicted_document_count = 10;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clearPredictedOccurrencesCount()

public Evaluation.Metrics.Builder clearPredictedOccurrencesCount()

The amount of occurrences in predicted documents.

int32 predicted_occurrences_count = 4;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clearRecall()

public Evaluation.Metrics.Builder clearRecall()

The calculated recall.

float recall = 2;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clearTotalDocumentsCount()

public Evaluation.Metrics.Builder clearTotalDocumentsCount()

The amount of documents that had an occurrence of this label.

int32 total_documents_count = 9;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clearTruePositivesCount()

public Evaluation.Metrics.Builder clearTruePositivesCount()

The amount of true positives.

int32 true_positives_count = 6;

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

clone()

public Evaluation.Metrics.Builder clone()
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides

getDefaultInstanceForType()

public Evaluation.Metrics getDefaultInstanceForType()
Returns
TypeDescription
Evaluation.Metrics

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getF1Score()

public float getF1Score()

The calculated f1 score.

float f1_score = 3;

Returns
TypeDescription
float

The f1Score.

getFalseNegativesCount()

public int getFalseNegativesCount()

The amount of false negatives.

int32 false_negatives_count = 8;

Returns
TypeDescription
int

The falseNegativesCount.

getFalsePositivesCount()

public int getFalsePositivesCount()

The amount of false positives.

int32 false_positives_count = 7;

Returns
TypeDescription
int

The falsePositivesCount.

getGroundTruthDocumentCount()

public int getGroundTruthDocumentCount()

The amount of documents with a ground truth occurrence.

int32 ground_truth_document_count = 11;

Returns
TypeDescription
int

The groundTruthDocumentCount.

getGroundTruthOccurrencesCount()

public int getGroundTruthOccurrencesCount()

The amount of occurrences in ground truth documents.

int32 ground_truth_occurrences_count = 5;

Returns
TypeDescription
int

The groundTruthOccurrencesCount.

getPrecision()

public float getPrecision()

The calculated precision.

float precision = 1;

Returns
TypeDescription
float

The precision.

getPredictedDocumentCount()

public int getPredictedDocumentCount()

The amount of documents with a predicted occurrence.

int32 predicted_document_count = 10;

Returns
TypeDescription
int

The predictedDocumentCount.

getPredictedOccurrencesCount()

public int getPredictedOccurrencesCount()

The amount of occurrences in predicted documents.

int32 predicted_occurrences_count = 4;

Returns
TypeDescription
int

The predictedOccurrencesCount.

getRecall()

public float getRecall()

The calculated recall.

float recall = 2;

Returns
TypeDescription
float

The recall.

getTotalDocumentsCount()

public int getTotalDocumentsCount()

The amount of documents that had an occurrence of this label.

int32 total_documents_count = 9;

Returns
TypeDescription
int

The totalDocumentsCount.

getTruePositivesCount()

public int getTruePositivesCount()

The amount of true positives.

int32 true_positives_count = 6;

Returns
TypeDescription
int

The truePositivesCount.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Evaluation.Metrics other)

public Evaluation.Metrics.Builder mergeFrom(Evaluation.Metrics other)
Parameter
NameDescription
otherEvaluation.Metrics
Returns
TypeDescription
Evaluation.Metrics.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Evaluation.Metrics.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Evaluation.Metrics.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.Metrics.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides

setF1Score(float value)

public Evaluation.Metrics.Builder setF1Score(float value)

The calculated f1 score.

float f1_score = 3;

Parameter
NameDescription
valuefloat

The f1Score to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

setFalseNegativesCount(int value)

public Evaluation.Metrics.Builder setFalseNegativesCount(int value)

The amount of false negatives.

int32 false_negatives_count = 8;

Parameter
NameDescription
valueint

The falseNegativesCount to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

setFalsePositivesCount(int value)

public Evaluation.Metrics.Builder setFalsePositivesCount(int value)

The amount of false positives.

int32 false_positives_count = 7;

Parameter
NameDescription
valueint

The falsePositivesCount to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.Metrics.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides

setGroundTruthDocumentCount(int value)

public Evaluation.Metrics.Builder setGroundTruthDocumentCount(int value)

The amount of documents with a ground truth occurrence.

int32 ground_truth_document_count = 11;

Parameter
NameDescription
valueint

The groundTruthDocumentCount to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

setGroundTruthOccurrencesCount(int value)

public Evaluation.Metrics.Builder setGroundTruthOccurrencesCount(int value)

The amount of occurrences in ground truth documents.

int32 ground_truth_occurrences_count = 5;

Parameter
NameDescription
valueint

The groundTruthOccurrencesCount to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

setPrecision(float value)

public Evaluation.Metrics.Builder setPrecision(float value)

The calculated precision.

float precision = 1;

Parameter
NameDescription
valuefloat

The precision to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

setPredictedDocumentCount(int value)

public Evaluation.Metrics.Builder setPredictedDocumentCount(int value)

The amount of documents with a predicted occurrence.

int32 predicted_document_count = 10;

Parameter
NameDescription
valueint

The predictedDocumentCount to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

setPredictedOccurrencesCount(int value)

public Evaluation.Metrics.Builder setPredictedOccurrencesCount(int value)

The amount of occurrences in predicted documents.

int32 predicted_occurrences_count = 4;

Parameter
NameDescription
valueint

The predictedOccurrencesCount to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

setRecall(float value)

public Evaluation.Metrics.Builder setRecall(float value)

The calculated recall.

float recall = 2;

Parameter
NameDescription
valuefloat

The recall to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

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

public Evaluation.Metrics.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides

setTotalDocumentsCount(int value)

public Evaluation.Metrics.Builder setTotalDocumentsCount(int value)

The amount of documents that had an occurrence of this label.

int32 total_documents_count = 9;

Parameter
NameDescription
valueint

The totalDocumentsCount to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

setTruePositivesCount(int value)

public Evaluation.Metrics.Builder setTruePositivesCount(int value)

The amount of true positives.

int32 true_positives_count = 6;

Parameter
NameDescription
valueint

The truePositivesCount to set.

Returns
TypeDescription
Evaluation.Metrics.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.Metrics.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides