Class Evaluation (2.39.0)

public final class Evaluation extends GeneratedMessageV3 implements EvaluationOrBuilder

An evaluation of a ProcessorVersion's performance.

Protobuf type google.cloud.documentai.v1.Evaluation

Implements

EvaluationOrBuilder

Static Fields

ALL_ENTITIES_METRICS_FIELD_NUMBER

public static final int ALL_ENTITIES_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_COUNTERS_FIELD_NUMBER

public static final int DOCUMENT_COUNTERS_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_METRICS_FIELD_NUMBER

public static final int ENTITY_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_VERSION_NAME_FIELD_NUMBER

public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Evaluation getDefaultInstance()
Returns
TypeDescription
Evaluation

getDescriptor()

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

newBuilder()

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

newBuilder(Evaluation prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsEntityMetrics(String key)

public boolean containsEntityMetrics(String key)

Metrics across confidence levels, for different entities.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getAllEntitiesMetrics()

public Evaluation.MultiConfidenceMetrics getAllEntitiesMetrics()

Metrics for all the entities in aggregate.

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

Returns
TypeDescription
Evaluation.MultiConfidenceMetrics

The allEntitiesMetrics.

getAllEntitiesMetricsOrBuilder()

public Evaluation.MultiConfidenceMetricsOrBuilder getAllEntitiesMetricsOrBuilder()

Metrics for all the entities in aggregate.

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

Returns
TypeDescription
Evaluation.MultiConfidenceMetricsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Evaluation getDefaultInstanceForType()
Returns
TypeDescription
Evaluation

getDocumentCounters()

public Evaluation.Counters getDocumentCounters()

Counters for the documents used in the evaluation.

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

Returns
TypeDescription
Evaluation.Counters

The documentCounters.

getDocumentCountersOrBuilder()

public Evaluation.CountersOrBuilder getDocumentCountersOrBuilder()

Counters for the documents used in the evaluation.

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

Returns
TypeDescription
Evaluation.CountersOrBuilder

getEntityMetrics() (deprecated)

public Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetrics()
Returns
TypeDescription
Map<String,MultiConfidenceMetrics>

getEntityMetricsCount()

public int getEntityMetricsCount()

Metrics across confidence levels, for different entities.

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

Returns
TypeDescription
int

getEntityMetricsMap()

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

Metrics across confidence levels, for different entities.

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

Returns
TypeDescription
Map<String,MultiConfidenceMetrics>

getEntityMetricsOrDefault(String key, Evaluation.MultiConfidenceMetrics defaultValue)

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

Metrics across confidence levels, for different entities.

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

Parameters
NameDescription
keyString
defaultValueEvaluation.MultiConfidenceMetrics
Returns
TypeDescription
Evaluation.MultiConfidenceMetrics

getEntityMetricsOrThrow(String key)

public Evaluation.MultiConfidenceMetrics getEntityMetricsOrThrow(String key)

Metrics across confidence levels, for different entities.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Evaluation.MultiConfidenceMetrics

getKmsKeyName()

public String getKmsKeyName()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
TypeDescription
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
TypeDescription
ByteString

The bytes for kmsKeyName.

getKmsKeyVersionName()

public String getKmsKeyVersionName()

The KMS key version with which data is encrypted.

string kms_key_version_name = 7;

Returns
TypeDescription
String

The kmsKeyVersionName.

getKmsKeyVersionNameBytes()

public ByteString getKmsKeyVersionNameBytes()

The KMS key version with which data is encrypted.

string kms_key_version_name = 7;

Returns
TypeDescription
ByteString

The bytes for kmsKeyVersionName.

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;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasAllEntitiesMetrics()

public boolean hasAllEntitiesMetrics()

Metrics for all the entities in aggregate.

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

Returns
TypeDescription
boolean

Whether the allEntitiesMetrics field is set.

hasCreateTime()

public boolean hasCreateTime()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDocumentCounters()

public boolean hasDocumentCounters()

Counters for the documents used in the evaluation.

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

Returns
TypeDescription
boolean

Whether the documentCounters field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Evaluation.Builder newBuilderForType()
Returns
TypeDescription
Evaluation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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