Package com.google.cloud.documentai.v1

Class Evaluation.MultiConfidenceMetrics

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics

All Implemented Interfaces:

Evaluation.MultiConfidenceMetricsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Evaluation

public static final class Evaluation.MultiConfidenceMetrics
extends com.google.protobuf.GeneratedMessageV3
implements Evaluation.MultiConfidenceMetricsOrBuilder

 Metrics across multiple confidence levels.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Evaluation.MultiConfidenceMetrics.Builder	Metrics across multiple confidence levels.
static class	Evaluation.MultiConfidenceMetrics.MetricsType	A type that determines how metrics should be interpreted.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	AUPRC_EXACT_FIELD_NUMBER
static int	AUPRC_FIELD_NUMBER
static int	CONFIDENCE_LEVEL_METRICS_EXACT_FIELD_NUMBER
static int	CONFIDENCE_LEVEL_METRICS_FIELD_NUMBER
static int	ESTIMATED_CALIBRATION_ERROR_EXACT_FIELD_NUMBER
static int	ESTIMATED_CALIBRATION_ERROR_FIELD_NUMBER
static int	METRICS_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
float	getAuprc()	The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.
float	getAuprcExact()	The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
Evaluation.ConfidenceLevelMetrics	getConfidenceLevelMetrics(int index)	Metrics across confidence levels with fuzzy matching enabled.
int	getConfidenceLevelMetricsCount()	Metrics across confidence levels with fuzzy matching enabled.
Evaluation.ConfidenceLevelMetrics	getConfidenceLevelMetricsExact(int index)	Metrics across confidence levels with only exact matching.
int	getConfidenceLevelMetricsExactCount()	Metrics across confidence levels with only exact matching.
List<Evaluation.ConfidenceLevelMetrics>	getConfidenceLevelMetricsExactList()	Metrics across confidence levels with only exact matching.
Evaluation.ConfidenceLevelMetricsOrBuilder	getConfidenceLevelMetricsExactOrBuilder(int index)	Metrics across confidence levels with only exact matching.
List<? extends Evaluation.ConfidenceLevelMetricsOrBuilder>	getConfidenceLevelMetricsExactOrBuilderList()	Metrics across confidence levels with only exact matching.
List<Evaluation.ConfidenceLevelMetrics>	getConfidenceLevelMetricsList()	Metrics across confidence levels with fuzzy matching enabled.
Evaluation.ConfidenceLevelMetricsOrBuilder	getConfidenceLevelMetricsOrBuilder(int index)	Metrics across confidence levels with fuzzy matching enabled.
List<? extends Evaluation.ConfidenceLevelMetricsOrBuilder>	getConfidenceLevelMetricsOrBuilderList()	Metrics across confidence levels with fuzzy matching enabled.
static Evaluation.MultiConfidenceMetrics	getDefaultInstance()
Evaluation.MultiConfidenceMetrics	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
float	getEstimatedCalibrationError()	The Estimated Calibration Error (ECE) of the confidence of the predicted entities.
float	getEstimatedCalibrationErrorExact()	The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.
Evaluation.MultiConfidenceMetrics.MetricsType	getMetricsType()	The metrics type for the label.
int	getMetricsTypeValue()	The metrics type for the label.
com.google.protobuf.Parser<Evaluation.MultiConfidenceMetrics>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Evaluation.MultiConfidenceMetrics.Builder	newBuilder()
static Evaluation.MultiConfidenceMetrics.Builder	newBuilder(Evaluation.MultiConfidenceMetrics prototype)
Evaluation.MultiConfidenceMetrics.Builder	newBuilderForType()
protected Evaluation.MultiConfidenceMetrics.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Evaluation.MultiConfidenceMetrics	parseDelimitedFrom(InputStream input)
static Evaluation.MultiConfidenceMetrics	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation.MultiConfidenceMetrics	parseFrom(byte[] data)
static Evaluation.MultiConfidenceMetrics	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation.MultiConfidenceMetrics	parseFrom(com.google.protobuf.ByteString data)
static Evaluation.MultiConfidenceMetrics	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation.MultiConfidenceMetrics	parseFrom(com.google.protobuf.CodedInputStream input)
static Evaluation.MultiConfidenceMetrics	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation.MultiConfidenceMetrics	parseFrom(InputStream input)
static Evaluation.MultiConfidenceMetrics	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation.MultiConfidenceMetrics	parseFrom(ByteBuffer data)
static Evaluation.MultiConfidenceMetrics	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Evaluation.MultiConfidenceMetrics>	parser()
Evaluation.MultiConfidenceMetrics.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail

CONFIDENCE_LEVEL_METRICS_FIELD_NUMBER

public static final int CONFIDENCE_LEVEL_METRICS_FIELD_NUMBER

See Also:

Constant Field Values

CONFIDENCE_LEVEL_METRICS_EXACT_FIELD_NUMBER

public static final int CONFIDENCE_LEVEL_METRICS_EXACT_FIELD_NUMBER

See Also:

Constant Field Values

AUPRC_FIELD_NUMBER

public static final int AUPRC_FIELD_NUMBER

See Also:

Constant Field Values

ESTIMATED_CALIBRATION_ERROR_FIELD_NUMBER

public static final int ESTIMATED_CALIBRATION_ERROR_FIELD_NUMBER

See Also:

Constant Field Values

AUPRC_EXACT_FIELD_NUMBER

public static final int AUPRC_EXACT_FIELD_NUMBER

See Also:

Constant Field Values

ESTIMATED_CALIBRATION_ERROR_EXACT_FIELD_NUMBER

public static final int ESTIMATED_CALIBRATION_ERROR_EXACT_FIELD_NUMBER

See Also:

Constant Field Values

METRICS_TYPE_FIELD_NUMBER

public static final int METRICS_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

getConfidenceLevelMetricsList in interface Evaluation.MultiConfidenceMetricsOrBuilder

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;

Specified by:

getConfidenceLevelMetricsOrBuilderList in interface Evaluation.MultiConfidenceMetricsOrBuilder

getConfidenceLevelMetricsCount

public int getConfidenceLevelMetricsCount()

 Metrics across confidence levels with fuzzy matching enabled.
 

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

Specified by:

getConfidenceLevelMetricsCount in interface Evaluation.MultiConfidenceMetricsOrBuilder

getConfidenceLevelMetrics

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;

Specified by:

getConfidenceLevelMetrics in interface Evaluation.MultiConfidenceMetricsOrBuilder

getConfidenceLevelMetricsOrBuilder

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;

Specified by:

getConfidenceLevelMetricsOrBuilder in interface Evaluation.MultiConfidenceMetricsOrBuilder

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;

Specified by:

getConfidenceLevelMetricsExactList in interface Evaluation.MultiConfidenceMetricsOrBuilder

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;

Specified by:

getConfidenceLevelMetricsExactOrBuilderList in interface Evaluation.MultiConfidenceMetricsOrBuilder

getConfidenceLevelMetricsExactCount

public int getConfidenceLevelMetricsExactCount()

 Metrics across confidence levels with only exact matching.
 

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

Specified by:

getConfidenceLevelMetricsExactCount in interface Evaluation.MultiConfidenceMetricsOrBuilder

getConfidenceLevelMetricsExact

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;

Specified by:

getConfidenceLevelMetricsExact in interface Evaluation.MultiConfidenceMetricsOrBuilder

getConfidenceLevelMetricsExactOrBuilder

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;

Specified by:

getConfidenceLevelMetricsExactOrBuilder in interface Evaluation.MultiConfidenceMetricsOrBuilder

getAuprc

public float getAuprc()

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

float auprc = 2;

Specified by:

getAuprc in interface Evaluation.MultiConfidenceMetricsOrBuilder

Returns:

The auprc.

getEstimatedCalibrationError

public float getEstimatedCalibrationError()

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

float estimated_calibration_error = 3;

Specified by:

getEstimatedCalibrationError in interface Evaluation.MultiConfidenceMetricsOrBuilder

Returns:

The estimatedCalibrationError.

getAuprcExact

public float getAuprcExact()

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

float auprc_exact = 5;

Specified by:

getAuprcExact in interface Evaluation.MultiConfidenceMetricsOrBuilder

Returns:

The auprcExact.

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;

Specified by:

getEstimatedCalibrationErrorExact in interface Evaluation.MultiConfidenceMetricsOrBuilder

Returns:

The estimatedCalibrationErrorExact.

getMetricsTypeValue

public int getMetricsTypeValue()

 The metrics type for the label.
 

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

Specified by:

getMetricsTypeValue in interface Evaluation.MultiConfidenceMetricsOrBuilder

Returns:

The enum numeric value on the wire for metricsType.

getMetricsType

public Evaluation.MultiConfidenceMetrics.MetricsType getMetricsType()

 The metrics type for the label.
 

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

Specified by:

getMetricsType in interface Evaluation.MultiConfidenceMetricsOrBuilder

Returns:

The metricsType.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Evaluation.MultiConfidenceMetrics parseFrom(ByteBuffer data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.MultiConfidenceMetrics parseFrom(ByteBuffer data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.MultiConfidenceMetrics parseFrom(com.google.protobuf.ByteString data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.MultiConfidenceMetrics parseFrom(com.google.protobuf.ByteString data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.MultiConfidenceMetrics parseFrom(byte[] data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.MultiConfidenceMetrics parseFrom(byte[] data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.MultiConfidenceMetrics parseFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

public static Evaluation.MultiConfidenceMetrics parseFrom(InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Evaluation.MultiConfidenceMetrics parseDelimitedFrom(InputStream input)
                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Evaluation.MultiConfidenceMetrics parseDelimitedFrom(InputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws IOException

Throws:

IOException

parseFrom

public static Evaluation.MultiConfidenceMetrics parseFrom(com.google.protobuf.CodedInputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

public static Evaluation.MultiConfidenceMetrics parseFrom(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

newBuilderForType

public Evaluation.MultiConfidenceMetrics.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Evaluation.MultiConfidenceMetrics.Builder newBuilder()

newBuilder

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

toBuilder

public Evaluation.MultiConfidenceMetrics.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Evaluation.MultiConfidenceMetrics.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Evaluation.MultiConfidenceMetrics getDefaultInstance()

parser

public static com.google.protobuf.Parser<Evaluation.MultiConfidenceMetrics> parser()

getParserForType

public com.google.protobuf.Parser<Evaluation.MultiConfidenceMetrics> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Evaluation.MultiConfidenceMetrics getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder