Package co.elastic.clients.elasticsearch.core.knn_search

Class KnnSearchQuery

java.lang.Object

co.elastic.clients.elasticsearch.core.knn_search.KnnSearchQuery

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class KnnSearchQuery
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final String	field()	Required - The name of the vector field to search against
final long	k()	Required - The final number of nearest neighbors to return as top hits
final long	numCandidates()	Required - The number of nearest neighbor candidates to consider per shard
static KnnSearchQuery	of(Function<KnnSearchQuery.Builder,ObjectBuilder<KnnSearchQuery>> fn)
final List<Double>	queryVector()	Required - The query vector
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	setupKnnSearchQueryDeserializer(ObjectDeserializer<KnnSearchQuery.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<KnnSearchQuery> _DESERIALIZER

Json deserializer for KnnSearchQuery

Method Details

of

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

field

public final String field()

Required - The name of the vector field to search against

API name: field

queryVector

public final List<Double> queryVector()

Required - The query vector

API name: query_vector

k

public final long k()

Required - The final number of nearest neighbors to return as top hits

API name: k

numCandidates

public final long numCandidates()

Required - The number of nearest neighbor candidates to consider per shard

API name: num_candidates

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

setupKnnSearchQueryDeserializer

protected static void setupKnnSearchQueryDeserializer(ObjectDeserializer<KnnSearchQuery.Builder> op)