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

Class RankEvalMetricDetail

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class RankEvalMetricDetail
extends java.lang.Object
implements JsonpSerializable

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

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<RankEvalMetricDetail> _DESERIALIZER

Json deserializer for RankEvalMetricDetail

Method Detail

of

public static RankEvalMetricDetail of(java.util.function.Function<RankEvalMetricDetail.Builder,ObjectBuilder<RankEvalMetricDetail>> fn)

metricScore

public final double metricScore()

Required - 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 final java.util.List<UnratedDocument> 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 documents

API name: unrated_docs

hits

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

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

API name: hits

metricDetails

public final java.util.Map<java.lang.String,java.util.Map<java.lang.String,JsonData>> metricDetails()

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 results

API name: metric_details

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

setupRankEvalMetricDetailDeserializer

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