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

Class RankEvalMetricBase

java.lang.Object

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

All Implemented Interfaces:

ToJsonp

Direct Known Subclasses:

RankEvalMetricDiscountedCumulativeGain, RankEvalMetricExpectedReciprocalRank, RankEvalMetricRatingTreshold

public abstract class RankEvalMetricBase
extends java.lang.Object
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	RankEvalMetricBase.AbstractBuilder<BuilderT extends RankEvalMetricBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RankEvalMetricBase(RankEvalMetricBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Number	k()	Sets the maximum number of documents retrieved per query.
protected static <BuilderT extends RankEvalMetricBase.AbstractBuilder<BuilderT>> void	setupRankEvalMetricBaseDeserializer(DelegatingDeserializer<BuilderT> op)
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class java.lang.Object

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

Constructor Details

RankEvalMetricBase

protected RankEvalMetricBase(RankEvalMetricBase.AbstractBuilder<?> builder)

Method Details

k

@Nullable public java.lang.Number k()

Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. API name: k

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

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

setupRankEvalMetricBaseDeserializer

protected static <BuilderT extends RankEvalMetricBase.AbstractBuilder<BuilderT>> void setupRankEvalMetricBaseDeserializer(DelegatingDeserializer<BuilderT> op)