Class RankEvalRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.RankEvalRequest
- All Implemented Interfaces:
JsonpSerializable
Enables you to evaluate the quality of ranked search results over a set of
typical search queries.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<RankEvalRequest>
Json deserializer forRankEvalRequest
static final Endpoint<RankEvalRequest,
RankEvalResponse, ErrorResponse> Endpoint "rank_eval
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final List<ExpandWildcard>
Whether to expand wildcard expression to concrete indices that are open, closed or both.final Boolean
Iftrue
, missing or closed indices are not included in the response.index()
Comma-separated list of data streams, indices, and index aliases used to limit the request.final RankEvalMetric
metric()
Definition of the evaluation metric to calculate.static RankEvalRequest
final List<RankEvalRequestItem>
requests()
Required - A set of typical search requests, together with their provided ratings.final String
Search operation typevoid
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
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forRankEvalRequest
-
_ENDPOINT
Endpoint "rank_eval
".
-
-
Method Details
-
of
public static RankEvalRequest of(Function<RankEvalRequest.Builder, ObjectBuilder<RankEvalRequest>> fn) -
allowNoIndices
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.API name:
allow_no_indices
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
index
Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (*
) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use_all
or*
.API name:
index
-
metric
Definition of the evaluation metric to calculate.API name:
metric
-
requests
Required - A set of typical search requests, together with their provided ratings.API name:
requests
-
searchType
Search operation typeAPI name:
search_type
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupRankEvalRequestDeserializer
protected static void setupRankEvalRequestDeserializer(ObjectDeserializer<RankEvalRequest.Builder> op)
-