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

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RankEvalMetricDetail
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<RankEvalMetricDetail.Builder,RankEvalMetricDetail>

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 final JsonpDeserializer<RankEvalMetricDetail>	_DESERIALIZER	Json deserializer for RankEvalMetricDetail

Method Summary

Modifier and Type	Method	Description
static RankEvalMetricDetail.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<RankEvalHitItem>	hits()	Required - The hits section provides a grouping of the search results with their supplied ratings.
final Map<String,Map<String,JsonData>>	metricDetails()	Required - The metric_details section provides additional information about the calculated quality metric indicating the number of relevant retrieved documents.
final double	metricScore()	Required - The metric_score, found in the metric_details section, shows the contribution of this query to the global quality metric score.
static RankEvalMetricDetail	of(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)
RankEvalMetricDetail.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final List<UnratedDocument>	unratedDocs()	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 java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RankEvalMetricDetail> _DESERIALIZER

Json deserializer for RankEvalMetricDetail

Method Details

of

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

hits

@Nonnull
public final List<RankEvalHitItem> hits()

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

API name: hits

metricDetails

@Nonnull
public final Map<String,Map<String,JsonData>> metricDetails()

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

metricScore

public final double metricScore()

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

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

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)

toBuilder

@Nonnull
public RankEvalMetricDetail.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RankEvalMetricDetail.Builder,RankEvalMetricDetail>

Returns:

a new builder instance.

builder

@Nonnull
public static RankEvalMetricDetail.Builder builder()

setupRankEvalMetricDetailDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object