Package org.opensearch.client.opensearch.core

Class RankEvalResponse

java.lang.Object

org.opensearch.client.opensearch.core.RankEvalResponse

All Implemented Interfaces:

JsonpSerializable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<RankEvalResponse>	_DESERIALIZER	Json deserializer for RankEvalResponse

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,RankEvalMetricDetail>	details()	Required - The details section contains one entry for every query in the original requests section, keyed by the search request id
java.util.Map<java.lang.String,JsonData>	failures()	Required - API name: failures
double	metricScore()	Required - The overall evaluation quality calculated by the defined metric
static RankEvalResponse	of(java.util.function.Function<RankEvalResponse.Builder,ObjectBuilder<RankEvalResponse>> 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	setupRankEvalResponseDeserializer(ObjectDeserializer<RankEvalResponse.Builder> op)

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<RankEvalResponse> _DESERIALIZER

Json deserializer for RankEvalResponse

Method Detail

of

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

metricScore

public final double metricScore()

Required - The overall evaluation quality calculated by the defined metric

API name: metric_score

details

public final java.util.Map<java.lang.String,RankEvalMetricDetail> details()

Required - The details section contains one entry for every query in the original requests section, keyed by the search request id

API name: details

failures

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

Required - API name: failures

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)

setupRankEvalResponseDeserializer

protected static void setupRankEvalResponseDeserializer(ObjectDeserializer<RankEvalResponse.Builder> op)