Package co.elastic.clients.elasticsearch.core.rank_eval

Class RankEvalMetricBase

java.lang.Object

co.elastic.clients.elasticsearch.core.rank_eval.RankEvalMetricBase

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

RankEvalMetricDiscountedCumulativeGain, RankEvalMetricExpectedReciprocalRank, RankEvalMetricRatingTreshold

public abstract class RankEvalMetricBase
extends Object
implements JsonpSerializable

See Also:

• API specification

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
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)
String	toString()

Methods inherited from class java.lang.Object

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

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 will act in place of the usual 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)

toString

public String toString()

Overrides:

toString in class Object

setupRankEvalMetricBaseDeserializer

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