Interface EvaluationOrBuilder (2.25.0)

Version 2.25.0

• 2.59.0 (latest)
• 2.58.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public interface EvaluationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsEntityMetrics(String key)

public abstract 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

getAllEntitiesMetrics()

public abstract 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 abstract 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 abstract Timestamp getCreateTime()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type	Description
TimestampOrBuilder

getDocumentCounters()

public abstract 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 abstract 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()

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

Use #getEntityMetricsMap() instead.

Returns
Type	Description
Map<String,MultiConfidenceMetrics>

getEntityMetricsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract String getKmsKeyName()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
Type	Description
String	The kmsKeyName.

getKmsKeyNameBytes()

public abstract ByteString getKmsKeyNameBytes()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
Type	Description
ByteString	The bytes for kmsKeyName.

getKmsKeyVersionName()

public abstract 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 abstract 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 abstract 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 abstract 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.

hasAllEntitiesMetrics()

public abstract 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 abstract 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 abstract 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.