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:

ObjectBuilder<RankEvalMetric>

Enclosing class:

RankEvalMetric

public static class RankEvalMetric.Builder
extends ObjectBuilderBase
implements ObjectBuilder<RankEvalMetric>

Builder for RankEvalMetric.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalMetric	build()	Builds a RankEvalMetric.
RankEvalMetric.Builder	dcg(java.util.function.Function<RankEvalMetricDiscountedCumulativeGain.Builder,ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>> fn)	API name: dcg
RankEvalMetric.Builder	dcg(RankEvalMetricDiscountedCumulativeGain value)	API name: dcg
RankEvalMetric.Builder	expectedReciprocalRank(java.util.function.Function<RankEvalMetricExpectedReciprocalRank.Builder,ObjectBuilder<RankEvalMetricExpectedReciprocalRank>> fn)	API name: expected_reciprocal_rank
RankEvalMetric.Builder	expectedReciprocalRank(RankEvalMetricExpectedReciprocalRank value)	API name: expected_reciprocal_rank
RankEvalMetric.Builder	meanReciprocalRank(java.util.function.Function<RankEvalMetricMeanReciprocalRank.Builder,ObjectBuilder<RankEvalMetricMeanReciprocalRank>> fn)	API name: mean_reciprocal_rank
RankEvalMetric.Builder	meanReciprocalRank(RankEvalMetricMeanReciprocalRank value)	API name: mean_reciprocal_rank
RankEvalMetric.Builder	precision(java.util.function.Function<RankEvalMetricPrecision.Builder,ObjectBuilder<RankEvalMetricPrecision>> fn)	API name: precision
RankEvalMetric.Builder	precision(RankEvalMetricPrecision value)	API name: precision
RankEvalMetric.Builder	recall(java.util.function.Function<RankEvalMetricRecall.Builder,ObjectBuilder<RankEvalMetricRecall>> fn)	API name: recall
RankEvalMetric.Builder	recall(RankEvalMetricRecall value)	API name: recall

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

precision

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

API name: precision

precision

public final RankEvalMetric.Builder precision(java.util.function.Function<RankEvalMetricPrecision.Builder,ObjectBuilder<RankEvalMetricPrecision>> fn)

API name: precision

recall

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

API name: recall

recall

public final RankEvalMetric.Builder recall(java.util.function.Function<RankEvalMetricRecall.Builder,ObjectBuilder<RankEvalMetricRecall>> fn)

API name: recall

meanReciprocalRank

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

API name: mean_reciprocal_rank

meanReciprocalRank

public final RankEvalMetric.Builder meanReciprocalRank(java.util.function.Function<RankEvalMetricMeanReciprocalRank.Builder,ObjectBuilder<RankEvalMetricMeanReciprocalRank>> fn)

API name: mean_reciprocal_rank

dcg

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

API name: dcg

dcg

public final RankEvalMetric.Builder dcg(java.util.function.Function<RankEvalMetricDiscountedCumulativeGain.Builder,ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>> fn)

API name: dcg

expectedReciprocalRank

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

API name: expected_reciprocal_rank

expectedReciprocalRank

public final RankEvalMetric.Builder expectedReciprocalRank(java.util.function.Function<RankEvalMetricExpectedReciprocalRank.Builder,ObjectBuilder<RankEvalMetricExpectedReciprocalRank>> fn)

API name: expected_reciprocal_rank

build

public RankEvalMetric build()

Builds a RankEvalMetric.

Specified by:

build in interface ObjectBuilder<RankEvalMetric>

Throws:

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