Package com.google.cloud.discoveryengine.v1beta

Class QualityMetrics

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.QualityMetrics
All Implemented Interfaces:
QualityMetricsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class QualityMetrics extends com.google.protobuf.GeneratedMessage implements QualityMetricsOrBuilder
 Describes the metrics produced by the evaluation.
Protobuf type google.cloud.discoveryengine.v1beta.QualityMetrics
See Also:

  • Field Details

    • DOC_RECALL_FIELD_NUMBER

      public static final int DOC_RECALL_FIELD_NUMBER
      See Also:

    • DOC_PRECISION_FIELD_NUMBER

      public static final int DOC_PRECISION_FIELD_NUMBER
      See Also:

    • DOC_NDCG_FIELD_NUMBER

      public static final int DOC_NDCG_FIELD_NUMBER
      See Also:

    • PAGE_RECALL_FIELD_NUMBER

      public static final int PAGE_RECALL_FIELD_NUMBER
      See Also:

    • PAGE_NDCG_FIELD_NUMBER

      public static final int PAGE_NDCG_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

    • hasDocRecall

      public boolean hasDocRecall()
       Recall per document, at various top-k cutoff levels.

 Recall is the fraction of relevant documents retrieved out of all
 relevant documents.

 Example (top-5):
 * For a single
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], If 3 out
 of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics doc_recall = 1;
      Specified by:
      hasDocRecall in interface QualityMetricsOrBuilder
      Returns:
      Whether the docRecall field is set.

    • getDocRecall

      public QualityMetrics.TopkMetrics getDocRecall()
       Recall per document, at various top-k cutoff levels.

 Recall is the fraction of relevant documents retrieved out of all
 relevant documents.

 Example (top-5):
 * For a single
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], If 3 out
 of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics doc_recall = 1;
      Specified by:
      getDocRecall in interface QualityMetricsOrBuilder
      Returns:
      The docRecall.

    • getDocRecallOrBuilder

      public QualityMetrics.TopkMetricsOrBuilder getDocRecallOrBuilder()
       Recall per document, at various top-k cutoff levels.

 Recall is the fraction of relevant documents retrieved out of all
 relevant documents.

 Example (top-5):
 * For a single
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], If 3 out
 of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics doc_recall = 1;
      Specified by:
      getDocRecallOrBuilder in interface QualityMetricsOrBuilder

    • hasDocPrecision

      public boolean hasDocPrecision()
       Precision per document, at various top-k cutoff levels.

 Precision is the fraction of retrieved documents that are relevant.

 Example (top-5):
 * For a single
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], If 4 out
 of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 =
 0.8
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics doc_precision = 2;
      Specified by:
      hasDocPrecision in interface QualityMetricsOrBuilder
      Returns:
      Whether the docPrecision field is set.

    • getDocPrecision

      public QualityMetrics.TopkMetrics getDocPrecision()
       Precision per document, at various top-k cutoff levels.

 Precision is the fraction of retrieved documents that are relevant.

 Example (top-5):
 * For a single
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], If 4 out
 of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 =
 0.8
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics doc_precision = 2;
      Specified by:
      getDocPrecision in interface QualityMetricsOrBuilder
      Returns:
      The docPrecision.

    • getDocPrecisionOrBuilder

      public QualityMetrics.TopkMetricsOrBuilder getDocPrecisionOrBuilder()
       Precision per document, at various top-k cutoff levels.

 Precision is the fraction of retrieved documents that are relevant.

 Example (top-5):
 * For a single
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], If 4 out
 of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 =
 0.8
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics doc_precision = 2;
      Specified by:
      getDocPrecisionOrBuilder in interface QualityMetricsOrBuilder

    • hasDocNdcg

      public boolean hasDocNdcg()
       Normalized discounted cumulative gain (NDCG) per document, at various top-k
 cutoff levels.

 NDCG measures the ranking quality, giving higher relevance to top
 results.

 Example (top-3):
 Suppose [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]
 with three retrieved documents (D1, D2, D3) and binary relevance
 judgements (1 for relevant, 0 for not relevant):

 Retrieved:  [D3 (0), D1 (1), D2 (1)]
 Ideal:      [D1 (1), D2 (1), D3 (0)]

 Calculate NDCG@3 for each
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]:
 * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
 * NDCG@3: 1.13/1.63 = 0.693
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics doc_ndcg = 3;
      Specified by:
      hasDocNdcg in interface QualityMetricsOrBuilder
      Returns:
      Whether the docNdcg field is set.

    • getDocNdcg

      public QualityMetrics.TopkMetrics getDocNdcg()
       Normalized discounted cumulative gain (NDCG) per document, at various top-k
 cutoff levels.

 NDCG measures the ranking quality, giving higher relevance to top
 results.

 Example (top-3):
 Suppose [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]
 with three retrieved documents (D1, D2, D3) and binary relevance
 judgements (1 for relevant, 0 for not relevant):

 Retrieved:  [D3 (0), D1 (1), D2 (1)]
 Ideal:      [D1 (1), D2 (1), D3 (0)]

 Calculate NDCG@3 for each
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]:
 * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
 * NDCG@3: 1.13/1.63 = 0.693
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics doc_ndcg = 3;
      Specified by:
      getDocNdcg in interface QualityMetricsOrBuilder
      Returns:
      The docNdcg.

    • getDocNdcgOrBuilder

      public QualityMetrics.TopkMetricsOrBuilder getDocNdcgOrBuilder()
       Normalized discounted cumulative gain (NDCG) per document, at various top-k
 cutoff levels.

 NDCG measures the ranking quality, giving higher relevance to top
 results.

 Example (top-3):
 Suppose [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]
 with three retrieved documents (D1, D2, D3) and binary relevance
 judgements (1 for relevant, 0 for not relevant):

 Retrieved:  [D3 (0), D1 (1), D2 (1)]
 Ideal:      [D1 (1), D2 (1), D3 (0)]

 Calculate NDCG@3 for each
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]:
 * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
 * NDCG@3: 1.13/1.63 = 0.693
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics doc_ndcg = 3;
      Specified by:
      getDocNdcgOrBuilder in interface QualityMetricsOrBuilder

    • hasPageRecall

      public boolean hasPageRecall()
       Recall per page, at various top-k cutoff levels.

 Recall is the fraction of relevant pages retrieved out of all relevant
 pages.

 Example (top-5):
 * For a single
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], if 3 out
 of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics page_recall = 4;
      Specified by:
      hasPageRecall in interface QualityMetricsOrBuilder
      Returns:
      Whether the pageRecall field is set.

    • getPageRecall

      public QualityMetrics.TopkMetrics getPageRecall()
       Recall per page, at various top-k cutoff levels.

 Recall is the fraction of relevant pages retrieved out of all relevant
 pages.

 Example (top-5):
 * For a single
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], if 3 out
 of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics page_recall = 4;
      Specified by:
      getPageRecall in interface QualityMetricsOrBuilder
      Returns:
      The pageRecall.

    • getPageRecallOrBuilder

      public QualityMetrics.TopkMetricsOrBuilder getPageRecallOrBuilder()
       Recall per page, at various top-k cutoff levels.

 Recall is the fraction of relevant pages retrieved out of all relevant
 pages.

 Example (top-5):
 * For a single
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], if 3 out
 of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics page_recall = 4;
      Specified by:
      getPageRecallOrBuilder in interface QualityMetricsOrBuilder

    • hasPageNdcg

      public boolean hasPageNdcg()
       Normalized discounted cumulative gain (NDCG) per page, at various top-k
 cutoff levels.

 NDCG measures the ranking quality, giving higher relevance to top
 results.

 Example (top-3):
 Suppose [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]
 with three retrieved pages (P1, P2, P3) and binary relevance judgements (1
 for relevant, 0 for not relevant):

 Retrieved:  [P3 (0), P1 (1), P2 (1)]
 Ideal:      [P1 (1), P2 (1), P3 (0)]

 Calculate NDCG@3 for
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]:
 * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
 * NDCG@3: 1.13/1.63 = 0.693
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics page_ndcg = 5;
      Specified by:
      hasPageNdcg in interface QualityMetricsOrBuilder
      Returns:
      Whether the pageNdcg field is set.

    • getPageNdcg

      public QualityMetrics.TopkMetrics getPageNdcg()
       Normalized discounted cumulative gain (NDCG) per page, at various top-k
 cutoff levels.

 NDCG measures the ranking quality, giving higher relevance to top
 results.

 Example (top-3):
 Suppose [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]
 with three retrieved pages (P1, P2, P3) and binary relevance judgements (1
 for relevant, 0 for not relevant):

 Retrieved:  [P3 (0), P1 (1), P2 (1)]
 Ideal:      [P1 (1), P2 (1), P3 (0)]

 Calculate NDCG@3 for
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]:
 * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
 * NDCG@3: 1.13/1.63 = 0.693
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics page_ndcg = 5;
      Specified by:
      getPageNdcg in interface QualityMetricsOrBuilder
      Returns:
      The pageNdcg.

    • getPageNdcgOrBuilder

      public QualityMetrics.TopkMetricsOrBuilder getPageNdcgOrBuilder()
       Normalized discounted cumulative gain (NDCG) per page, at various top-k
 cutoff levels.

 NDCG measures the ranking quality, giving higher relevance to top
 results.

 Example (top-3):
 Suppose [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]
 with three retrieved pages (P1, P2, P3) and binary relevance judgements (1
 for relevant, 0 for not relevant):

 Retrieved:  [P3 (0), P1 (1), P2 (1)]
 Ideal:      [P1 (1), P2 (1), P3 (0)]

 Calculate NDCG@3 for
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]:
 * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
 * NDCG@3: 1.13/1.63 = 0.693
      .google.cloud.discoveryengine.v1beta.QualityMetrics.TopkMetrics page_ndcg = 5;
      Specified by:
      getPageNdcgOrBuilder in interface QualityMetricsOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static QualityMetrics.Builder newBuilder()

    • newBuilder

      public static QualityMetrics.Builder newBuilder(QualityMetrics prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static QualityMetrics getDefaultInstance()

    • parser

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

    • getParserForType

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