Class Evaluation.Metrics (2.55.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
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

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

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

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

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
Exceptions
Type Description
IOException