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

Class RankEvalMetricRatingTreshold

java.lang.Object

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

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricRatingTreshold

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

RankEvalMetricMeanReciprocalRank, RankEvalMetricPrecision, RankEvalMetricRecall

public abstract class RankEvalMetricRatingTreshold
extends RankEvalMetricBase

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	relevantRatingThreshold()	Sets the rating threshold above which documents are considered to be "relevant".
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends RankEvalMetricRatingTreshold.AbstractBuilder<BuilderT>> void	setupRankEvalMetricRatingTresholdDeserializer(ObjectDeserializer<BuilderT> 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

Constructor Detail

RankEvalMetricRatingTreshold

protected RankEvalMetricRatingTreshold(RankEvalMetricRatingTreshold.AbstractBuilder<?> builder)

Method Detail

relevantRatingThreshold

@Nullable
public final java.lang.Integer relevantRatingThreshold()

Sets the rating threshold above which documents are considered to be "relevant".

API name: relevant_rating_threshold

serializeInternal

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

Overrides:

serializeInternal in class RankEvalMetricBase

setupRankEvalMetricRatingTresholdDeserializer

protected static <BuilderT extends RankEvalMetricRatingTreshold.AbstractBuilder<BuilderT>> void setupRankEvalMetricRatingTresholdDeserializer(ObjectDeserializer<BuilderT> op)