public static final class QualityMetrics.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder> implements QualityMetricsOrBuilder
Describes the metrics produced by the evaluation.Protobuf type
google.cloud.discoveryengine.v1beta.QualityMetrics| Modifier and Type | Method and Description |
|---|---|
QualityMetrics.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
QualityMetrics |
build() |
QualityMetrics |
buildPartial() |
QualityMetrics.Builder |
clear() |
QualityMetrics.Builder |
clearDocNdcg()
Normalized discounted cumulative gain (NDCG) per document, at various top-k
cutoff levels.
|
QualityMetrics.Builder |
clearDocPrecision()
Precision per document, at various top-k cutoff levels.
|
QualityMetrics.Builder |
clearDocRecall()
Recall per document, at various top-k cutoff levels.
|
QualityMetrics.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
QualityMetrics.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
QualityMetrics.Builder |
clearPageNdcg()
Normalized discounted cumulative gain (NDCG) per page, at various top-k
cutoff levels.
|
QualityMetrics.Builder |
clearPageRecall()
Recall per page, at various top-k cutoff levels.
|
QualityMetrics.Builder |
clone() |
QualityMetrics |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
QualityMetrics.TopkMetrics |
getDocNdcg()
Normalized discounted cumulative gain (NDCG) per document, at various top-k
cutoff levels.
|
QualityMetrics.TopkMetrics.Builder |
getDocNdcgBuilder()
Normalized discounted cumulative gain (NDCG) per document, at various top-k
cutoff levels.
|
QualityMetrics.TopkMetricsOrBuilder |
getDocNdcgOrBuilder()
Normalized discounted cumulative gain (NDCG) per document, at various top-k
cutoff levels.
|
QualityMetrics.TopkMetrics |
getDocPrecision()
Precision per document, at various top-k cutoff levels.
|
QualityMetrics.TopkMetrics.Builder |
getDocPrecisionBuilder()
Precision per document, at various top-k cutoff levels.
|
QualityMetrics.TopkMetricsOrBuilder |
getDocPrecisionOrBuilder()
Precision per document, at various top-k cutoff levels.
|
QualityMetrics.TopkMetrics |
getDocRecall()
Recall per document, at various top-k cutoff levels.
|
QualityMetrics.TopkMetrics.Builder |
getDocRecallBuilder()
Recall per document, at various top-k cutoff levels.
|
QualityMetrics.TopkMetricsOrBuilder |
getDocRecallOrBuilder()
Recall per document, at various top-k cutoff levels.
|
QualityMetrics.TopkMetrics |
getPageNdcg()
Normalized discounted cumulative gain (NDCG) per page, at various top-k
cutoff levels.
|
QualityMetrics.TopkMetrics.Builder |
getPageNdcgBuilder()
Normalized discounted cumulative gain (NDCG) per page, at various top-k
cutoff levels.
|
QualityMetrics.TopkMetricsOrBuilder |
getPageNdcgOrBuilder()
Normalized discounted cumulative gain (NDCG) per page, at various top-k
cutoff levels.
|
QualityMetrics.TopkMetrics |
getPageRecall()
Recall per page, at various top-k cutoff levels.
|
QualityMetrics.TopkMetrics.Builder |
getPageRecallBuilder()
Recall per page, at various top-k cutoff levels.
|
QualityMetrics.TopkMetricsOrBuilder |
getPageRecallOrBuilder()
Recall per page, at various top-k cutoff levels.
|
boolean |
hasDocNdcg()
Normalized discounted cumulative gain (NDCG) per document, at various top-k
cutoff levels.
|
boolean |
hasDocPrecision()
Precision per document, at various top-k cutoff levels.
|
boolean |
hasDocRecall()
Recall per document, at various top-k cutoff levels.
|
boolean |
hasPageNdcg()
Normalized discounted cumulative gain (NDCG) per page, at various top-k
cutoff levels.
|
boolean |
hasPageRecall()
Recall per page, at various top-k cutoff levels.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
QualityMetrics.Builder |
mergeDocNdcg(QualityMetrics.TopkMetrics value)
Normalized discounted cumulative gain (NDCG) per document, at various top-k
cutoff levels.
|
QualityMetrics.Builder |
mergeDocPrecision(QualityMetrics.TopkMetrics value)
Precision per document, at various top-k cutoff levels.
|
QualityMetrics.Builder |
mergeDocRecall(QualityMetrics.TopkMetrics value)
Recall per document, at various top-k cutoff levels.
|
QualityMetrics.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
QualityMetrics.Builder |
mergeFrom(com.google.protobuf.Message other) |
QualityMetrics.Builder |
mergeFrom(QualityMetrics other) |
QualityMetrics.Builder |
mergePageNdcg(QualityMetrics.TopkMetrics value)
Normalized discounted cumulative gain (NDCG) per page, at various top-k
cutoff levels.
|
QualityMetrics.Builder |
mergePageRecall(QualityMetrics.TopkMetrics value)
Recall per page, at various top-k cutoff levels.
|
QualityMetrics.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
QualityMetrics.Builder |
setDocNdcg(QualityMetrics.TopkMetrics.Builder builderForValue)
Normalized discounted cumulative gain (NDCG) per document, at various top-k
cutoff levels.
|
QualityMetrics.Builder |
setDocNdcg(QualityMetrics.TopkMetrics value)
Normalized discounted cumulative gain (NDCG) per document, at various top-k
cutoff levels.
|
QualityMetrics.Builder |
setDocPrecision(QualityMetrics.TopkMetrics.Builder builderForValue)
Precision per document, at various top-k cutoff levels.
|
QualityMetrics.Builder |
setDocPrecision(QualityMetrics.TopkMetrics value)
Precision per document, at various top-k cutoff levels.
|
QualityMetrics.Builder |
setDocRecall(QualityMetrics.TopkMetrics.Builder builderForValue)
Recall per document, at various top-k cutoff levels.
|
QualityMetrics.Builder |
setDocRecall(QualityMetrics.TopkMetrics value)
Recall per document, at various top-k cutoff levels.
|
QualityMetrics.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
QualityMetrics.Builder |
setPageNdcg(QualityMetrics.TopkMetrics.Builder builderForValue)
Normalized discounted cumulative gain (NDCG) per page, at various top-k
cutoff levels.
|
QualityMetrics.Builder |
setPageNdcg(QualityMetrics.TopkMetrics value)
Normalized discounted cumulative gain (NDCG) per page, at various top-k
cutoff levels.
|
QualityMetrics.Builder |
setPageRecall(QualityMetrics.TopkMetrics.Builder builderForValue)
Recall per page, at various top-k cutoff levels.
|
QualityMetrics.Builder |
setPageRecall(QualityMetrics.TopkMetrics value)
Recall per page, at various top-k cutoff levels.
|
QualityMetrics.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
QualityMetrics.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public QualityMetrics.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public QualityMetrics getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic QualityMetrics build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic QualityMetrics buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic QualityMetrics.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public QualityMetrics.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public QualityMetrics.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public QualityMetrics.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public QualityMetrics.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public QualityMetrics.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public QualityMetrics.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<QualityMetrics.Builder>public QualityMetrics.Builder mergeFrom(QualityMetrics other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public QualityMetrics.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<QualityMetrics.Builder>IOExceptionpublic 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;hasDocRecall in interface QualityMetricsOrBuilderpublic 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;getDocRecall in interface QualityMetricsOrBuilderpublic QualityMetrics.Builder setDocRecall(QualityMetrics.TopkMetrics value)
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;public QualityMetrics.Builder setDocRecall(QualityMetrics.TopkMetrics.Builder builderForValue)
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;public QualityMetrics.Builder mergeDocRecall(QualityMetrics.TopkMetrics value)
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;public QualityMetrics.Builder clearDocRecall()
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;public QualityMetrics.TopkMetrics.Builder getDocRecallBuilder()
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;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;getDocRecallOrBuilder in interface QualityMetricsOrBuilderpublic 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;
hasDocPrecision in interface QualityMetricsOrBuilderpublic 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;
getDocPrecision in interface QualityMetricsOrBuilderpublic QualityMetrics.Builder setDocPrecision(QualityMetrics.TopkMetrics value)
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;
public QualityMetrics.Builder setDocPrecision(QualityMetrics.TopkMetrics.Builder builderForValue)
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;
public QualityMetrics.Builder mergeDocPrecision(QualityMetrics.TopkMetrics value)
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;
public QualityMetrics.Builder clearDocPrecision()
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;
public QualityMetrics.TopkMetrics.Builder getDocPrecisionBuilder()
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;
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;
getDocPrecisionOrBuilder in interface QualityMetricsOrBuilderpublic 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;hasDocNdcg in interface QualityMetricsOrBuilderpublic 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;getDocNdcg in interface QualityMetricsOrBuilderpublic QualityMetrics.Builder setDocNdcg(QualityMetrics.TopkMetrics value)
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;public QualityMetrics.Builder setDocNdcg(QualityMetrics.TopkMetrics.Builder builderForValue)
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;public QualityMetrics.Builder mergeDocNdcg(QualityMetrics.TopkMetrics value)
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;public QualityMetrics.Builder clearDocNdcg()
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;public QualityMetrics.TopkMetrics.Builder getDocNdcgBuilder()
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;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;getDocNdcgOrBuilder in interface QualityMetricsOrBuilderpublic 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;hasPageRecall in interface QualityMetricsOrBuilderpublic 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;getPageRecall in interface QualityMetricsOrBuilderpublic QualityMetrics.Builder setPageRecall(QualityMetrics.TopkMetrics value)
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;public QualityMetrics.Builder setPageRecall(QualityMetrics.TopkMetrics.Builder builderForValue)
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;public QualityMetrics.Builder mergePageRecall(QualityMetrics.TopkMetrics value)
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;public QualityMetrics.Builder clearPageRecall()
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;public QualityMetrics.TopkMetrics.Builder getPageRecallBuilder()
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;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;getPageRecallOrBuilder in interface QualityMetricsOrBuilderpublic 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;hasPageNdcg in interface QualityMetricsOrBuilderpublic 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;getPageNdcg in interface QualityMetricsOrBuilderpublic QualityMetrics.Builder setPageNdcg(QualityMetrics.TopkMetrics value)
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;public QualityMetrics.Builder setPageNdcg(QualityMetrics.TopkMetrics.Builder builderForValue)
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;public QualityMetrics.Builder mergePageNdcg(QualityMetrics.TopkMetrics value)
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;public QualityMetrics.Builder clearPageNdcg()
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;public QualityMetrics.TopkMetrics.Builder getPageNdcgBuilder()
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;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;getPageNdcgOrBuilder in interface QualityMetricsOrBuilderpublic final QualityMetrics.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>public final QualityMetrics.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QualityMetrics.Builder>Copyright © 2025 Google LLC. All rights reserved.