Class Evaluation.Metrics.Builder (2.20.0)

Version 2.20.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Evaluation.Metrics.Builder

Implements

Evaluation.MetricsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.Metrics.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Evaluation.Metrics build()

Returns
Type	Description
Evaluation.Metrics

buildPartial()

public Evaluation.Metrics buildPartial()

Returns
Type	Description
Evaluation.Metrics

clear()

public Evaluation.Metrics.Builder clear()

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearF1Score()

public Evaluation.Metrics.Builder clearF1Score()

The calculated f1 score.

float f1_score = 3;

Returns
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

clearFalseNegativesCount()

public Evaluation.Metrics.Builder clearFalseNegativesCount()

The amount of false negatives.

int32 false_negatives_count = 8;

Returns
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

clearFalsePositivesCount()

public Evaluation.Metrics.Builder clearFalsePositivesCount()

The amount of false positives.

int32 false_positives_count = 7;

Returns
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Evaluation.Metrics.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGroundTruthDocumentCount()

public Evaluation.Metrics.Builder clearGroundTruthDocumentCount()

The amount of documents with a ground truth occurrence.

int32 ground_truth_document_count = 11;

Returns
Type	Description
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
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Evaluation.Metrics.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPrecision()

public Evaluation.Metrics.Builder clearPrecision()

The calculated precision.

float precision = 1;

Returns
Type	Description
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
Type	Description
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
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

clearRecall()

public Evaluation.Metrics.Builder clearRecall()

The calculated recall.

float recall = 2;

Returns
Type	Description
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
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

clearTruePositivesCount()

public Evaluation.Metrics.Builder clearTruePositivesCount()

The amount of true positives.

int32 true_positives_count = 6;

Returns
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

clone()

public Evaluation.Metrics.Builder clone()

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Evaluation.Metrics getDefaultInstanceForType()

Returns
Type	Description
Evaluation.Metrics

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getF1Score()

public float getF1Score()

The calculated f1 score.

float f1_score = 3;

Returns
Type	Description
float	The f1Score.

getFalseNegativesCount()

public int getFalseNegativesCount()

The amount of false negatives.

int32 false_negatives_count = 8;

Returns
Type	Description
int	The falseNegativesCount.

getFalsePositivesCount()

public int getFalsePositivesCount()

The amount of false positives.

int32 false_positives_count = 7;

Returns
Type	Description
int	The falsePositivesCount.

getGroundTruthDocumentCount()

public int getGroundTruthDocumentCount()

The amount of documents with a ground truth occurrence.

int32 ground_truth_document_count = 11;

Returns
Type	Description
int	The groundTruthDocumentCount.

getGroundTruthOccurrencesCount()

public int getGroundTruthOccurrencesCount()

The amount of occurrences in ground truth documents.

int32 ground_truth_occurrences_count = 5;

Returns
Type	Description
int	The groundTruthOccurrencesCount.

getPrecision()

public float getPrecision()

The calculated precision.

float precision = 1;

Returns
Type	Description
float	The precision.

getPredictedDocumentCount()

public int getPredictedDocumentCount()

The amount of documents with a predicted occurrence.

int32 predicted_document_count = 10;

Returns
Type	Description
int	The predictedDocumentCount.

getPredictedOccurrencesCount()

public int getPredictedOccurrencesCount()

The amount of occurrences in predicted documents.

int32 predicted_occurrences_count = 4;

Returns
Type	Description
int	The predictedOccurrencesCount.

getRecall()

public float getRecall()

The calculated recall.

float recall = 2;

Returns
Type	Description
float	The recall.

getTotalDocumentsCount()

public int getTotalDocumentsCount()

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

int32 total_documents_count = 9;

Returns
Type	Description
int	The totalDocumentsCount.

getTruePositivesCount()

public int getTruePositivesCount()

The amount of true positives.

int32 true_positives_count = 6;

Returns
Type	Description
int	The truePositivesCount.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Evaluation.Metrics other)

public Evaluation.Metrics.Builder mergeFrom(Evaluation.Metrics other)

Parameter
Name	Description
other	Evaluation.Metrics

Returns
Type	Description
Evaluation.Metrics.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Evaluation.Metrics.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Evaluation.Metrics.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.Metrics.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setF1Score(float value)

public Evaluation.Metrics.Builder setF1Score(float value)

The calculated f1 score.

float f1_score = 3;

Parameter
Name	Description
value	float The f1Score to set.

Returns
Type	Description
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
Name	Description
value	int The falseNegativesCount to set.

Returns
Type	Description
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
Name	Description
value	int The falsePositivesCount to set.

Returns
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.Metrics.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
value	int The groundTruthDocumentCount to set.

Returns
Type	Description
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
Name	Description
value	int The groundTruthOccurrencesCount to set.

Returns
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

setPrecision(float value)

public Evaluation.Metrics.Builder setPrecision(float value)

The calculated precision.

float precision = 1;

Parameter
Name	Description
value	float The precision to set.

Returns
Type	Description
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
Name	Description
value	int The predictedDocumentCount to set.

Returns
Type	Description
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
Name	Description
value	int The predictedOccurrencesCount to set.

Returns
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

setRecall(float value)

public Evaluation.Metrics.Builder setRecall(float value)

The calculated recall.

float recall = 2;

Parameter
Name	Description
value	float The recall to set.

Returns
Type	Description
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
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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
Name	Description
value	int The totalDocumentsCount to set.

Returns
Type	Description
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
Name	Description
value	int The truePositivesCount to set.

Returns
Type	Description
Evaluation.Metrics.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.Metrics.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Evaluation.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)