Package com.google.cloud.documentai.v1

Class Evaluation.Metrics

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.Evaluation.Metrics
All Implemented Interfaces:
Evaluation.MetricsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Evaluation
public static final class Evaluation.Metrics extends com.google.protobuf.GeneratedMessage implements Evaluation.MetricsOrBuilder
 Evaluation metrics, either in aggregate or about a specific entity.
Protobuf type google.cloud.documentai.v1.Evaluation.Metrics
See Also:

  • Field Details

    • PRECISION_FIELD_NUMBER

      public static final int PRECISION_FIELD_NUMBER
      See Also:

    • RECALL_FIELD_NUMBER

      public static final int RECALL_FIELD_NUMBER
      See Also:

    • F1_SCORE_FIELD_NUMBER

      public static final int F1_SCORE_FIELD_NUMBER
      See Also:

    • PREDICTED_OCCURRENCES_COUNT_FIELD_NUMBER

      public static final int PREDICTED_OCCURRENCES_COUNT_FIELD_NUMBER
      See Also:

    • GROUND_TRUTH_OCCURRENCES_COUNT_FIELD_NUMBER

      public static final int GROUND_TRUTH_OCCURRENCES_COUNT_FIELD_NUMBER
      See Also:

    • PREDICTED_DOCUMENT_COUNT_FIELD_NUMBER

      public static final int PREDICTED_DOCUMENT_COUNT_FIELD_NUMBER
      See Also:

    • GROUND_TRUTH_DOCUMENT_COUNT_FIELD_NUMBER

      public static final int GROUND_TRUTH_DOCUMENT_COUNT_FIELD_NUMBER
      See Also:

    • TRUE_POSITIVES_COUNT_FIELD_NUMBER

      public static final int TRUE_POSITIVES_COUNT_FIELD_NUMBER
      See Also:

    • FALSE_POSITIVES_COUNT_FIELD_NUMBER

      public static final int FALSE_POSITIVES_COUNT_FIELD_NUMBER
      See Also:

    • FALSE_NEGATIVES_COUNT_FIELD_NUMBER

      public static final int FALSE_NEGATIVES_COUNT_FIELD_NUMBER
      See Also:

    • TOTAL_DOCUMENTS_COUNT_FIELD_NUMBER

      public static final int TOTAL_DOCUMENTS_COUNT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getPrecision

      public float getPrecision()
       The calculated precision.
      float precision = 1;
      Specified by:
      getPrecision in interface Evaluation.MetricsOrBuilder
      Returns:
      The precision.

    • getRecall

      public float getRecall()
       The calculated recall.
      float recall = 2;
      Specified by:
      getRecall in interface Evaluation.MetricsOrBuilder
      Returns:
      The recall.

    • getF1Score

      public float getF1Score()
       The calculated f1 score.
      float f1_score = 3;
      Specified by:
      getF1Score in interface Evaluation.MetricsOrBuilder
      Returns:
      The f1Score.

    • getPredictedOccurrencesCount

      public int getPredictedOccurrencesCount()
       The amount of occurrences in predicted documents.
      int32 predicted_occurrences_count = 4;
      Specified by:
      getPredictedOccurrencesCount in interface Evaluation.MetricsOrBuilder
      Returns:
      The predictedOccurrencesCount.

    • getGroundTruthOccurrencesCount

      public int getGroundTruthOccurrencesCount()
       The amount of occurrences in ground truth documents.
      int32 ground_truth_occurrences_count = 5;
      Specified by:
      getGroundTruthOccurrencesCount in interface Evaluation.MetricsOrBuilder
      Returns:
      The groundTruthOccurrencesCount.

    • getPredictedDocumentCount

      public int getPredictedDocumentCount()
       The amount of documents with a predicted occurrence.
      int32 predicted_document_count = 10;
      Specified by:
      getPredictedDocumentCount in interface Evaluation.MetricsOrBuilder
      Returns:
      The predictedDocumentCount.

    • getGroundTruthDocumentCount

      public int getGroundTruthDocumentCount()
       The amount of documents with a ground truth occurrence.
      int32 ground_truth_document_count = 11;
      Specified by:
      getGroundTruthDocumentCount in interface Evaluation.MetricsOrBuilder
      Returns:
      The groundTruthDocumentCount.

    • getTruePositivesCount

      public int getTruePositivesCount()
       The amount of true positives.
      int32 true_positives_count = 6;
      Specified by:
      getTruePositivesCount in interface Evaluation.MetricsOrBuilder
      Returns:
      The truePositivesCount.

    • getFalsePositivesCount

      public int getFalsePositivesCount()
       The amount of false positives.
      int32 false_positives_count = 7;
      Specified by:
      getFalsePositivesCount in interface Evaluation.MetricsOrBuilder
      Returns:
      The falsePositivesCount.

    • getFalseNegativesCount

      public int getFalseNegativesCount()
       The amount of false negatives.
      int32 false_negatives_count = 8;
      Specified by:
      getFalseNegativesCount in interface Evaluation.MetricsOrBuilder
      Returns:
      The falseNegativesCount.

    • getTotalDocumentsCount

      public int getTotalDocumentsCount()
       The amount of documents that had an occurrence of this label.
      int32 total_documents_count = 9;
      Specified by:
      getTotalDocumentsCount in interface Evaluation.MetricsOrBuilder
      Returns:
      The totalDocumentsCount.

    • 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.Metrics parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Evaluation.Metrics 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.Metrics parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Evaluation.Metrics.Builder newBuilder()

    • newBuilder

      public static Evaluation.Metrics.Builder newBuilder(Evaluation.Metrics prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Evaluation.Metrics getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Evaluation.Metrics> 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.Metrics getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder