Package co.elastic.clients.elasticsearch._types

Class KnnRetriever

java.lang.Object

co.elastic.clients.elasticsearch._types.RetrieverBase

co.elastic.clients.elasticsearch._types.KnnRetriever

All Implemented Interfaces:

RetrieverVariant, JsonpSerializable

@JsonpDeserializable
public class KnnRetriever
extends RetrieverBase
implements RetrieverVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<KnnRetriever>	_DESERIALIZER	Json deserializer for KnnRetriever

Method Summary

Modifier and Type	Method	Description
Retriever.Kind	_retrieverKind()	Retriever variant kind.
final String	field()	Required - The name of the vector field to search against.
final int	k()	Required - Number of nearest neighbors to return as top hits.
final int	numCandidates()	Required - Number of nearest neighbor candidates to consider per shard.
static KnnRetriever	of(Function<KnnRetriever.Builder,ObjectBuilder<KnnRetriever>> fn)
final List<Float>	queryVector()	Query vector.
final QueryVectorBuilder	queryVectorBuilder()	Defines a model to build a query vector.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupKnnRetrieverDeserializer(ObjectDeserializer<KnnRetriever.Builder> op)
final Float	similarity()	The minimum similarity required for a document to be considered a match.

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<KnnRetriever> _DESERIALIZER

Json deserializer for KnnRetriever

Method Details

of

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

_retrieverKind

public Retriever.Kind _retrieverKind()

Retriever variant kind.

Specified by:

_retrieverKind in interface RetrieverVariant

field

public final String field()

Required - The name of the vector field to search against.

API name: field

queryVector

public final List<Float> queryVector()

Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both.

API name: query_vector

queryVectorBuilder

@Nullable
public final QueryVectorBuilder queryVectorBuilder()

Defines a model to build a query vector.

API name: query_vector_builder

k

public final int k()

Required - Number of nearest neighbors to return as top hits.

API name: k

numCandidates

public final int numCandidates()

Required - Number of nearest neighbor candidates to consider per shard.

API name: num_candidates

similarity

@Nullable
public final Float similarity()

The minimum similarity required for a document to be considered a match.

API name: similarity

serializeInternal

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

Overrides:

serializeInternal in class RetrieverBase

setupKnnRetrieverDeserializer

protected static void setupKnnRetrieverDeserializer(ObjectDeserializer<KnnRetriever.Builder> op)