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

Class RankEvalMetric.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

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

Enclosing class:

RankEvalMetric

public static class RankEvalMetric.Builder
extends ObjectBuilderBase
implements CopyableBuilder<RankEvalMetric.Builder,RankEvalMetric>

Builder for RankEvalMetric.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalMetric	build()	Builds a RankEvalMetric.
RankEvalMetric.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankEvalMetric.Builder	dcg(Function<RankEvalMetricDiscountedCumulativeGain.Builder,ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>> fn)	API name: dcg
final RankEvalMetric.Builder	dcg(RankEvalMetricDiscountedCumulativeGain value)	API name: dcg
final RankEvalMetric.Builder	expectedReciprocalRank(Function<RankEvalMetricExpectedReciprocalRank.Builder,ObjectBuilder<RankEvalMetricExpectedReciprocalRank>> fn)	API name: expected_reciprocal_rank
final RankEvalMetric.Builder	expectedReciprocalRank(RankEvalMetricExpectedReciprocalRank value)	API name: expected_reciprocal_rank
final RankEvalMetric.Builder	meanReciprocalRank(Function<RankEvalMetricMeanReciprocalRank.Builder,ObjectBuilder<RankEvalMetricMeanReciprocalRank>> fn)	API name: mean_reciprocal_rank
final RankEvalMetric.Builder	meanReciprocalRank(RankEvalMetricMeanReciprocalRank value)	API name: mean_reciprocal_rank
final RankEvalMetric.Builder	precision(Function<RankEvalMetricPrecision.Builder,ObjectBuilder<RankEvalMetricPrecision>> fn)	API name: precision
final RankEvalMetric.Builder	precision(RankEvalMetricPrecision value)	API name: precision
final RankEvalMetric.Builder	recall(Function<RankEvalMetricRecall.Builder,ObjectBuilder<RankEvalMetricRecall>> fn)	API name: recall
final RankEvalMetric.Builder	recall(RankEvalMetricRecall value)	API name: recall

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 RankEvalMetric.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<RankEvalMetric.Builder,RankEvalMetric>

Returns:

a new builder instance.

dcg

@Nonnull
public final RankEvalMetric.Builder dcg(@Nullable
 RankEvalMetricDiscountedCumulativeGain value)

API name: dcg

dcg

@Nonnull
public final RankEvalMetric.Builder dcg(Function<RankEvalMetricDiscountedCumulativeGain.Builder,ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>> fn)

API name: dcg

expectedReciprocalRank

@Nonnull
public final RankEvalMetric.Builder expectedReciprocalRank(@Nullable
 RankEvalMetricExpectedReciprocalRank value)

API name: expected_reciprocal_rank

expectedReciprocalRank

@Nonnull
public final RankEvalMetric.Builder expectedReciprocalRank(Function<RankEvalMetricExpectedReciprocalRank.Builder,ObjectBuilder<RankEvalMetricExpectedReciprocalRank>> fn)

API name: expected_reciprocal_rank

meanReciprocalRank

@Nonnull
public final RankEvalMetric.Builder meanReciprocalRank(@Nullable
 RankEvalMetricMeanReciprocalRank value)

API name: mean_reciprocal_rank

meanReciprocalRank

@Nonnull
public final RankEvalMetric.Builder meanReciprocalRank(Function<RankEvalMetricMeanReciprocalRank.Builder,ObjectBuilder<RankEvalMetricMeanReciprocalRank>> fn)

API name: mean_reciprocal_rank

precision

@Nonnull
public final RankEvalMetric.Builder precision(@Nullable
 RankEvalMetricPrecision value)

API name: precision

precision

@Nonnull
public final RankEvalMetric.Builder precision(Function<RankEvalMetricPrecision.Builder,ObjectBuilder<RankEvalMetricPrecision>> fn)

API name: precision

recall

@Nonnull
public final RankEvalMetric.Builder recall(@Nullable
 RankEvalMetricRecall value)

API name: recall

recall

@Nonnull
public final RankEvalMetric.Builder recall(Function<RankEvalMetricRecall.Builder,ObjectBuilder<RankEvalMetricRecall>> fn)

API name: recall

build

@Nonnull
public RankEvalMetric build()

Builds a RankEvalMetric.

Specified by:

build in interface ObjectBuilder<RankEvalMetric>

Throws:

NullPointerException - if some of the required fields are null.