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

Class RankEvalMetricDetail.Builder

java.lang.Object

org.opensearch.client.opensearch._global.rank_eval.RankEvalMetricDetail.Builder

All Implemented Interfaces:

ObjectBuilder<RankEvalMetricDetail>

Enclosing class:

RankEvalMetricDetail

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

Builder for RankEvalMetricDetail.

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
RankEvalMetricDetail.Builder	addHits(java.util.function.Function<RankEvalHitItem.Builder,ObjectBuilder<RankEvalHitItem>> fn)	Add a value to hits(List), creating the list if needed.
RankEvalMetricDetail.Builder	addHits(RankEvalHitItem value)	Add a value to hits(List), creating the list if needed.
RankEvalMetricDetail.Builder	addUnratedDocs(java.util.function.Function<UnratedDocument.Builder,ObjectBuilder<UnratedDocument>> fn)	Add a value to unratedDocs(List), creating the list if needed.
RankEvalMetricDetail.Builder	addUnratedDocs(UnratedDocument value)	Add a value to unratedDocs(List), creating the list if needed.
RankEvalMetricDetail	build()	Builds a RankEvalMetricDetail.
RankEvalMetricDetail.Builder	hits(java.util.function.Function<RankEvalHitItem.Builder,ObjectBuilder<RankEvalHitItem>> fn)	Set hits(List) to a singleton list.
RankEvalMetricDetail.Builder	hits(java.util.List<RankEvalHitItem> value)	The hits section shows a grouping of the search results with their supplied ratings API name: hits
RankEvalMetricDetail.Builder	hits(RankEvalHitItem... value)	The hits section shows a grouping of the search results with their supplied ratings API name: hits
RankEvalMetricDetail.Builder	metricDetails(java.util.Map<java.lang.String,java.util.Map<java.lang.String,jakarta.json.JsonValue>> value)	The metric_details give additional information about the calculated quality metric (e.g.
RankEvalMetricDetail.Builder	metricScore(java.lang.Number value)	The metric_score in the details section shows the contribution of this query to the global quality metric score API name: metric_score
RankEvalMetricDetail.Builder	putMetricDetails(java.lang.String key, java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	Add a key/value to metricDetails(Map), creating the map if needed.
RankEvalMetricDetail.Builder	unratedDocs(java.util.function.Function<UnratedDocument.Builder,ObjectBuilder<UnratedDocument>> fn)	Set unratedDocs(List) to a singleton list.
RankEvalMetricDetail.Builder	unratedDocs(java.util.List<UnratedDocument> value)	The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn't have a ratings value.
RankEvalMetricDetail.Builder	unratedDocs(UnratedDocument... value)	The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn't have a ratings value.

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 RankEvalMetricDetail.Builder metricScore(java.lang.Number value)

The metric_score in the details section shows the contribution of this query to the global quality metric score API name: metric_score

unratedDocs

public RankEvalMetricDetail.Builder unratedDocs(java.util.List<UnratedDocument> value)

The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn't have a ratings value. This can be used to ask the user to supply ratings for these documents API name: unrated_docs

unratedDocs

public RankEvalMetricDetail.Builder unratedDocs(UnratedDocument... value)

The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn't have a ratings value. This can be used to ask the user to supply ratings for these documents API name: unrated_docs

addUnratedDocs

public RankEvalMetricDetail.Builder addUnratedDocs(UnratedDocument value)

Add a value to unratedDocs(List), creating the list if needed.

unratedDocs

public RankEvalMetricDetail.Builder unratedDocs(java.util.function.Function<UnratedDocument.Builder,ObjectBuilder<UnratedDocument>> fn)

Set unratedDocs(List) to a singleton list.

addUnratedDocs

public RankEvalMetricDetail.Builder addUnratedDocs(java.util.function.Function<UnratedDocument.Builder,ObjectBuilder<UnratedDocument>> fn)

Add a value to unratedDocs(List), creating the list if needed.

hits

public RankEvalMetricDetail.Builder hits(java.util.List<RankEvalHitItem> value)

The hits section shows a grouping of the search results with their supplied ratings API name: hits

hits

public RankEvalMetricDetail.Builder hits(RankEvalHitItem... value)

The hits section shows a grouping of the search results with their supplied ratings API name: hits

addHits

public RankEvalMetricDetail.Builder addHits(RankEvalHitItem value)

Add a value to hits(List), creating the list if needed.

hits

public RankEvalMetricDetail.Builder hits(java.util.function.Function<RankEvalHitItem.Builder,ObjectBuilder<RankEvalHitItem>> fn)

Set hits(List) to a singleton list.

addHits

public RankEvalMetricDetail.Builder addHits(java.util.function.Function<RankEvalHitItem.Builder,ObjectBuilder<RankEvalHitItem>> fn)

Add a value to hits(List), creating the list if needed.

metricDetails

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

The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results API name: metric_details

putMetricDetails

public RankEvalMetricDetail.Builder putMetricDetails(java.lang.String key, java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

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

build

public RankEvalMetricDetail build()

Builds a RankEvalMetricDetail.

Specified by:

build in interface ObjectBuilder<RankEvalMetricDetail>

Throws:

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