KnnSearchQuery (java-client 8.3.3 API)

java.lang.Object

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

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public class KnnSearchQuery
extends java.lang.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 JsonpDeserializer<KnnSearchQuery> _DESERIALIZER
Json deserializer for KnnSearchQuery

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`field()`	Required - The name of the vector field to search against
`long`	`k()`	Required - The final number of nearest neighbors to return as top hits
`long`	`numCandidates()`	Required - The number of nearest neighbor candidates to consider per shard
`static KnnSearchQuery`	`of(java.util.function.Function<KnnSearchQuery.Builder,ObjectBuilder<KnnSearchQuery>> fn)`
`java.util.List<java.lang.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)`
`java.lang.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(java.util.function.Function<KnnSearchQuery.Builder,ObjectBuilder<KnnSearchQuery>> fn)
- field
  
  public final java.lang.String field()
  
  Required - The name of the vector field to search against
  API name: field
- queryVector
  
  public final java.util.List<java.lang.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 java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- setupKnnSearchQueryDeserializer
  
  protected static void setupKnnSearchQueryDeserializer(ObjectDeserializer<KnnSearchQuery.Builder> op)