Package org.opensearch.client.opensearch.core.rank_eval

Class RankEvalMetricDiscountedCumulativeGain

java.lang.Object

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricDiscountedCumulativeGain

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class RankEvalMetricDiscountedCumulativeGain
extends RankEvalMetricBase

Discounted cumulative gain (DCG)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RankEvalMetricDiscountedCumulativeGain.Builder	Builder for RankEvalMetricDiscountedCumulativeGain.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase

RankEvalMetricBase.AbstractBuilder<BuilderT extends RankEvalMetricBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<RankEvalMetricDiscountedCumulativeGain>	_DESERIALIZER	Json deserializer for RankEvalMetricDiscountedCumulativeGain

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	normalize()	If set to true, this metric will calculate the Normalized DCG.
static RankEvalMetricDiscountedCumulativeGain	of(java.util.function.Function<RankEvalMetricDiscountedCumulativeGain.Builder,ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRankEvalMetricDiscountedCumulativeGainDeserializer(ObjectDeserializer<RankEvalMetricDiscountedCumulativeGain.Builder> op)

Methods inherited from class org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase

k, serialize, setupRankEvalMetricBaseDeserializer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<RankEvalMetricDiscountedCumulativeGain> _DESERIALIZER

Json deserializer for RankEvalMetricDiscountedCumulativeGain

Method Detail

of

public static RankEvalMetricDiscountedCumulativeGain of(java.util.function.Function<RankEvalMetricDiscountedCumulativeGain.Builder,ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>> fn)

normalize

@Nullable
public final java.lang.Boolean normalize()

If set to true, this metric will calculate the Normalized DCG.

API name: normalize

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

Overrides:

serializeInternal in class RankEvalMetricBase

setupRankEvalMetricDiscountedCumulativeGainDeserializer

protected static void setupRankEvalMetricDiscountedCumulativeGainDeserializer(ObjectDeserializer<RankEvalMetricDiscountedCumulativeGain.Builder> op)