Package com.google.cloud.documentai.v1

Class Evaluation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.Evaluation
All Implemented Interfaces:
EvaluationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Evaluation extends com.google.protobuf.GeneratedMessage implements EvaluationOrBuilder
 An evaluation of a ProcessorVersion's performance.
Protobuf type google.cloud.documentai.v1.Evaluation
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • DOCUMENT_COUNTERS_FIELD_NUMBER

      public static final int DOCUMENT_COUNTERS_FIELD_NUMBER
      See Also:

    • ALL_ENTITIES_METRICS_FIELD_NUMBER

      public static final int ALL_ENTITIES_METRICS_FIELD_NUMBER
      See Also:

    • ENTITY_METRICS_FIELD_NUMBER

      public static final int ENTITY_METRICS_FIELD_NUMBER
      See Also:

    • KMS_KEY_NAME_FIELD_NUMBER

      public static final int KMS_KEY_NAME_FIELD_NUMBER
      See Also:

    • KMS_KEY_VERSION_NAME_FIELD_NUMBER

      public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      getName in interface EvaluationOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface EvaluationOrBuilder
      Returns:
      The bytes for name.

    • hasCreateTime

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

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       The time that the evaluation was created.
      .google.protobuf.Timestamp create_time = 2;
      Specified by:
      getCreateTime in interface EvaluationOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       The time that the evaluation was created.
      .google.protobuf.Timestamp create_time = 2;
      Specified by:
      getCreateTimeOrBuilder in interface EvaluationOrBuilder

    • hasDocumentCounters

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

    • getDocumentCounters

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

    • getDocumentCountersOrBuilder

      public Evaluation.CountersOrBuilder getDocumentCountersOrBuilder()
       Counters for the documents used in the evaluation.
      .google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;
      Specified by:
      getDocumentCountersOrBuilder in interface EvaluationOrBuilder

    • hasAllEntitiesMetrics

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

    • getAllEntitiesMetrics

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

    • getAllEntitiesMetricsOrBuilder

      public Evaluation.MultiConfidenceMetricsOrBuilder getAllEntitiesMetricsOrBuilder()
       Metrics for all the entities in aggregate.
      .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
      Specified by:
      getAllEntitiesMetricsOrBuilder in interface EvaluationOrBuilder

    • getEntityMetricsCount

      public int getEntityMetricsCount()
      Description copied from interface: EvaluationOrBuilder
       Metrics across confidence levels, for different entities.
      map<string, .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
      Specified by:
      getEntityMetricsCount in interface EvaluationOrBuilder

    • containsEntityMetrics

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

    • getEntityMetrics

      @Deprecated public Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetrics()
      Deprecated.
      Use getEntityMetricsMap() instead.
      Specified by:
      getEntityMetrics in interface EvaluationOrBuilder

    • 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;
      Specified by:
      getEntityMetricsMap in interface EvaluationOrBuilder

    • getEntityMetricsOrDefault

      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;
      Specified by:
      getEntityMetricsOrDefault in interface EvaluationOrBuilder

    • getEntityMetricsOrThrow

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

    • getKmsKeyName

      public String getKmsKeyName()
       The KMS key name used for encryption.
      string kms_key_name = 6;
      Specified by:
      getKmsKeyName in interface EvaluationOrBuilder
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

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

    • getKmsKeyVersionName

      public String getKmsKeyVersionName()
       The KMS key version with which data is encrypted.
      string kms_key_version_name = 7;
      Specified by:
      getKmsKeyVersionName in interface EvaluationOrBuilder
      Returns:
      The kmsKeyVersionName.

    • getKmsKeyVersionNameBytes

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Evaluation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Evaluation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Evaluation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Evaluation.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Evaluation.Builder newBuilder()

    • newBuilder

      public static Evaluation.Builder newBuilder(Evaluation prototype)

    • toBuilder

      public Evaluation.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Evaluation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Evaluation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Evaluation> parser()

    • getParserForType

      public com.google.protobuf.Parser<Evaluation> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Evaluation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder