Class RankEvalMetricDetail.Builder
java.lang.Object
co.elastic.clients.elasticsearch._core.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
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description RankEvalMetricDetail.Builder
addHits(RankEvalHitItem value)
Add a value tohits(List)
, creating the list if needed.RankEvalMetricDetail.Builder
addHits(java.util.function.Function<RankEvalHitItem.Builder,ObjectBuilder<RankEvalHitItem>> fn)
Add a value tohits(List)
, creating the list if needed.RankEvalMetricDetail.Builder
addUnratedDocs(UnratedDocument value)
Add a value tounratedDocs(List)
, creating the list if needed.RankEvalMetricDetail.Builder
addUnratedDocs(java.util.function.Function<UnratedDocument.Builder,ObjectBuilder<UnratedDocument>> fn)
Add a value tounratedDocs(List)
, creating the list if needed.RankEvalMetricDetail
build()
Builds aRankEvalMetricDetail
.RankEvalMetricDetail.Builder
hits(RankEvalHitItem... value)
Required - The hits section shows a grouping of the search results with their supplied ratingsRankEvalMetricDetail.Builder
hits(java.util.function.Function<RankEvalHitItem.Builder,ObjectBuilder<RankEvalHitItem>> fn)
Sethits(List)
to a singleton list.RankEvalMetricDetail.Builder
hits(java.util.List<RankEvalHitItem> value)
Required - The hits section shows a grouping of the search results with their supplied ratingsRankEvalMetricDetail.Builder
metricDetails(java.util.Map<java.lang.String,java.util.Map<java.lang.String,JsonData>> value)
Required - The metric_details give additional information about the calculated quality metric (e.g.RankEvalMetricDetail.Builder
metricScore(double value)
Required - The metric_score in the details section shows the contribution of this query to the global quality metric scoreRankEvalMetricDetail.Builder
putMetricDetails(java.lang.String key, java.util.Map<java.lang.String,JsonData> value)
Add a key/value tometricDetails(Map)
, creating the map if needed.RankEvalMetricDetail.Builder
unratedDocs(UnratedDocument... value)
Required - 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(java.util.function.Function<UnratedDocument.Builder,ObjectBuilder<UnratedDocument>> fn)
SetunratedDocs(List)
to a singleton list.RankEvalMetricDetail.Builder
unratedDocs(java.util.List<UnratedDocument> value)
Required - 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
Required - The metric_score in the details section shows the contribution of this query to the global quality metric scoreAPI name:
metric_score
-
unratedDocs
Required - 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 documentsAPI name:
unrated_docs
-
unratedDocs
Required - 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 documentsAPI name:
unrated_docs
-
addUnratedDocs
Add a value tounratedDocs(List)
, creating the list if needed. -
unratedDocs
public RankEvalMetricDetail.Builder unratedDocs(java.util.function.Function<UnratedDocument.Builder,ObjectBuilder<UnratedDocument>> fn)SetunratedDocs(List)
to a singleton list. -
addUnratedDocs
public RankEvalMetricDetail.Builder addUnratedDocs(java.util.function.Function<UnratedDocument.Builder,ObjectBuilder<UnratedDocument>> fn)Add a value tounratedDocs(List)
, creating the list if needed. -
hits
Required - The hits section shows a grouping of the search results with their supplied ratingsAPI name:
hits
-
hits
Required - The hits section shows a grouping of the search results with their supplied ratingsAPI name:
hits
-
addHits
Add a value tohits(List)
, creating the list if needed. -
hits
public RankEvalMetricDetail.Builder hits(java.util.function.Function<RankEvalHitItem.Builder,ObjectBuilder<RankEvalHitItem>> fn)Sethits(List)
to a singleton list. -
addHits
public RankEvalMetricDetail.Builder addHits(java.util.function.Function<RankEvalHitItem.Builder,ObjectBuilder<RankEvalHitItem>> fn)Add a value tohits(List)
, creating the list if needed. -
metricDetails
public RankEvalMetricDetail.Builder metricDetails(java.util.Map<java.lang.String,java.util.Map<java.lang.String,JsonData>> value)Required - 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 resultsAPI name:
metric_details
-
putMetricDetails
public RankEvalMetricDetail.Builder putMetricDetails(java.lang.String key, java.util.Map<java.lang.String,JsonData> value)Add a key/value tometricDetails(Map)
, creating the map if needed. -
build
Builds aRankEvalMetricDetail
.- Specified by:
build
in interfaceObjectBuilder<RankEvalMetricDetail>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-