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

Class RankEvalMetricDetail

java.lang.Object

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

All Implemented Interfaces:

ToJsonp

public final class RankEvalMetricDetail
extends java.lang.Object
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RankEvalMetricDetail.Builder	Builder for RankEvalMetricDetail.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<RankEvalMetricDetail>	DESERIALIZER	Json deserializer for RankEvalMetricDetail

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RankEvalMetricDetail(RankEvalMetricDetail.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.util.List<RankEvalHitItem>	hits()	The hits section shows a grouping of the search results with their supplied ratings API name: hits
java.util.Map<java.lang.String,java.util.Map<java.lang.String,jakarta.json.JsonValue>>	metricDetails()	The metric_details give additional information about the calculated quality metric (e.g.
java.lang.Number	metricScore()	The metric_score in the details section shows the contribution of this query to the global quality metric score API name: metric_score
protected static void	setupRankEvalMetricDetailDeserializer(DelegatingDeserializer<RankEvalMetricDetail.Builder> op)
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.util.List<UnratedDocument>	unratedDocs()	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

Field Details

DESERIALIZER

public static final JsonpDeserializer<RankEvalMetricDetail> DESERIALIZER

Json deserializer for RankEvalMetricDetail

Constructor Details

RankEvalMetricDetail

protected RankEvalMetricDetail(RankEvalMetricDetail.Builder builder)

Method Details

metricScore

public java.lang.Number metricScore()

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 java.util.List<UnratedDocument> unratedDocs()

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

hits

public java.util.List<RankEvalHitItem> hits()

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

metricDetails

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

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

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

protected void toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

setupRankEvalMetricDetailDeserializer

protected static void setupRankEvalMetricDetailDeserializer(DelegatingDeserializer<RankEvalMetricDetail.Builder> op)