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<RankEvalMetricPrecision.Builder>

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

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

All Implemented Interfaces:

CopyableBuilder<RankEvalMetricPrecision.Builder,RankEvalMetricPrecision>, MutableBuilder<RankEvalMetricPrecision.Builder,RankEvalMetricPrecision>, ObjectBuilder<RankEvalMetricPrecision>

Enclosing class:

RankEvalMetricPrecision

public static class RankEvalMetricPrecision.Builder
extends RankEvalMetricRatingThreshold.AbstractBuilder<RankEvalMetricPrecision.Builder>
implements CopyableBuilder<RankEvalMetricPrecision.Builder,RankEvalMetricPrecision>

Builder for RankEvalMetricPrecision.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalMetricPrecision	build()	Builds a RankEvalMetricPrecision.
RankEvalMetricPrecision.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankEvalMetricPrecision.Builder	ignoreUnlabeled(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.RankEvalMetricRatingThreshold.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, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public RankEvalMetricPrecision.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<RankEvalMetricPrecision.Builder,RankEvalMetricPrecision>

Returns:

a new builder instance.

self

@Nonnull
protected RankEvalMetricPrecision.Builder self()

Specified by:

self in class RankEvalMetricBase.AbstractBuilder<RankEvalMetricPrecision.Builder>

ignoreUnlabeled

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

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

build

@Nonnull
public RankEvalMetricPrecision build()

Builds a RankEvalMetricPrecision.

Specified by:

build in interface ObjectBuilder<RankEvalMetricPrecision>

Throws:

NullPointerException - if some of the required fields are null.