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

Class RankEvalMetricDetail.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricDetail.Builder

All Implemented Interfaces:

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

Enclosing class:

RankEvalMetricDetail

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

Builder for RankEvalMetricDetail.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalMetricDetail	build()	Builds a RankEvalMetricDetail.
RankEvalMetricDetail.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankEvalMetricDetail.Builder	hits(Function<RankEvalHitItem.Builder,ObjectBuilder<RankEvalHitItem>> fn)	Required - The hits section provides a grouping of the search results with their supplied ratings.
final RankEvalMetricDetail.Builder	hits(List<RankEvalHitItem> list)	Required - The hits section provides a grouping of the search results with their supplied ratings.
final RankEvalMetricDetail.Builder	hits(RankEvalHitItem value, RankEvalHitItem... values)	Required - The hits section provides a grouping of the search results with their supplied ratings.
final RankEvalMetricDetail.Builder	metricDetails(String key, Map<String,JsonData> value)	Required - The metric_details section provides additional information about the calculated quality metric indicating the number of relevant retrieved documents.
final RankEvalMetricDetail.Builder	metricDetails(Map<String,Map<String,JsonData>> map)	Required - The metric_details section provides additional information about the calculated quality metric indicating the number of relevant retrieved documents.
final RankEvalMetricDetail.Builder	metricScore(double value)	Required - The metric_score, found in the metric_details section, shows the contribution of this query to the global quality metric score.
final RankEvalMetricDetail.Builder	unratedDocs(Function<UnratedDocument.Builder,ObjectBuilder<UnratedDocument>> fn)	Required - The unrated_docs section contains an _index and _id entry for each document that didn't have a ratings value.
final RankEvalMetricDetail.Builder	unratedDocs(List<UnratedDocument> list)	Required - The unrated_docs section contains an _index and _id entry for each document that didn't have a ratings value.
final RankEvalMetricDetail.Builder	unratedDocs(UnratedDocument value, UnratedDocument... values)	Required - The unrated_docs section contains an _index and _id entry for each document that didn't have a ratings value.

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

Returns:

a new builder instance.

hits

@Nonnull
public final RankEvalMetricDetail.Builder hits(List<RankEvalHitItem> list)

Required - The hits section provides a grouping of the search results with their supplied ratings.

API name: hits

Adds all elements of list to hits.

hits

@Nonnull
public final RankEvalMetricDetail.Builder hits(RankEvalHitItem value,
 RankEvalHitItem... values)

Required - The hits section provides a grouping of the search results with their supplied ratings.

API name: hits

Adds one or more values to hits.

hits

@Nonnull
public final RankEvalMetricDetail.Builder hits(Function<RankEvalHitItem.Builder,ObjectBuilder<RankEvalHitItem>> fn)

Required - The hits section provides a grouping of the search results with their supplied ratings.

API name: hits

Adds a value to hits using a builder lambda.

metricDetails

@Nonnull
public final RankEvalMetricDetail.Builder metricDetails(Map<String,Map<String,JsonData>> map)

Required - The metric_details section provides additional information about the calculated quality metric indicating the number of relevant retrieved documents. The content varies for each metric but allows for better interpretation of the results.

API name: metric_details

Adds all elements of map to metricDetails.

metricDetails

@Nonnull
public final RankEvalMetricDetail.Builder metricDetails(String key,
 Map<String,JsonData> value)

Required - The metric_details section provides additional information about the calculated quality metric indicating the number of relevant retrieved documents. The content varies for each metric but allows for better interpretation of the results.

API name: metric_details

Adds an entry to metricDetails.

metricScore

@Nonnull
public final RankEvalMetricDetail.Builder metricScore(double value)

Required - The metric_score, found in the metric_details section, shows the contribution of this query to the global quality metric score.

API name: metric_score

unratedDocs

@Nonnull
public final RankEvalMetricDetail.Builder unratedDocs(List<UnratedDocument> list)

Required - The unrated_docs section contains an _index and _id entry for each document 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

Adds all elements of list to unratedDocs.

unratedDocs

@Nonnull
public final RankEvalMetricDetail.Builder unratedDocs(UnratedDocument value,
 UnratedDocument... values)

Required - The unrated_docs section contains an _index and _id entry for each document 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

Adds one or more values to unratedDocs.

unratedDocs

@Nonnull
public final RankEvalMetricDetail.Builder unratedDocs(Function<UnratedDocument.Builder,ObjectBuilder<UnratedDocument>> fn)

Required - The unrated_docs section contains an _index and _id entry for each document 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

Adds a value to unratedDocs using a builder lambda.

build

@Nonnull
public RankEvalMetricDetail build()

Builds a RankEvalMetricDetail.

Specified by:

build in interface ObjectBuilder<RankEvalMetricDetail>

Throws:

NullPointerException - if some of the required fields are null.