Package co.elastic.clients.elasticsearch._types

Class DiversifyRetriever

java.lang.Object
co.elastic.clients.elasticsearch._types.RetrieverBase
co.elastic.clients.elasticsearch._types.DiversifyRetriever
All Implemented Interfaces:
RetrieverVariant, JsonpSerializable
@JsonpDeserializable public class DiversifyRetriever extends RetrieverBase implements RetrieverVariant
See Also:

  • Field Details

  • Method Details

    • of

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

    • _retrieverKind

      public Retriever.Kind _retrieverKind()
      Retriever variant kind.
      Specified by:
      _retrieverKind in interface RetrieverVariant

    • type

      public final DiversifyRetrieverTypes type()
      Required - The diversification strategy to apply.

      API name: type

    • field

      public final String field()
      Required - The document field on which to diversify results on.

      API name: field

    • retriever

      public final Retriever retriever()
      Required - The nested retriever whose results will be diversified.

      API name: retriever

    • size

      @Nullable public final Integer size()
      The number of top documents to return after diversification.

      API name: size

    • rankWindowSize

      @Nullable public final Integer rankWindowSize()
      The number of top documents from the nested retriever to consider for diversification.

      API name: rank_window_size

    • queryVector

      public final List<Float> queryVector()
      The query vector used for diversification.

      API name: query_vector

    • queryVectorBuilder

      @Nullable public final QueryVectorBuilder queryVectorBuilder()
      a dense vector query vector builder to use instead of a static query_vector

      API name: query_vector_builder

    • lambda

      @Nullable public final Float lambda()
      Controls the trade-off between relevance and diversity for MMR. A value of 0.0 focuses solely on diversity, while a value of 1.0 focuses solely on relevance. Required for MMR

      API name: lambda

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class RetrieverBase

    • rebuild

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

    • setupDiversifyRetrieverDeserializer

      protected static void setupDiversifyRetrieverDeserializer(ObjectDeserializer<DiversifyRetriever.Builder> op)