Package org.opensearch.client.opensearch.core

Class RankEvalRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.core.RankEvalRequest
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<RankEvalRequest.Builder,RankEvalRequest>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public final class RankEvalRequest extends RequestBase implements PlainJsonSerializable, ToCopyableBuilder<RankEvalRequest.Builder,RankEvalRequest>
Allows to evaluate the quality of ranked search results over a set of typical search queries.

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. 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

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

      API name: expand_wildcards

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If true, missing or closed indexes are not included in the response.

      API name: ignore_unavailable

    • index

      @Nonnull public final List<String> index()
      Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (*) expressions are supported. To target all data streams and indexes in a cluster, omit this parameter or use _all or *.

      API name: index

    • metric

      @Nullable public final RankEvalMetric metric()
      API name: metric

    • requests

      @Nonnull 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)

    • toBuilder

      @Nonnull public RankEvalRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RankEvalRequest.Builder,RankEvalRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static RankEvalRequest.Builder builder()

    • setupRankEvalRequestDeserializer

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

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object