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

Class RankEvalMetricExpectedReciprocalRank

java.lang.Object

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

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricExpectedReciprocalRank

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class RankEvalMetricExpectedReciprocalRank
extends RankEvalMetricBase

Expected Reciprocal Rank (ERR)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RankEvalMetricExpectedReciprocalRank.Builder	Builder for RankEvalMetricExpectedReciprocalRank.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase

RankEvalMetricBase.AbstractBuilder<BuilderT extends RankEvalMetricBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<RankEvalMetricExpectedReciprocalRank>	_DESERIALIZER	Json deserializer for RankEvalMetricExpectedReciprocalRank

Method Summary

Modifier and Type	Method	Description
int	maximumRelevance()	Required - The highest relevance grade used in the user-supplied relevance judgments.
static RankEvalMetricExpectedReciprocalRank	of(java.util.function.Function<RankEvalMetricExpectedReciprocalRank.Builder,ObjectBuilder<RankEvalMetricExpectedReciprocalRank>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRankEvalMetricExpectedReciprocalRankDeserializer(ObjectDeserializer<RankEvalMetricExpectedReciprocalRank.Builder> 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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<RankEvalMetricExpectedReciprocalRank> _DESERIALIZER

Json deserializer for RankEvalMetricExpectedReciprocalRank

Method Detail

of

public static RankEvalMetricExpectedReciprocalRank of(java.util.function.Function<RankEvalMetricExpectedReciprocalRank.Builder,ObjectBuilder<RankEvalMetricExpectedReciprocalRank>> fn)

maximumRelevance

public final int maximumRelevance()

Required - The highest relevance grade used in the user-supplied relevance judgments.

API name: maximum_relevance

serializeInternal

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

Overrides:

serializeInternal in class RankEvalMetricBase

setupRankEvalMetricExpectedReciprocalRankDeserializer

protected static void setupRankEvalMetricExpectedReciprocalRankDeserializer(ObjectDeserializer<RankEvalMetricExpectedReciprocalRank.Builder> op)