Package org.opensearch.client.opensearch._global

Class RankEvalRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch._global.RankEvalRequest
All Implemented Interfaces:
ToJsonp
public final class RankEvalRequest
extends RequestBase
implements ToJsonp

  • Field Details

  • Constructor Details

  • Method Details

    • index

      public java.util.List<java.lang.String> 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

    • allowNoIndices

      @Nullable public java.lang.Boolean allowNoIndices()
      If false, 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 targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. API name: allow_no_indices

    • expandWildcards

      @Nullable public jakarta.json.JsonValue expandWildcards()
      API name: expand_wildcards

    • ignoreUnavailable

      @Nullable public java.lang.Boolean ignoreUnavailable()
      If true, missing or closed indices are not included in the response. API name: ignore_unavailable

    • searchType

      @Nullable public java.lang.String searchType()
      API name: search_type

    • requests

      public java.util.List<RankEvalRequestItem> requests()
      A set of typical search requests, together with their provided ratings API name: requests

    • metric

      @Nullable public RankEvalMetric metric()
      Definition of the evaluation metric to calculate API name: metric

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

    • setupRankEvalRequestDeserializer

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