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

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_COUNTERS_FIELD_NUMBER

public static final int DOCUMENT_COUNTERS_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_METRICS_FIELD_NUMBER

public static final int ENTITY_METRICS_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_VERSION_NAME_FIELD_NUMBER

public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Evaluation getDefaultInstance()
Returns
Type Description
Evaluation

getDescriptor()

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

newBuilder()

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

newBuilder(Evaluation prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Evaluation> parser()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
Evaluation.MultiConfidenceMetricsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Evaluation getDefaultInstanceForType()
Returns
Type Description
Evaluation

getDocumentCounters()

public Evaluation.Counters getDocumentCounters()

Counters for the documents used in the evaluation.

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

Returns
Type Description
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
Type Description
Evaluation.CountersOrBuilder

getEntityMetrics() (deprecated)

public Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetrics()
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue Evaluation.MultiConfidenceMetrics
Returns
Type Description
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
Name Description
key String
Returns
Type Description
Evaluation.MultiConfidenceMetrics

getKmsKeyName()

public String getKmsKeyName()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

The KMS key name used for encryption.

string kms_key_name = 6;

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

The kmsKeyVersionName.

getKmsKeyVersionNameBytes()

public ByteString getKmsKeyVersionNameBytes()

The KMS key version with which data is encrypted.

string kms_key_version_name = 7;

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

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAllEntitiesMetrics()

public boolean hasAllEntitiesMetrics()

Metrics for all the entities in aggregate.

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

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

Whether the documentCounters field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Evaluation.Builder newBuilderForType()
Returns
Type Description
Evaluation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

writeTo(CodedOutputStream output)

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