Class Evaluation.Metrics (2.41.0)

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

Static Fields

F1_SCORE_FIELD_NUMBER

public static final int F1_SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

FALSE_NEGATIVES_COUNT_FIELD_NUMBER

public static final int FALSE_NEGATIVES_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

FALSE_POSITIVES_COUNT_FIELD_NUMBER

public static final int FALSE_POSITIVES_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

GROUND_TRUTH_DOCUMENT_COUNT_FIELD_NUMBER

public static final int GROUND_TRUTH_DOCUMENT_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

GROUND_TRUTH_OCCURRENCES_COUNT_FIELD_NUMBER

public static final int GROUND_TRUTH_OCCURRENCES_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

PRECISION_FIELD_NUMBER

public static final int PRECISION_FIELD_NUMBER
Field Value
TypeDescription
int

PREDICTED_DOCUMENT_COUNT_FIELD_NUMBER

public static final int PREDICTED_DOCUMENT_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

PREDICTED_OCCURRENCES_COUNT_FIELD_NUMBER

public static final int PREDICTED_OCCURRENCES_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

RECALL_FIELD_NUMBER

public static final int RECALL_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_DOCUMENTS_COUNT_FIELD_NUMBER

public static final int TOTAL_DOCUMENTS_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

TRUE_POSITIVES_COUNT_FIELD_NUMBER

public static final int TRUE_POSITIVES_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Evaluation.Metrics getDefaultInstance()
Returns
TypeDescription
Evaluation.Metrics

getDescriptor()

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

newBuilder()

public static Evaluation.Metrics.Builder newBuilder()
Returns
TypeDescription
Evaluation.Metrics.Builder

newBuilder(Evaluation.Metrics prototype)

public static Evaluation.Metrics.Builder newBuilder(Evaluation.Metrics prototype)
Parameter
NameDescription
prototypeEvaluation.Metrics
Returns
TypeDescription
Evaluation.Metrics.Builder

parseDelimitedFrom(InputStream input)

public static Evaluation.Metrics parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Evaluation.Metrics parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Evaluation.Metrics parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Evaluation.Metrics parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Evaluation.Metrics parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Evaluation.Metrics parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Metrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Evaluation.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Evaluation.Metrics> parser()
Returns
TypeDescription
Parser<Metrics>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<Evaluation.Metrics> getParserForType()
Returns
TypeDescription
Parser<Metrics>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Evaluation.Metrics.Builder newBuilderForType()
Returns
TypeDescription
Evaluation.Metrics.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Evaluation.Metrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Evaluation.Metrics.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Evaluation.Metrics.Builder toBuilder()
Returns
TypeDescription
Evaluation.Metrics.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException