Package org.opensearch.client.opensearch._global

Class RankEvalResponse.Builder

java.lang.Object

org.opensearch.client.opensearch._global.RankEvalResponse.Builder

All Implemented Interfaces:

ObjectBuilder<RankEvalResponse>

Enclosing class:

RankEvalResponse

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

Builder for RankEvalResponse.

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
RankEvalResponse	build()	Builds a RankEvalResponse.
RankEvalResponse.Builder	details(java.lang.String key, java.util.function.Function<RankEvalMetricDetail.Builder,ObjectBuilder<RankEvalMetricDetail>> fn)	Set details(Map) to a singleton map.
RankEvalResponse.Builder	details(java.util.Map<java.lang.String,RankEvalMetricDetail> value)	The details section contains one entry for every query in the original requests section, keyed by the search request id API name: details
RankEvalResponse.Builder	failures(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: failures
RankEvalResponse.Builder	metricScore(java.lang.Number value)	The overall evaluation quality calculated by the defined metric API name: metric_score
RankEvalResponse.Builder	putDetails(java.lang.String key, java.util.function.Function<RankEvalMetricDetail.Builder,ObjectBuilder<RankEvalMetricDetail>> fn)	Add a key/value to details(Map), creating the map if needed.
RankEvalResponse.Builder	putDetails(java.lang.String key, RankEvalMetricDetail value)	Add a key/value to details(Map), creating the map if needed.
RankEvalResponse.Builder	putFailures(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to failures(Map), creating the map if needed.

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

metricScore

public RankEvalResponse.Builder metricScore(java.lang.Number value)

The overall evaluation quality calculated by the defined metric API name: metric_score

details

public RankEvalResponse.Builder details(java.util.Map<java.lang.String,RankEvalMetricDetail> value)

The details section contains one entry for every query in the original requests section, keyed by the search request id API name: details

putDetails

public RankEvalResponse.Builder putDetails(java.lang.String key, RankEvalMetricDetail value)

Add a key/value to details(Map), creating the map if needed.

details

public RankEvalResponse.Builder details(java.lang.String key, java.util.function.Function<RankEvalMetricDetail.Builder,ObjectBuilder<RankEvalMetricDetail>> fn)

Set details(Map) to a singleton map.

putDetails

public RankEvalResponse.Builder putDetails(java.lang.String key, java.util.function.Function<RankEvalMetricDetail.Builder,ObjectBuilder<RankEvalMetricDetail>> fn)

Add a key/value to details(Map), creating the map if needed.

failures

public RankEvalResponse.Builder failures(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

API name: failures

putFailures

public RankEvalResponse.Builder putFailures(java.lang.String key, jakarta.json.JsonValue value)

Add a key/value to failures(Map), creating the map if needed.

build

public RankEvalResponse build()

Builds a RankEvalResponse.

Specified by:

build in interface ObjectBuilder<RankEvalResponse>

Throws:

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