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

Class RankEvalRequestItem

java.lang.Object

org.opensearch.client.opensearch.core.rank_eval.RankEvalRequestItem

All Implemented Interfaces:

JsonpSerializable

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

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	id()	Required - The search request's ID, used to group result details later.
static RankEvalRequestItem	of(java.util.function.Function<RankEvalRequestItem.Builder,ObjectBuilder<RankEvalRequestItem>> fn)
java.util.Map<java.lang.String,JsonData>	params()	The search template parameters.
java.util.List<DocumentRating>	ratings()	Required - List of document ratings
RankEvalQuery	request()	The query being evaluated.
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	setupRankEvalRequestItemDeserializer(ObjectDeserializer<RankEvalRequestItem.Builder> op)
java.lang.String	templateId()	The search template Id

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

Json deserializer for RankEvalRequestItem

Method Detail

of

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

id

public final java.lang.String id()

Required - The search request's ID, used to group result details later.

API name: id

request

@Nullable
public final RankEvalQuery request()

The query being evaluated.

API name: request

ratings

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

Required - List of document ratings

API name: ratings

templateId

@Nullable
public final java.lang.String templateId()

The search template Id

API name: template_id

params

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

The search template parameters.

API name: params

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)

setupRankEvalRequestItemDeserializer

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