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

Class RankEvalMetricPrecision

java.lang.Object

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

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricRatingThreshold

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricPrecision

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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

RankEvalMetricRatingThreshold.AbstractBuilder<BuilderT extends RankEvalMetricRatingThreshold.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static RankEvalMetricPrecision.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final Boolean	ignoreUnlabeled()	Controls how unlabeled documents in the search results are counted.
static RankEvalMetricPrecision	of(Function<RankEvalMetricPrecision.Builder,ObjectBuilder<RankEvalMetricPrecision>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRankEvalMetricPrecisionDeserializer(ObjectDeserializer<RankEvalMetricPrecision.Builder> op)
RankEvalMetricPrecision.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricRatingThreshold

relevantRatingThreshold, setupRankEvalMetricRatingThresholdDeserializer

Methods inherited from class org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase

k, serialize, setupRankEvalMetricBaseDeserializer

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<RankEvalMetricPrecision> _DESERIALIZER

Json deserializer for RankEvalMetricPrecision

Method Details

of

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

ignoreUnlabeled

@Nullable
public final Boolean ignoreUnlabeled()

Controls how unlabeled documents in the search results are counted. When true, unlabeled documents are ignored and are not treated as relevant or irrelevant. When false, unlabeled documents are treated as irrelevant.

API name: ignore_unlabeled

serializeInternal

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

Overrides:

serializeInternal in class RankEvalMetricRatingThreshold

toBuilder

@Nonnull
public RankEvalMetricPrecision.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<RankEvalMetricPrecision.Builder,RankEvalMetricPrecision>

Returns:

a new builder instance.

builder

@Nonnull
public static RankEvalMetricPrecision.Builder builder()

setupRankEvalMetricPrecisionDeserializer

protected static void setupRankEvalMetricPrecisionDeserializer(ObjectDeserializer<RankEvalMetricPrecision.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class RankEvalMetricRatingThreshold

equals

public boolean equals(Object o)

Overrides:

equals in class RankEvalMetricRatingThreshold