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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aRankEvalMetricDetail.copy()Create a new builderCopyableBuilderthat is a copy of this one.Required - Thehitssection provides a grouping of the search results with their supplied ratings.hits(List<RankEvalHitItem> list) Required - Thehitssection provides a grouping of the search results with their supplied ratings.hits(RankEvalHitItem value, RankEvalHitItem... values) Required - Thehitssection provides a grouping of the search results with their supplied ratings.metricDetails(String key, Map<String, JsonData> value) Required - Themetric_detailssection provides additional information about the calculated quality metric indicating the number of relevant retrieved documents.Required - Themetric_detailssection provides additional information about the calculated quality metric indicating the number of relevant retrieved documents.metricScore(double value) Required - Themetric_score, found in themetric_detailssection, shows the contribution of this query to the global quality metric score.Required - Theunrated_docssection contains an_indexand_identry for each document that didn't have aratingsvalue.unratedDocs(List<UnratedDocument> list) Required - Theunrated_docssection contains an_indexand_identry for each document that didn't have aratingsvalue.unratedDocs(UnratedDocument value, UnratedDocument... values) Required - Theunrated_docssection contains an_indexand_identry for each document that didn't have aratingsvalue.Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<RankEvalMetricDetail.Builder,RankEvalMetricDetail> - Returns:
- a new builder instance.
-
hits
Required - Thehitssection provides a grouping of the search results with their supplied ratings.API name:
hitsAdds all elements of
listtohits. -
hits
@Nonnull public final RankEvalMetricDetail.Builder hits(RankEvalHitItem value, RankEvalHitItem... values) Required - Thehitssection provides a grouping of the search results with their supplied ratings.API name:
hitsAdds one or more values to
hits. -
hits
@Nonnull public final RankEvalMetricDetail.Builder hits(Function<RankEvalHitItem.Builder, ObjectBuilder<RankEvalHitItem>> fn) Required - Thehitssection provides a grouping of the search results with their supplied ratings.API name:
hitsAdds a value to
hitsusing a builder lambda. -
metricDetails
@Nonnull public final RankEvalMetricDetail.Builder metricDetails(Map<String, Map<String, JsonData>> map) Required - Themetric_detailssection 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_detailsAdds all elements of
maptometricDetails. -
metricDetails
@Nonnull public final RankEvalMetricDetail.Builder metricDetails(String key, Map<String, JsonData> value) Required - Themetric_detailssection 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_detailsAdds an entry to
metricDetails. -
metricScore
Required - Themetric_score, found in themetric_detailssection, shows the contribution of this query to the global quality metric score.API name:
metric_score -
unratedDocs
Required - Theunrated_docssection contains an_indexand_identry for each document that didn't have aratingsvalue. This can be used to ask the user to supply ratings for these documents.API name:
unrated_docsAdds all elements of
listtounratedDocs. -
unratedDocs
@Nonnull public final RankEvalMetricDetail.Builder unratedDocs(UnratedDocument value, UnratedDocument... values) Required - Theunrated_docssection contains an_indexand_identry for each document that didn't have aratingsvalue. This can be used to ask the user to supply ratings for these documents.API name:
unrated_docsAdds one or more values to
unratedDocs. -
unratedDocs
@Nonnull public final RankEvalMetricDetail.Builder unratedDocs(Function<UnratedDocument.Builder, ObjectBuilder<UnratedDocument>> fn) Required - Theunrated_docssection contains an_indexand_identry for each document that didn't have aratingsvalue. This can be used to ask the user to supply ratings for these documents.API name:
unrated_docsAdds a value to
unratedDocsusing a builder lambda. -
build
Builds aRankEvalMetricDetail.- Specified by:
buildin interfaceObjectBuilder<RankEvalMetricDetail>- Throws:
NullPointerException- if some of the required fields are null.
-