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

Class RankEvalMetricPrecision.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase.AbstractBuilder<BuilderT>

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricRatingTreshold.AbstractBuilder<RankEvalMetricPrecision.Builder>

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

All Implemented Interfaces:

ObjectBuilder<RankEvalMetricPrecision>

Enclosing class:

RankEvalMetricPrecision

public static class RankEvalMetricPrecision.Builder
extends RankEvalMetricRatingTreshold.AbstractBuilder<RankEvalMetricPrecision.Builder>
implements ObjectBuilder<RankEvalMetricPrecision>

Builder for RankEvalMetricPrecision.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalMetricPrecision	build()	Builds a RankEvalMetricPrecision.
RankEvalMetricPrecision.Builder	ignoreUnlabeled(java.lang.Boolean value)	Controls how unlabeled documents in the search results are counted.
protected RankEvalMetricPrecision.Builder	self()

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

relevantRatingThreshold

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

k

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

ignoreUnlabeled

public final RankEvalMetricPrecision.Builder ignoreUnlabeled(@Nullable
                                                             java.lang.Boolean value)

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

self

protected RankEvalMetricPrecision.Builder self()

Specified by:

self in class RankEvalMetricBase.AbstractBuilder<RankEvalMetricPrecision.Builder>

build

public RankEvalMetricPrecision build()

Builds a RankEvalMetricPrecision.

Specified by:

build in interface ObjectBuilder<RankEvalMetricPrecision>

Throws:

java.lang.NullPointerException - if some of the required fields are null.