Package co.elastic.clients.elasticsearch.core

Class RankEvalRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.RankEvalRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class RankEvalRequest extends RequestBase implements JsonpSerializable
Evaluate ranked search results.

Evaluate the quality of ranked search results over a set of typical search queries.

See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • index

      public final List<String> index()
      A 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

      @Nullable public final RankEvalMetric metric()
      Definition of the evaluation metric to calculate.

      API name: metric

    • requests

      public final List<RankEvalRequestItem> requests()
      Required - A set of typical search requests, together with their provided ratings.

      API name: requests

    • searchType

      @Nullable public final SearchType searchType()
      Search operation type

      API name: search_type

    • 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)

    • rebuild

      public RankEvalRequest.Builder rebuild()
      Returns:
      New RankEvalRequest.Builder initialized with field values of this instance

    • setupRankEvalRequestDeserializer

      protected static void setupRankEvalRequestDeserializer(ObjectDeserializer<RankEvalRequest.Builder> op)