Class Evaluation.Metrics (2.16.0)

Version 2.16.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 extends GeneratedMessageV3 implements Evaluation.MetricsOrBuilder

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

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

Inheritance

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

Implements

Evaluation.MetricsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

F1_SCORE_FIELD_NUMBER

public static final int F1_SCORE_FIELD_NUMBER

Field Value

Type	Description
int

FALSE_NEGATIVES_COUNT_FIELD_NUMBER

public static final int FALSE_NEGATIVES_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

FALSE_POSITIVES_COUNT_FIELD_NUMBER

public static final int FALSE_POSITIVES_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

GROUND_TRUTH_DOCUMENT_COUNT_FIELD_NUMBER

public static final int GROUND_TRUTH_DOCUMENT_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

GROUND_TRUTH_OCCURRENCES_COUNT_FIELD_NUMBER

public static final int GROUND_TRUTH_OCCURRENCES_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

PRECISION_FIELD_NUMBER

public static final int PRECISION_FIELD_NUMBER

Field Value

Type	Description
int

PREDICTED_DOCUMENT_COUNT_FIELD_NUMBER

public static final int PREDICTED_DOCUMENT_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

PREDICTED_OCCURRENCES_COUNT_FIELD_NUMBER

public static final int PREDICTED_OCCURRENCES_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

RECALL_FIELD_NUMBER

public static final int RECALL_FIELD_NUMBER

Field Value

Type	Description
int

TOTAL_DOCUMENTS_COUNT_FIELD_NUMBER

public static final int TOTAL_DOCUMENTS_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

TRUE_POSITIVES_COUNT_FIELD_NUMBER

public static final int TRUE_POSITIVES_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static Evaluation.Metrics getDefaultInstance()

Returns

Type	Description
Evaluation.Metrics

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Evaluation.Metrics.Builder newBuilder()

Returns

Type	Description
Evaluation.Metrics.Builder

newBuilder(Evaluation.Metrics prototype)

public static Evaluation.Metrics.Builder newBuilder(Evaluation.Metrics prototype)

Parameter

Name	Description
prototype	Evaluation.Metrics

Returns

Type	Description
Evaluation.Metrics.Builder

parseDelimitedFrom(InputStream input)

public static Evaluation.Metrics parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Evaluation.Metrics parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Evaluation.Metrics parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Evaluation.Metrics parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Evaluation.Metrics parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Evaluation.Metrics parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Evaluation.Metrics

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Evaluation.Metrics> parser()

Returns

Type	Description
Parser<Metrics>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Evaluation.Metrics getDefaultInstanceForType()

Returns

Type	Description
Evaluation.Metrics

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.

getParserForType()

public Parser<Evaluation.Metrics> getParserForType()

Returns

Type	Description
Parser<Metrics>

Overrides

GeneratedMessageV3.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Evaluation.Metrics.Builder newBuilderForType()

Returns

Type	Description
Evaluation.Metrics.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Evaluation.Metrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Evaluation.Metrics.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Evaluation.Metrics.Builder toBuilder()

Returns

Type	Description
Evaluation.Metrics.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException