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

Class RankEvalRequestItem

java.lang.Object

org.opensearch.client.opensearch._global.rank_eval.RankEvalRequestItem

All Implemented Interfaces:

ToJsonp

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RankEvalRequestItem(RankEvalRequestItem.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.String	id()	The search request's ID, used to group result details later.
java.util.Map<java.lang.String,jakarta.json.JsonValue>	params()	The search template parameters.
java.util.List<DocumentRating>	ratings()	List of document ratings API name: ratings
RankEvalQuery	request()	The query being evaluated.
protected static void	setupRankEvalRequestItemDeserializer(DelegatingDeserializer<RankEvalRequestItem.Builder> op)
java.lang.String	templateId()	The search template Id API name: template_id
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

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<RankEvalRequestItem> DESERIALIZER

Json deserializer for RankEvalRequestItem

Constructor Details

RankEvalRequestItem

protected RankEvalRequestItem(RankEvalRequestItem.Builder builder)

Method Details

id

public java.lang.String id()

The search request's ID, used to group result details later. API name: id

request

@Nullable public RankEvalQuery request()

The query being evaluated. API name: request

ratings

public java.util.List<DocumentRating> ratings()

List of document ratings API name: ratings

templateId

@Nullable public java.lang.String templateId()

The search template Id API name: template_id

params

@Nullable public java.util.Map<java.lang.String,jakarta.json.JsonValue> params()

The search template parameters. API name: params

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)

setupRankEvalRequestItemDeserializer

protected static void setupRankEvalRequestItemDeserializer(DelegatingDeserializer<RankEvalRequestItem.Builder> op)