/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/documentai/v1beta3/evaluation.proto
package com.google.cloud.documentai.v1beta3;
public interface EvaluationOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta3.Evaluation)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The resource name of the evaluation.
* Format:
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The resource name of the evaluation.
* Format:
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The time that the evaluation was created.
*
*
* .google.protobuf.Timestamp create_time = 2;
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* The time that the evaluation was created.
*
*
* .google.protobuf.Timestamp create_time = 2;
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* The time that the evaluation was created.
*
*
* .google.protobuf.Timestamp create_time = 2;
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Counters for the documents used in the evaluation.
*
*
* .google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;
*
* @return Whether the documentCounters field is set.
*/
boolean hasDocumentCounters();
/**
*
*
*
* Counters for the documents used in the evaluation.
*
*
* .google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;
*
* @return The documentCounters.
*/
com.google.cloud.documentai.v1beta3.Evaluation.Counters getDocumentCounters();
/**
*
*
*
* Counters for the documents used in the evaluation.
*
*
* .google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;
*/
com.google.cloud.documentai.v1beta3.Evaluation.CountersOrBuilder getDocumentCountersOrBuilder();
/**
*
*
*
* Metrics for all the entities in aggregate.
*
*
*
* .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
*
*
* @return Whether the allEntitiesMetrics field is set.
*/
boolean hasAllEntitiesMetrics();
/**
*
*
*
* Metrics for all the entities in aggregate.
*
*
*
* .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
*
*
* @return The allEntitiesMetrics.
*/
com.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics getAllEntitiesMetrics();
/**
*
*
*
* Metrics for all the entities in aggregate.
*
*
*
* .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
*
*/
com.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetricsOrBuilder
getAllEntitiesMetricsOrBuilder();
/**
*
*
*
* Metrics across confidence levels, for different entities.
*
*
*
* map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
*
*/
int getEntityMetricsCount();
/**
*
*
*
* Metrics across confidence levels, for different entities.
*
*
*
* map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
*
*/
boolean containsEntityMetrics(java.lang.String key);
/** Use {@link #getEntityMetricsMap()} instead. */
@java.lang.Deprecated
java.util.Map<
java.lang.String, com.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics>
getEntityMetrics();
/**
*
*
*
* Metrics across confidence levels, for different entities.
*
*
*
* map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
*
*/
java.util.Map<
java.lang.String, com.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics>
getEntityMetricsMap();
/**
*
*
*
* Metrics across confidence levels, for different entities.
*
*
*
* map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
*
*/
/* nullable */
com.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics getEntityMetricsOrDefault(
java.lang.String key,
/* nullable */
com.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics defaultValue);
/**
*
*
*
* Metrics across confidence levels, for different entities.
*
*
*
* map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
*
*/
com.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics getEntityMetricsOrThrow(
java.lang.String key);
/**
*
*
*
* The KMS key name used for encryption.
*
*
* string kms_key_name = 6;
*
* @return The kmsKeyName.
*/
java.lang.String getKmsKeyName();
/**
*
*
*
* The KMS key name used for encryption.
*
*
* string kms_key_name = 6;
*
* @return The bytes for kmsKeyName.
*/
com.google.protobuf.ByteString getKmsKeyNameBytes();
/**
*
*
*
* The KMS key version with which data is encrypted.
*
*
* string kms_key_version_name = 7;
*
* @return The kmsKeyVersionName.
*/
java.lang.String getKmsKeyVersionName();
/**
*
*
*
* The KMS key version with which data is encrypted.
*
*
* string kms_key_version_name = 7;
*
* @return The bytes for kmsKeyVersionName.
*/
com.google.protobuf.ByteString getKmsKeyVersionNameBytes();
}