Package org.opensearch.client.opensearch.core

Class RankEvalResponse

java.lang.Object

org.opensearch.client.opensearch.core.RankEvalResponse

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<RankEvalResponse.Builder,RankEvalResponse>

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

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

Method Summary

Modifier and Type	Method	Description
static RankEvalResponse.Builder	builder()
final Map<String,RankEvalMetricDetail>	details()	Required - The details section contains one entry for every query in the original requests section, keyed by the search request id
boolean	equals(Object o)
final Map<String,JsonData>	failures()	Required - API name: failures
int	hashCode()
final double	metricScore()	Required - The overall evaluation quality calculated by the defined metric
static RankEvalResponse	of(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)
RankEvalResponse.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

Json deserializer for RankEvalResponse

Method Details

of

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

details

@Nonnull
public final Map<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

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

Required - API name: failures

metricScore

public final double metricScore()

Required - The overall evaluation quality calculated by the defined metric

API name: metric_score

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 RankEvalResponse.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<RankEvalResponse.Builder,RankEvalResponse>

Returns:

a new builder instance.

builder

@Nonnull
public static RankEvalResponse.Builder builder()

setupRankEvalResponseDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object