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.RankEvalMetricRatingTreshold

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

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class RankEvalMetricPrecision
extends RankEvalMetricRatingTreshold

Precision at K (P@k)

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.RankEvalMetricRatingTreshold

RankEvalMetricRatingTreshold.AbstractBuilder<BuilderT extends RankEvalMetricRatingTreshold.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	ignoreUnlabeled()	Controls how unlabeled documents in the search results are counted.
static RankEvalMetricPrecision	of(java.util.function.Function<RankEvalMetricPrecision.Builder,ObjectBuilder<RankEvalMetricPrecision>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRankEvalMetricPrecisionDeserializer(ObjectDeserializer<RankEvalMetricPrecision.Builder> op)

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

relevantRatingThreshold, setupRankEvalMetricRatingTresholdDeserializer

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

Json deserializer for RankEvalMetricPrecision

Method Detail

of

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

ignoreUnlabeled

@Nullable
public final java.lang.Boolean ignoreUnlabeled()

Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant.

API name: ignore_unlabeled

serializeInternal

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

Overrides:

serializeInternal in class RankEvalMetricRatingTreshold

setupRankEvalMetricPrecisionDeserializer

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