Package org.opensearch.client.opensearch._global.rank_eval

Class RankEvalMetricDiscountedCumulativeGain

java.lang.Object

org.opensearch.client.opensearch._global.rank_eval.RankEvalMetricBase

org.opensearch.client.opensearch._global.rank_eval.RankEvalMetricDiscountedCumulativeGain

All Implemented Interfaces:

ToJsonp

public final class RankEvalMetricDiscountedCumulativeGain
extends RankEvalMetricBase

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._global.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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RankEvalMetricDiscountedCumulativeGain(RankEvalMetricDiscountedCumulativeGain.Builder builder)

Method Summary

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

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

k, setupRankEvalMetricBaseDeserializer, toJsonp

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<RankEvalMetricDiscountedCumulativeGain> DESERIALIZER

Json deserializer for RankEvalMetricDiscountedCumulativeGain

Constructor Details

RankEvalMetricDiscountedCumulativeGain

protected RankEvalMetricDiscountedCumulativeGain(RankEvalMetricDiscountedCumulativeGain.Builder builder)

Method Details

normalize

@Nullable public java.lang.Boolean normalize()

If set to true, this metric will calculate the Normalized DCG. API name: normalize

toJsonpInternal

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

Overrides:

toJsonpInternal in class RankEvalMetricBase

setupRankEvalMetricDiscountedCumulativeGainDeserializer

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