Class Evaluation.MultiConfidenceMetrics (2.49.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
Type Description
int

AUPRC_FIELD_NUMBER

public static final int AUPRC_FIELD_NUMBER
Field Value
Type Description
int

CONFIDENCE_LEVEL_METRICS_EXACT_FIELD_NUMBER

public static final int CONFIDENCE_LEVEL_METRICS_EXACT_FIELD_NUMBER
Field Value
Type Description
int

CONFIDENCE_LEVEL_METRICS_FIELD_NUMBER

public static final int CONFIDENCE_LEVEL_METRICS_FIELD_NUMBER
Field Value
Type Description
int

ESTIMATED_CALIBRATION_ERROR_EXACT_FIELD_NUMBER

public static final int ESTIMATED_CALIBRATION_ERROR_EXACT_FIELD_NUMBER
Field Value
Type Description
int

ESTIMATED_CALIBRATION_ERROR_FIELD_NUMBER

public static final int ESTIMATED_CALIBRATION_ERROR_FIELD_NUMBER
Field Value
Type Description
int

METRICS_TYPE_FIELD_NUMBER

public static final int METRICS_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Evaluation.MultiConfidenceMetrics getDefaultInstance()
Returns
Type Description
Evaluation.MultiConfidenceMetrics

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Evaluation.MultiConfidenceMetrics.Builder newBuilder()
Returns
Type Description
Evaluation.MultiConfidenceMetrics.Builder

newBuilder(Evaluation.MultiConfidenceMetrics prototype)

public static Evaluation.MultiConfidenceMetrics.Builder newBuilder(Evaluation.MultiConfidenceMetrics prototype)
Parameter
Name Description
prototype Evaluation.MultiConfidenceMetrics
Returns
Type Description
Evaluation.MultiConfidenceMetrics.Builder

parseDelimitedFrom(InputStream input)

public static Evaluation.MultiConfidenceMetrics parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.MultiConfidenceMetrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Evaluation.MultiConfidenceMetrics parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.MultiConfidenceMetrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Evaluation.MultiConfidenceMetrics parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.MultiConfidenceMetrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Evaluation.MultiConfidenceMetrics parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.MultiConfidenceMetrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Evaluation.MultiConfidenceMetrics parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.MultiConfidenceMetrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Evaluation.MultiConfidenceMetrics parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.MultiConfidenceMetrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.MultiConfidenceMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetricsOrBuilder>

getDefaultInstanceForType()

public Evaluation.MultiConfidenceMetrics getDefaultInstanceForType()
Returns
Type Description
Evaluation.MultiConfidenceMetrics

getEstimatedCalibrationError()

public float getEstimatedCalibrationError()

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

float estimated_calibration_error = 3;

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for metricsType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Evaluation.MultiConfidenceMetrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Evaluation.MultiConfidenceMetrics.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.MultiConfidenceMetrics.Builder toBuilder()
Returns
Type Description
Evaluation.MultiConfidenceMetrics.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException