Class Evaluation.MultiConfidenceMetrics (2.37.0)

public static final class Evaluation.MultiConfidenceMetrics extends GeneratedMessageV3 implements Evaluation.MultiConfidenceMetricsOrBuilder

Metrics across multiple confidence levels.

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

Inheritance

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

Static Fields

AUPRC_EXACT_FIELD_NUMBER

public static final int AUPRC_EXACT_FIELD_NUMBER
Field Value
TypeDescription
int

AUPRC_FIELD_NUMBER

public static final int AUPRC_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIDENCE_LEVEL_METRICS_EXACT_FIELD_NUMBER

public static final int CONFIDENCE_LEVEL_METRICS_EXACT_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIDENCE_LEVEL_METRICS_FIELD_NUMBER

public static final int CONFIDENCE_LEVEL_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

ESTIMATED_CALIBRATION_ERROR_EXACT_FIELD_NUMBER

public static final int ESTIMATED_CALIBRATION_ERROR_EXACT_FIELD_NUMBER
Field Value
TypeDescription
int

ESTIMATED_CALIBRATION_ERROR_FIELD_NUMBER

public static final int ESTIMATED_CALIBRATION_ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

METRICS_TYPE_FIELD_NUMBER

public static final int METRICS_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(Evaluation.MultiConfidenceMetrics prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAuprc()

public float getAuprc()

The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.

float auprc = 2;

Returns
TypeDescription
float

The auprc.

getAuprcExact()

public float getAuprcExact()

The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.

float auprc_exact = 5;

Returns
TypeDescription
float

The auprcExact.

getConfidenceLevelMetrics(int index)

public Evaluation.ConfidenceLevelMetrics getConfidenceLevelMetrics(int index)

Metrics across confidence levels with fuzzy matching enabled.

repeated .google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics confidence_level_metrics = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
Evaluation.ConfidenceLevelMetrics

getConfidenceLevelMetricsCount()

public int getConfidenceLevelMetricsCount()

Metrics across confidence levels with fuzzy matching enabled.

repeated .google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics confidence_level_metrics = 1;

Returns
TypeDescription
int

getConfidenceLevelMetricsExact(int index)

public Evaluation.ConfidenceLevelMetrics getConfidenceLevelMetricsExact(int index)

Metrics across confidence levels with only exact matching.

repeated .google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics confidence_level_metrics_exact = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
Evaluation.ConfidenceLevelMetrics

getConfidenceLevelMetricsExactCount()

public int getConfidenceLevelMetricsExactCount()

Metrics across confidence levels with only exact matching.

repeated .google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics confidence_level_metrics_exact = 4;

Returns
TypeDescription
int

getConfidenceLevelMetricsExactList()

public List<Evaluation.ConfidenceLevelMetrics> getConfidenceLevelMetricsExactList()

Metrics across confidence levels with only exact matching.

repeated .google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics confidence_level_metrics_exact = 4;

Returns
TypeDescription
List<ConfidenceLevelMetrics>

getConfidenceLevelMetricsExactOrBuilder(int index)

public Evaluation.ConfidenceLevelMetricsOrBuilder getConfidenceLevelMetricsExactOrBuilder(int index)

Metrics across confidence levels with only exact matching.

repeated .google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics confidence_level_metrics_exact = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
Evaluation.ConfidenceLevelMetricsOrBuilder

getConfidenceLevelMetricsExactOrBuilderList()

public List<? extends Evaluation.ConfidenceLevelMetricsOrBuilder> getConfidenceLevelMetricsExactOrBuilderList()

Metrics across confidence levels with only exact matching.

repeated .google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics confidence_level_metrics_exact = 4;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetricsOrBuilder>

getConfidenceLevelMetricsList()

public List<Evaluation.ConfidenceLevelMetrics> getConfidenceLevelMetricsList()

Metrics across confidence levels with fuzzy matching enabled.

repeated .google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics confidence_level_metrics = 1;

Returns
TypeDescription
List<ConfidenceLevelMetrics>

getConfidenceLevelMetricsOrBuilder(int index)

public Evaluation.ConfidenceLevelMetricsOrBuilder getConfidenceLevelMetricsOrBuilder(int index)

Metrics across confidence levels with fuzzy matching enabled.

repeated .google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics confidence_level_metrics = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
Evaluation.ConfidenceLevelMetricsOrBuilder

getConfidenceLevelMetricsOrBuilderList()

public List<? extends Evaluation.ConfidenceLevelMetricsOrBuilder> getConfidenceLevelMetricsOrBuilderList()

Metrics across confidence levels with fuzzy matching enabled.

repeated .google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics confidence_level_metrics = 1;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetricsOrBuilder>

getDefaultInstanceForType()

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

getEstimatedCalibrationError()

public float getEstimatedCalibrationError()

The Estimated Calibration Error (ECE) of the confidence of the predicted entities.

float estimated_calibration_error = 3;

Returns
TypeDescription
float

The estimatedCalibrationError.

getEstimatedCalibrationErrorExact()

public float getEstimatedCalibrationErrorExact()

The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.

float estimated_calibration_error_exact = 6;

Returns
TypeDescription
float

The estimatedCalibrationErrorExact.

getMetricsType()

public Evaluation.MultiConfidenceMetrics.MetricsType getMetricsType()

The metrics type for the label.

.google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics.MetricsType metrics_type = 7;

Returns
TypeDescription
Evaluation.MultiConfidenceMetrics.MetricsType

The metricsType.

getMetricsTypeValue()

public int getMetricsTypeValue()

The metrics type for the label.

.google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics.MetricsType metrics_type = 7;

Returns
TypeDescription
int

The enum numeric value on the wire for metricsType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.MultiConfidenceMetrics.Builder newBuilderForType()
Returns
TypeDescription
Evaluation.MultiConfidenceMetrics.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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