Package com.google.cloud.documentai.v1

Interface EvaluationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Evaluation, Evaluation.Builder
@Generated public interface EvaluationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       The resource name of the evaluation.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • hasCreateTime

      boolean hasCreateTime()
       The time that the evaluation was created.
      .google.protobuf.Timestamp create_time = 2;
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       The time that the evaluation was created.
      .google.protobuf.Timestamp create_time = 2;
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       The time that the evaluation was created.
      .google.protobuf.Timestamp create_time = 2;

    • hasDocumentCounters

      boolean hasDocumentCounters()
       Counters for the documents used in the evaluation.
      .google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;
      Returns:
      Whether the documentCounters field is set.

    • getDocumentCounters

      Evaluation.Counters getDocumentCounters()
       Counters for the documents used in the evaluation.
      .google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;
      Returns:
      The documentCounters.

    • getDocumentCountersOrBuilder

      Evaluation.CountersOrBuilder getDocumentCountersOrBuilder()
       Counters for the documents used in the evaluation.
      .google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;

    • hasAllEntitiesMetrics

      boolean hasAllEntitiesMetrics()
       Metrics for all the entities in aggregate.
      .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
      Returns:
      Whether the allEntitiesMetrics field is set.

    • getAllEntitiesMetrics

      Evaluation.MultiConfidenceMetrics getAllEntitiesMetrics()
       Metrics for all the entities in aggregate.
      .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
      Returns:
      The allEntitiesMetrics.

    • getAllEntitiesMetricsOrBuilder

      Evaluation.MultiConfidenceMetricsOrBuilder getAllEntitiesMetricsOrBuilder()
       Metrics for all the entities in aggregate.
      .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

    • getEntityMetricsCount

      int getEntityMetricsCount()
       Metrics across confidence levels, for different entities.
      map<string, .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

    • containsEntityMetrics

      boolean containsEntityMetrics(String key)
       Metrics across confidence levels, for different entities.
      map<string, .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

    • getEntityMetrics

      @Deprecated Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetrics()
      Deprecated.
      Use getEntityMetricsMap() instead.

    • getEntityMetricsMap

      Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetricsMap()
       Metrics across confidence levels, for different entities.
      map<string, .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

    • getEntityMetricsOrDefault

      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;

    • getEntityMetricsOrThrow

      Evaluation.MultiConfidenceMetrics getEntityMetricsOrThrow(String key)
       Metrics across confidence levels, for different entities.
      map<string, .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

    • getKmsKeyName

      String getKmsKeyName()
       The KMS key name used for encryption.
      string kms_key_name = 6;
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

      com.google.protobuf.ByteString getKmsKeyNameBytes()
       The KMS key name used for encryption.
      string kms_key_name = 6;
      Returns:
      The bytes for kmsKeyName.

    • getKmsKeyVersionName

      String getKmsKeyVersionName()
       The KMS key version with which data is encrypted.
      string kms_key_version_name = 7;
      Returns:
      The kmsKeyVersionName.

    • getKmsKeyVersionNameBytes

      com.google.protobuf.ByteString getKmsKeyVersionNameBytes()
       The KMS key version with which data is encrypted.
      string kms_key_version_name = 7;
      Returns:
      The bytes for kmsKeyVersionName.