Package com.google.cloud.documentai.v1beta3

Class Evaluation

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta3.Evaluation

All Implemented Interfaces:

EvaluationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Evaluation
extends com.google.protobuf.GeneratedMessageV3
implements EvaluationOrBuilder

 An evaluation of a ProcessorVersion's performance.
 

Protobuf type google.cloud.documentai.v1beta3.Evaluation

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Evaluation.Builder	An evaluation of a ProcessorVersion's performance.
static class	Evaluation.ConfidenceLevelMetrics	Evaluations metrics, at a specific confidence level.
static interface	Evaluation.ConfidenceLevelMetricsOrBuilder
static class	Evaluation.Counters	Evaluation counters for the documents that were used.
static interface	Evaluation.CountersOrBuilder
static class	Evaluation.Metrics	Evaluation metrics, either in aggregate or about a specific entity.
static interface	Evaluation.MetricsOrBuilder
static class	Evaluation.MultiConfidenceMetrics	Metrics across multiple confidence levels.
static interface	Evaluation.MultiConfidenceMetricsOrBuilder

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	ALL_ENTITIES_METRICS_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	DOCUMENT_COUNTERS_FIELD_NUMBER
static int	ENTITY_METRICS_FIELD_NUMBER
static int	KMS_KEY_NAME_FIELD_NUMBER
static int	KMS_KEY_VERSION_NAME_FIELD_NUMBER
static int	NAME_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	containsEntityMetrics(String key)	Metrics across confidence levels, for different entities.
boolean	equals(Object obj)
Evaluation.MultiConfidenceMetrics	getAllEntitiesMetrics()	Metrics for all the entities in aggregate.
Evaluation.MultiConfidenceMetricsOrBuilder	getAllEntitiesMetricsOrBuilder()	Metrics for all the entities in aggregate.
com.google.protobuf.Timestamp	getCreateTime()	The time that the evaluation was created.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder()	The time that the evaluation was created.
static Evaluation	getDefaultInstance()
Evaluation	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Evaluation.Counters	getDocumentCounters()	Counters for the documents used in the evaluation.
Evaluation.CountersOrBuilder	getDocumentCountersOrBuilder()	Counters for the documents used in the evaluation.
Map<String,Evaluation.MultiConfidenceMetrics>	getEntityMetrics()	Deprecated.
int	getEntityMetricsCount()	Metrics across confidence levels, for different entities.
Map<String,Evaluation.MultiConfidenceMetrics>	getEntityMetricsMap()	Metrics across confidence levels, for different entities.
Evaluation.MultiConfidenceMetrics	getEntityMetricsOrDefault(String key, Evaluation.MultiConfidenceMetrics defaultValue)	Metrics across confidence levels, for different entities.
Evaluation.MultiConfidenceMetrics	getEntityMetricsOrThrow(String key)	Metrics across confidence levels, for different entities.
String	getKmsKeyName()	The KMS key name used for encryption.
com.google.protobuf.ByteString	getKmsKeyNameBytes()	The KMS key name used for encryption.
String	getKmsKeyVersionName()	The KMS key version with which data is encrypted.
com.google.protobuf.ByteString	getKmsKeyVersionNameBytes()	The KMS key version with which data is encrypted.
String	getName()	The resource name of the evaluation.
com.google.protobuf.ByteString	getNameBytes()	The resource name of the evaluation.
com.google.protobuf.Parser<Evaluation>	getParserForType()
int	getSerializedSize()
boolean	hasAllEntitiesMetrics()	Metrics for all the entities in aggregate.
boolean	hasCreateTime()	The time that the evaluation was created.
boolean	hasDocumentCounters()	Counters for the documents used in the evaluation.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static Evaluation.Builder	newBuilder()
static Evaluation.Builder	newBuilder(Evaluation prototype)
Evaluation.Builder	newBuilderForType()
protected Evaluation.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Evaluation	parseDelimitedFrom(InputStream input)
static Evaluation	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation	parseFrom(byte[] data)
static Evaluation	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation	parseFrom(com.google.protobuf.ByteString data)
static Evaluation	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation	parseFrom(com.google.protobuf.CodedInputStream input)
static Evaluation	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation	parseFrom(InputStream input)
static Evaluation	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation	parseFrom(ByteBuffer data)
static Evaluation	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Evaluation>	parser()
Evaluation.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, 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

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_COUNTERS_FIELD_NUMBER

public static final int DOCUMENT_COUNTERS_FIELD_NUMBER

See Also:

Constant Field Values

ALL_ENTITIES_METRICS_FIELD_NUMBER

public static final int ALL_ENTITIES_METRICS_FIELD_NUMBER

See Also:

Constant Field Values

ENTITY_METRICS_FIELD_NUMBER

public static final int ENTITY_METRICS_FIELD_NUMBER

See Also:

Constant Field Values

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

KMS_KEY_VERSION_NAME_FIELD_NUMBER

public static final int KMS_KEY_VERSION_NAME_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()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 The resource name of the evaluation.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
 

string name = 1;

Specified by:

getName in interface EvaluationOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The resource name of the evaluation.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
 

string name = 1;

Specified by:

getNameBytes in interface EvaluationOrBuilder

Returns:

The bytes for name.

hasCreateTime

public boolean hasCreateTime()

 The time that the evaluation was created.
 

.google.protobuf.Timestamp create_time = 2;

Specified by:

hasCreateTime in interface EvaluationOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 The time that the evaluation was created.
 

.google.protobuf.Timestamp create_time = 2;

Specified by:

getCreateTime in interface EvaluationOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 The time that the evaluation was created.
 

.google.protobuf.Timestamp create_time = 2;

Specified by:

getCreateTimeOrBuilder in interface EvaluationOrBuilder

hasDocumentCounters

public boolean hasDocumentCounters()

 Counters for the documents used in the evaluation.
 

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Specified by:

hasDocumentCounters in interface EvaluationOrBuilder

Returns:

Whether the documentCounters field is set.

getDocumentCounters

public Evaluation.Counters getDocumentCounters()

 Counters for the documents used in the evaluation.
 

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Specified by:

getDocumentCounters in interface EvaluationOrBuilder

Returns:

The documentCounters.

getDocumentCountersOrBuilder

public Evaluation.CountersOrBuilder getDocumentCountersOrBuilder()

 Counters for the documents used in the evaluation.
 

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Specified by:

getDocumentCountersOrBuilder in interface EvaluationOrBuilder

hasAllEntitiesMetrics

public boolean hasAllEntitiesMetrics()

 Metrics for all the entities in aggregate.
 

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Specified by:

hasAllEntitiesMetrics in interface EvaluationOrBuilder

Returns:

Whether the allEntitiesMetrics field is set.

getAllEntitiesMetrics

public Evaluation.MultiConfidenceMetrics getAllEntitiesMetrics()

 Metrics for all the entities in aggregate.
 

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Specified by:

getAllEntitiesMetrics in interface EvaluationOrBuilder

Returns:

The allEntitiesMetrics.

getAllEntitiesMetricsOrBuilder

public Evaluation.MultiConfidenceMetricsOrBuilder getAllEntitiesMetricsOrBuilder()

 Metrics for all the entities in aggregate.
 

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Specified by:

getAllEntitiesMetricsOrBuilder in interface EvaluationOrBuilder

getEntityMetricsCount

public int getEntityMetricsCount()

Description copied from interface: EvaluationOrBuilder

 Metrics across confidence levels, for different entities.
 

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Specified by:

getEntityMetricsCount in interface EvaluationOrBuilder

containsEntityMetrics

public boolean containsEntityMetrics(String key)

 Metrics across confidence levels, for different entities.
 

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Specified by:

containsEntityMetrics in interface EvaluationOrBuilder

getEntityMetrics

@Deprecated
public Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetrics()

Deprecated.

Use getEntityMetricsMap() instead.

Specified by:

getEntityMetrics in interface EvaluationOrBuilder

getEntityMetricsMap

public Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetricsMap()

 Metrics across confidence levels, for different entities.
 

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Specified by:

getEntityMetricsMap in interface EvaluationOrBuilder

getEntityMetricsOrDefault

public Evaluation.MultiConfidenceMetrics getEntityMetricsOrDefault(String key,
                                                                   Evaluation.MultiConfidenceMetrics defaultValue)

 Metrics across confidence levels, for different entities.
 

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Specified by:

getEntityMetricsOrDefault in interface EvaluationOrBuilder

getEntityMetricsOrThrow

public Evaluation.MultiConfidenceMetrics getEntityMetricsOrThrow(String key)

 Metrics across confidence levels, for different entities.
 

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Specified by:

getEntityMetricsOrThrow in interface EvaluationOrBuilder

getKmsKeyName

public String getKmsKeyName()

 The KMS key name used for encryption.
 

string kms_key_name = 6;

Specified by:

getKmsKeyName in interface EvaluationOrBuilder

Returns:

The kmsKeyName.

getKmsKeyNameBytes

public com.google.protobuf.ByteString getKmsKeyNameBytes()

 The KMS key name used for encryption.
 

string kms_key_name = 6;

Specified by:

getKmsKeyNameBytes in interface EvaluationOrBuilder

Returns:

The bytes for kmsKeyName.

getKmsKeyVersionName

public String getKmsKeyVersionName()

 The KMS key version with which data is encrypted.
 

string kms_key_version_name = 7;

Specified by:

getKmsKeyVersionName in interface EvaluationOrBuilder

Returns:

The kmsKeyVersionName.

getKmsKeyVersionNameBytes

public com.google.protobuf.ByteString getKmsKeyVersionNameBytes()

 The KMS key version with which data is encrypted.
 

string kms_key_version_name = 7;

Specified by:

getKmsKeyVersionNameBytes in interface EvaluationOrBuilder

Returns:

The bytes for kmsKeyVersionName.

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 parseFrom(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation 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 parseFrom(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Evaluation parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Evaluation.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Evaluation.Builder newBuilder()

newBuilder

public static Evaluation.Builder newBuilder(Evaluation prototype)

toBuilder

public Evaluation.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Evaluation getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Evaluation> 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 getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder