Package co.elastic.clients.elasticsearch._types

Class DiversifyRetriever.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RetrieverBase.AbstractBuilder<DiversifyRetriever.Builder>

co.elastic.clients.elasticsearch._types.DiversifyRetriever.Builder

All Implemented Interfaces:

WithJson<DiversifyRetriever.Builder>, ObjectBuilder<DiversifyRetriever>

Enclosing class:

DiversifyRetriever

public static class DiversifyRetriever.Builder
extends RetrieverBase.AbstractBuilder<DiversifyRetriever.Builder>
implements ObjectBuilder<DiversifyRetriever>

Builder for DiversifyRetriever.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DiversifyRetriever	build()	Builds a DiversifyRetriever.
final DiversifyRetriever.Builder	field(String value)	Required - The document field on which to diversify results on.
final DiversifyRetriever.Builder	lambda(Float value)	Controls the trade-off between relevance and diversity for MMR.
final DiversifyRetriever.Builder	queryVector(Float value, Float... values)	The query vector used for diversification.
final DiversifyRetriever.Builder	queryVector(List<Float> list)	The query vector used for diversification.
final DiversifyRetriever.Builder	queryVectorBuilder(QueryVectorBuilder value)	a dense vector query vector builder to use instead of a static query_vector
final DiversifyRetriever.Builder	queryVectorBuilder(QueryVectorBuilderVariant value)	a dense vector query vector builder to use instead of a static query_vector
final DiversifyRetriever.Builder	queryVectorBuilder(Function<QueryVectorBuilder.Builder,ObjectBuilder<QueryVectorBuilder>> fn)	a dense vector query vector builder to use instead of a static query_vector
final DiversifyRetriever.Builder	rankWindowSize(Integer value)	The number of top documents from the nested retriever to consider for diversification.
final DiversifyRetriever.Builder	retriever(Retriever value)	Required - The nested retriever whose results will be diversified.
final DiversifyRetriever.Builder	retriever(RetrieverVariant value)	Required - The nested retriever whose results will be diversified.
final DiversifyRetriever.Builder	retriever(Function<Retriever.Builder,ObjectBuilder<Retriever>> fn)	Required - The nested retriever whose results will be diversified.
protected DiversifyRetriever.Builder	self()
final DiversifyRetriever.Builder	size(Integer value)	The number of top documents to return after diversification.
final DiversifyRetriever.Builder	type(DiversifyRetrieverTypes value)	Required - The diversification strategy to apply.

Methods inherited from class co.elastic.clients.elasticsearch._types.RetrieverBase.AbstractBuilder

filter, filter, filter, filter, minScore, name

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

type

public final DiversifyRetriever.Builder type(DiversifyRetrieverTypes value)

Required - The diversification strategy to apply.

API name: type

field

public final DiversifyRetriever.Builder field(String value)

Required - The document field on which to diversify results on.

API name: field

retriever

public final DiversifyRetriever.Builder retriever(Retriever value)

Required - The nested retriever whose results will be diversified.

API name: retriever

retriever

public final DiversifyRetriever.Builder retriever(Function<Retriever.Builder,ObjectBuilder<Retriever>> fn)

Required - The nested retriever whose results will be diversified.

API name: retriever

retriever

public final DiversifyRetriever.Builder retriever(RetrieverVariant value)

Required - The nested retriever whose results will be diversified.

API name: retriever

size

public final DiversifyRetriever.Builder size(@Nullable
 Integer value)

The number of top documents to return after diversification.

API name: size

rankWindowSize

public final DiversifyRetriever.Builder rankWindowSize(@Nullable
 Integer value)

The number of top documents from the nested retriever to consider for diversification.

API name: rank_window_size

queryVector

public final DiversifyRetriever.Builder queryVector(List<Float> list)

The query vector used for diversification.

API name: query_vector

Adds all elements of list to queryVector.

queryVector

public final DiversifyRetriever.Builder queryVector(Float value,
 Float... values)

The query vector used for diversification.

API name: query_vector

Adds one or more values to queryVector.

queryVectorBuilder

public final DiversifyRetriever.Builder queryVectorBuilder(@Nullable
 QueryVectorBuilder value)

a dense vector query vector builder to use instead of a static query_vector

API name: query_vector_builder

queryVectorBuilder

public final DiversifyRetriever.Builder queryVectorBuilder(Function<QueryVectorBuilder.Builder,ObjectBuilder<QueryVectorBuilder>> fn)

a dense vector query vector builder to use instead of a static query_vector

API name: query_vector_builder

queryVectorBuilder

public final DiversifyRetriever.Builder queryVectorBuilder(QueryVectorBuilderVariant value)

a dense vector query vector builder to use instead of a static query_vector

API name: query_vector_builder

lambda

public final DiversifyRetriever.Builder lambda(@Nullable
 Float value)

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

self

protected DiversifyRetriever.Builder self()

Specified by:

self in class RetrieverBase.AbstractBuilder<DiversifyRetriever.Builder>

build

public DiversifyRetriever build()

Builds a DiversifyRetriever.

Specified by:

build in interface ObjectBuilder<DiversifyRetriever>

Throws:

NullPointerException - if some of the required fields are null.