Package co.elastic.clients.elasticsearch._types

Class RrfRank

java.lang.Object

co.elastic.clients.elasticsearch._types.RankBase

co.elastic.clients.elasticsearch._types.RrfRank

All Implemented Interfaces:

RankVariant, JsonpSerializable

@JsonpDeserializable
public class RrfRank
extends RankBase
implements RankVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

RankBase.AbstractBuilder<BuilderT extends RankBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Rank.Kind	_rankKind()	Rank variant kind.
static RrfRank	of(Function<RrfRank.Builder,ObjectBuilder<RrfRank>> fn)
final Long	rankConstant()	How much influence documents in individual result sets per query have over the final ranked result set
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRrfRankDeserializer(ObjectDeserializer<RrfRank.Builder> op)
String	toString()
final Long	windowSize()	Size of the individual result sets per query

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.RankVariant

_toRank

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RrfRank> _DESERIALIZER

Json deserializer for RrfRank

Method Details

of

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

_rankKind

public Rank.Kind _rankKind()

Rank variant kind.

Specified by:

_rankKind in interface RankVariant

rankConstant

@Nullable
public final Long rankConstant()

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 Long windowSize()

Size of the individual result sets per query

API name: window_size

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)

toString

public String toString()

Overrides:

toString in class Object

setupRrfRankDeserializer

protected static void setupRrfRankDeserializer(ObjectDeserializer<RrfRank.Builder> op)