com.google.cloud.documentai.v1beta3

Enum Evaluation.MultiConfidenceMetrics.MetricsType

java.lang.Object

java.lang.Enum<Evaluation.MultiConfidenceMetrics.MetricsType>

com.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics.MetricsType

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Evaluation.MultiConfidenceMetrics.MetricsType>

Enclosing class:

Evaluation.MultiConfidenceMetrics

public static enum Evaluation.MultiConfidenceMetrics.MetricsType
extends Enum<Evaluation.MultiConfidenceMetrics.MetricsType>
implements com.google.protobuf.ProtocolMessageEnum

 A type that determines how metrics should be interpreted.
 

Protobuf enum google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics.MetricsType

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGREGATE Indicates whether metrics for this particular label type represent an aggregate of metrics for other types instead of being based on actual TP/FP/FN values for the label type.
METRICS_TYPE_UNSPECIFIED The metrics type is unspecified.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	AGGREGATE_VALUE Indicates whether metrics for this particular label type represent an aggregate of metrics for other types instead of being based on actual TP/FP/FN values for the label type.
static int	METRICS_TYPE_UNSPECIFIED_VALUE The metrics type is unspecified.

Method Summary

Modifier and Type	Method and Description
static Evaluation.MultiConfidenceMetrics.MetricsType	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<Evaluation.MultiConfidenceMetrics.MetricsType>	internalGetValueMap()
static Evaluation.MultiConfidenceMetrics.MetricsType	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static Evaluation.MultiConfidenceMetrics.MetricsType	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Evaluation.MultiConfidenceMetrics.MetricsType	valueOf(String name) Returns the enum constant of this type with the specified name.
static Evaluation.MultiConfidenceMetrics.MetricsType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

METRICS_TYPE_UNSPECIFIED

public static final Evaluation.MultiConfidenceMetrics.MetricsType METRICS_TYPE_UNSPECIFIED

 The metrics type is unspecified. By default, metrics without a
 particular specification are for leaf entity types (i.e., top-level
 entity types without child types, or child types which are not
 parent types themselves).
 

METRICS_TYPE_UNSPECIFIED = 0;

AGGREGATE

public static final Evaluation.MultiConfidenceMetrics.MetricsType AGGREGATE

 Indicates whether metrics for this particular label type represent an
 aggregate of metrics for other types instead of being based on actual
 TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
 entity types are an aggregate of metrics for their children.
 

AGGREGATE = 1;

UNRECOGNIZED

public static final Evaluation.MultiConfidenceMetrics.MetricsType UNRECOGNIZED

Field Detail

METRICS_TYPE_UNSPECIFIED_VALUE

public static final int METRICS_TYPE_UNSPECIFIED_VALUE

 The metrics type is unspecified. By default, metrics without a
 particular specification are for leaf entity types (i.e., top-level
 entity types without child types, or child types which are not
 parent types themselves).
 

METRICS_TYPE_UNSPECIFIED = 0;

See Also:

Constant Field Values

AGGREGATE_VALUE

public static final int AGGREGATE_VALUE

 Indicates whether metrics for this particular label type represent an
 aggregate of metrics for other types instead of being based on actual
 TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
 entity types are an aggregate of metrics for their children.
 

AGGREGATE = 1;

See Also:

Constant Field Values

Method Detail

values

public static Evaluation.MultiConfidenceMetrics.MetricsType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Evaluation.MultiConfidenceMetrics.MetricsType c : Evaluation.MultiConfidenceMetrics.MetricsType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Evaluation.MultiConfidenceMetrics.MetricsType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static Evaluation.MultiConfidenceMetrics.MetricsType valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static Evaluation.MultiConfidenceMetrics.MetricsType forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<Evaluation.MultiConfidenceMetrics.MetricsType> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

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

valueOf

public static Evaluation.MultiConfidenceMetrics.MetricsType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)