Package co.elastic.clients.elasticsearch._types

Class RRFRetriever.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch._types.RRFRetriever.Builder

All Implemented Interfaces:

WithJson<RRFRetriever.Builder>, ObjectBuilder<RRFRetriever>

Enclosing class:

RRFRetriever

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

Builder for RRFRetriever.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RRFRetriever	build()	Builds a RRFRetriever.
final RRFRetriever.Builder	rankConstant(Integer value)	This value determines how much influence documents in individual result sets per query have over the final ranked result set.
final RRFRetriever.Builder	rankWindowSize(Integer value)	This value determines the size of the individual result sets per query.
final RRFRetriever.Builder	retrievers(Retriever value, Retriever... values)	Required - A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.
final RRFRetriever.Builder	retrievers(Function<Retriever.Builder,ObjectBuilder<Retriever>> fn)	Required - A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.
final RRFRetriever.Builder	retrievers(List<Retriever> list)	Required - A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.
protected RRFRetriever.Builder	self()

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

filter, filter, filter

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

retrievers

public final RRFRetriever.Builder retrievers(List<Retriever> list)

Required - A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.

API name: retrievers

Adds all elements of list to retrievers.

retrievers

public final RRFRetriever.Builder retrievers(Retriever value,
 Retriever... values)

Required - A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.

API name: retrievers

Adds one or more values to retrievers.

retrievers

public final RRFRetriever.Builder retrievers(Function<Retriever.Builder,ObjectBuilder<Retriever>> fn)

Required - A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.

API name: retrievers

Adds a value to retrievers using a builder lambda.

rankConstant

public final RRFRetriever.Builder rankConstant(@Nullable
 Integer value)

This value determines how much influence documents in individual result sets per query have over the final ranked result set.

API name: rank_constant

rankWindowSize

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

This value determines the size of the individual result sets per query.

API name: rank_window_size

self

protected RRFRetriever.Builder self()

Specified by:

self in class RetrieverBase.AbstractBuilder<RRFRetriever.Builder>

build

public RRFRetriever build()

Builds a RRFRetriever.

Specified by:

build in interface ObjectBuilder<RRFRetriever>

Throws:

NullPointerException - if some of the required fields are null.