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

Class RankEvalMetricBase

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

Direct Known Subclasses:

RankEvalMetricDiscountedCumulativeGain, RankEvalMetricExpectedReciprocalRank, RankEvalMetricRatingThreshold

@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class RankEvalMetricBase
extends Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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
boolean	equals(Object o)
int	hashCode()
final Integer	k()	Sets the maximum number of documents retrieved per query.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends RankEvalMetricBase.AbstractBuilder<BuilderT>> void	setupRankEvalMetricBaseDeserializer(ObjectDeserializer<BuilderT> op)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Constructor Details

RankEvalMetricBase

protected RankEvalMetricBase(RankEvalMetricBase.AbstractBuilder<?> builder)

Method Details

k

@Nullable
public final Integer k()

Sets the maximum number of documents retrieved per query. This value replaces the size parameter in the query.

API name: k

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

setupRankEvalMetricBaseDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object