Package org.opensearch.client.opensearch._global.rank_eval

Class RankEvalMetric.Builder

java.lang.Object

org.opensearch.client.opensearch._global.rank_eval.RankEvalMetric.Builder

All Implemented Interfaces:

ObjectBuilder<RankEvalMetric>

Enclosing class:

RankEvalMetric

public static class RankEvalMetric.Builder
extends java.lang.Object
implements ObjectBuilder<RankEvalMetric>

Builder for RankEvalMetric.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

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(jakarta.json.JsonValue 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(jakarta.json.JsonValue value)	API name: recall

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

precision

public RankEvalMetric.Builder precision(@Nullable RankEvalMetricPrecision value)

API name: precision

precision

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

API name: precision

recall

public RankEvalMetric.Builder recall(@Nullable jakarta.json.JsonValue value)

API name: recall

meanReciprocalRank

public RankEvalMetric.Builder meanReciprocalRank(@Nullable jakarta.json.JsonValue value)

API name: mean_reciprocal_rank

dcg

public RankEvalMetric.Builder dcg(@Nullable RankEvalMetricDiscountedCumulativeGain value)

API name: dcg

dcg

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

API name: dcg

expectedReciprocalRank

public RankEvalMetric.Builder expectedReciprocalRank(@Nullable RankEvalMetricExpectedReciprocalRank value)

API name: expected_reciprocal_rank

expectedReciprocalRank

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