public final class QualityMetrics extends com.google.protobuf.GeneratedMessageV3 implements QualityMetricsOrBuilder
Describes the metrics produced by the evaluation.Protobuf type
google.cloud.discoveryengine.v1alpha.QualityMetrics| Modifier and Type | Class and Description |
|---|---|
static class |
QualityMetrics.Builder
Describes the metrics produced by the evaluation.
|
static class |
QualityMetrics.TopkMetrics
Stores the metric values at specific top-k levels.
|
static interface |
QualityMetrics.TopkMetricsOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
DOC_NDCG_FIELD_NUMBER |
static int |
DOC_PRECISION_FIELD_NUMBER |
static int |
DOC_RECALL_FIELD_NUMBER |
static int |
PAGE_NDCG_FIELD_NUMBER |
static int |
PAGE_RECALL_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static QualityMetrics |
getDefaultInstance() |
QualityMetrics |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
QualityMetrics.TopkMetrics |
getDocNdcg()
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.TopkMetricsOrBuilder |
getDocPrecisionOrBuilder()
Precision per document, at various top-k cutoff levels.
|
QualityMetrics.TopkMetrics |
getDocRecall()
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.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.TopkMetricsOrBuilder |
getPageRecallOrBuilder()
Recall per page, at various top-k cutoff levels.
|
com.google.protobuf.Parser<QualityMetrics> |
getParserForType() |
int |
getSerializedSize() |
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.
|
int |
hashCode() |
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() |
static QualityMetrics.Builder |
newBuilder() |
static QualityMetrics.Builder |
newBuilder(QualityMetrics prototype) |
QualityMetrics.Builder |
newBuilderForType() |
protected QualityMetrics.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static QualityMetrics |
parseDelimitedFrom(InputStream input) |
static QualityMetrics |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QualityMetrics |
parseFrom(byte[] data) |
static QualityMetrics |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QualityMetrics |
parseFrom(ByteBuffer data) |
static QualityMetrics |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QualityMetrics |
parseFrom(com.google.protobuf.ByteString data) |
static QualityMetrics |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QualityMetrics |
parseFrom(com.google.protobuf.CodedInputStream input) |
static QualityMetrics |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QualityMetrics |
parseFrom(InputStream input) |
static QualityMetrics |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<QualityMetrics> |
parser() |
QualityMetrics.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int DOC_RECALL_FIELD_NUMBER
public static final int DOC_PRECISION_FIELD_NUMBER
public static final int DOC_NDCG_FIELD_NUMBER
public static final int PAGE_RECALL_FIELD_NUMBER
public static final int PAGE_NDCG_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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.v1alpha.SampleQuery], If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
.google.cloud.discoveryengine.v1alpha.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.v1alpha.SampleQuery], If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
.google.cloud.discoveryengine.v1alpha.QualityMetrics.TopkMetrics doc_recall = 1;getDocRecall in interface QualityMetricsOrBuilderpublic 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.v1alpha.SampleQuery], If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
.google.cloud.discoveryengine.v1alpha.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.v1alpha.SampleQuery], If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
.google.cloud.discoveryengine.v1alpha.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.v1alpha.SampleQuery], If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
.google.cloud.discoveryengine.v1alpha.QualityMetrics.TopkMetrics doc_precision = 2;
getDocPrecision in interface QualityMetricsOrBuilderpublic 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.v1alpha.SampleQuery], If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
.google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.QualityMetrics.TopkMetrics doc_ndcg = 3;getDocNdcg in interface QualityMetricsOrBuilderpublic 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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.SampleQuery], if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
.google.cloud.discoveryengine.v1alpha.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.v1alpha.SampleQuery], if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
.google.cloud.discoveryengine.v1alpha.QualityMetrics.TopkMetrics page_recall = 4;getPageRecall in interface QualityMetricsOrBuilderpublic 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.v1alpha.SampleQuery], if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
.google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.QualityMetrics.TopkMetrics page_ndcg = 5;getPageNdcg in interface QualityMetricsOrBuilderpublic 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.v1alpha.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.v1alpha.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.v1alpha.QualityMetrics.TopkMetrics page_ndcg = 5;getPageNdcgOrBuilder in interface QualityMetricsOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static QualityMetrics parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QualityMetrics parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QualityMetrics parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QualityMetrics parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QualityMetrics parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QualityMetrics parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QualityMetrics parseFrom(InputStream input) throws IOException
IOExceptionpublic static QualityMetrics parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static QualityMetrics parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static QualityMetrics parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static QualityMetrics parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static QualityMetrics parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic QualityMetrics.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static QualityMetrics.Builder newBuilder()
public static QualityMetrics.Builder newBuilder(QualityMetrics prototype)
public QualityMetrics.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected QualityMetrics.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static QualityMetrics getDefaultInstance()
public static com.google.protobuf.Parser<QualityMetrics> parser()
public com.google.protobuf.Parser<QualityMetrics> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public QualityMetrics getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.