Package co.elastic.clients.elasticsearch._types

Class KnnSearch

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

  • Field Details

  • Method Details

    • of

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

    • field

      public final String field()
      Required - The name of the vector field to search against

      API name: field

    • queryVector

      public final List<Float> queryVector()
      The query vector

      API name: query_vector

    • queryVectorBuilder

      @Nullable public final QueryVectorBuilder queryVectorBuilder()
      The query vector builder. You must provide a query_vector_builder or query_vector, but not both.

      API name: query_vector_builder

    • k

      @Nullable public final Integer k()
      The final number of nearest neighbors to return as top hits

      API name: k

    • numCandidates

      @Nullable public final Integer numCandidates()
      The number of nearest neighbor candidates to consider per shard

      API name: num_candidates

    • boost

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

      API name: boost

    • filter

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

      API name: filter

    • similarity

      @Nullable public final Float similarity()
      The minimum similarity for a vector to be considered a match

      API name: similarity

    • innerHits

      @Nullable public final InnerHits innerHits()
      If defined, each search hit will contain inner hits.

      API name: inner_hits

    • 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

    • setupKnnSearchDeserializer

      protected static void setupKnnSearchDeserializer(ObjectDeserializer<KnnSearch.Builder> op)