Package co.elastic.clients.elasticsearch._types

Class KnnQuery

java.lang.Object
co.elastic.clients.elasticsearch._types.KnnQuery
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class KnnQuery
extends java.lang.Object
implements JsonpSerializable
See Also:
API specification

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  KnnQuery.Builder
    Builder for KnnQuery.

  • Field Summary

    Fields
    Modifier and Type Field Description
    static JsonpDeserializer<KnnQuery> _DESERIALIZER
    Json deserializer for KnnQuery

  • Method Summary

    Modifier and Type Method Description
    java.lang.Float boost()
    Boost value to apply to kNN scores
    java.lang.String field()
    Required - The name of the vector field to search against
    java.util.List<Query> filter()
    Filters for the kNN search query
    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 KnnQuery of​(java.util.function.Function<KnnQuery.Builder,​ObjectBuilder<KnnQuery>> 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 setupKnnQueryDeserializer​(ObjectDeserializer<KnnQuery.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

  • Method Details

    • of

      public static KnnQuery of​(java.util.function.Function<KnnQuery.Builder,​ObjectBuilder<KnnQuery>> 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

    • boost

      @Nullable public final java.lang.Float boost()
      Boost value to apply to kNN scores

      API name: boost

    • filter

      public final java.util.List<Query> filter()
      Filters for the kNN search query

      API name: filter

    • 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

    • setupKnnQueryDeserializer

      protected static void setupKnnQueryDeserializer​(ObjectDeserializer<KnnQuery.Builder> op)