Package co.elastic.clients.elasticsearch._types

Class RRFRetriever

java.lang.Object

co.elastic.clients.elasticsearch._types.RetrieverBase

co.elastic.clients.elasticsearch._types.RRFRetriever

All Implemented Interfaces:

RetrieverVariant, JsonpSerializable

@JsonpDeserializable
public class RRFRetriever
extends RetrieverBase
implements RetrieverVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RRFRetriever.Builder	Builder for RRFRetriever.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RetrieverBase

RetrieverBase.AbstractBuilder<BuilderT extends RetrieverBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RRFRetriever>	_DESERIALIZER	Json deserializer for RRFRetriever

Method Summary

Modifier and Type	Method	Description
Retriever.Kind	_retrieverKind()	Retriever variant kind.
static RRFRetriever	of(Function<RRFRetriever.Builder,ObjectBuilder<RRFRetriever>> fn)
final Integer	rankConstant()	This value determines how much influence documents in individual result sets per query have over the final ranked result set.
final List<Retriever>	retrievers()	Required - A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRRFRetrieverDeserializer(ObjectDeserializer<RRFRetriever.Builder> op)
final Integer	windowSize()	This value determines the size of the individual result sets per query.

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

filter, serialize, setupRetrieverBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.RetrieverVariant

_toRetriever

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RRFRetriever> _DESERIALIZER

Json deserializer for RRFRetriever

Method Details

of

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

_retrieverKind

public Retriever.Kind _retrieverKind()

Retriever variant kind.

Specified by:

_retrieverKind in interface RetrieverVariant

retrievers

public final List<Retriever> retrievers()

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

rankConstant

@Nullable
public final Integer rankConstant()

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

API name: rank_constant

windowSize

@Nullable
public final Integer windowSize()

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

API name: window_size

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class RetrieverBase

setupRRFRetrieverDeserializer

protected static void setupRRFRetrieverDeserializer(ObjectDeserializer<RRFRetriever.Builder> op)