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

Class RankEvalMetric

java.lang.Object

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetric

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<RankEvalMetric.Builder,RankEvalMetric>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RankEvalMetric
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<RankEvalMetric.Builder,RankEvalMetric>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static RankEvalMetric.Builder	builder()
final RankEvalMetricDiscountedCumulativeGain	dcg()	API name: dcg
boolean	equals(Object o)
final RankEvalMetricExpectedReciprocalRank	expectedReciprocalRank()	API name: expected_reciprocal_rank
int	hashCode()
final RankEvalMetricMeanReciprocalRank	meanReciprocalRank()	API name: mean_reciprocal_rank
static RankEvalMetric	of(Function<RankEvalMetric.Builder,ObjectBuilder<RankEvalMetric>> fn)
final RankEvalMetricPrecision	precision()	API name: precision
final RankEvalMetricRecall	recall()	API name: recall
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 void	setupRankEvalMetricDeserializer(ObjectDeserializer<RankEvalMetric.Builder> op)
RankEvalMetric.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RankEvalMetric> _DESERIALIZER

Json deserializer for RankEvalMetric

Method Details

of

public static RankEvalMetric of(Function<RankEvalMetric.Builder,ObjectBuilder<RankEvalMetric>> fn)

dcg

@Nullable
public final RankEvalMetricDiscountedCumulativeGain dcg()

API name: dcg

expectedReciprocalRank

@Nullable
public final RankEvalMetricExpectedReciprocalRank expectedReciprocalRank()

API name: expected_reciprocal_rank

meanReciprocalRank

@Nullable
public final RankEvalMetricMeanReciprocalRank meanReciprocalRank()

API name: mean_reciprocal_rank

precision

@Nullable
public final RankEvalMetricPrecision precision()

API name: precision

recall

@Nullable
public final RankEvalMetricRecall recall()

API name: recall

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)

toBuilder

@Nonnull
public RankEvalMetric.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RankEvalMetric.Builder,RankEvalMetric>

Returns:

a new builder instance.

builder

@Nonnull
public static RankEvalMetric.Builder builder()

setupRankEvalMetricDeserializer

protected static void setupRankEvalMetricDeserializer(ObjectDeserializer<RankEvalMetric.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object