Class KnnSearchBuilder

java.lang.Object
org.elasticsearch.search.vectors.KnnSearchBuilder
All Implemented Interfaces:
Writeable, Rewriteable<KnnSearchBuilder>, ToXContent, ToXContentFragment

public class KnnSearchBuilder extends Object implements Writeable, ToXContentFragment, Rewriteable<KnnSearchBuilder>
Defines a kNN search to run in the search request.
  • Field Details

    • NUM_CANDS_LIMIT

      public static final int NUM_CANDS_LIMIT
      See Also:
    • NUM_CANDS_MULTIPLICATIVE_FACTOR

      public static final float NUM_CANDS_MULTIPLICATIVE_FACTOR
      See Also:
    • FIELD_FIELD

      public static final ParseField FIELD_FIELD
    • K_FIELD

      public static final ParseField K_FIELD
    • NUM_CANDS_FIELD

      public static final ParseField NUM_CANDS_FIELD
    • VISIT_PERCENTAGE_FIELD

      public static final ParseField VISIT_PERCENTAGE_FIELD
    • QUERY_VECTOR_FIELD

      public static final ParseField QUERY_VECTOR_FIELD
    • QUERY_VECTOR_BUILDER_FIELD

      public static final ParseField QUERY_VECTOR_BUILDER_FIELD
    • VECTOR_SIMILARITY

      public static final ParseField VECTOR_SIMILARITY
    • FILTER_FIELD

      public static final ParseField FILTER_FIELD
    • NAME_FIELD

      public static final ParseField NAME_FIELD
    • BOOST_FIELD

      public static final ParseField BOOST_FIELD
    • INNER_HITS_FIELD

      public static final ParseField INNER_HITS_FIELD
    • RESCORE_VECTOR_FIELD

      public static final ParseField RESCORE_VECTOR_FIELD
  • Constructor Details

    • KnnSearchBuilder

      public KnnSearchBuilder(String field, float[] queryVector, int k, int numCands, Float visitPercentage, RescoreVectorBuilder rescoreVectorBuilder, Float similarity)
      Defines a kNN search.
      Parameters:
      field - the name of the vector field to search against
      queryVector - the query vector
      k - the final number of nearest neighbors to return as top hits
      numCands - the number of nearest neighbor candidates to consider per shard
      visitPercentage - percentage of the total number of vectors to visit per shard
      rescoreVectorBuilder - rescore vector information
    • KnnSearchBuilder

      public KnnSearchBuilder(String field, VectorData queryVector, int k, int numCands, Float visitPercentage, RescoreVectorBuilder rescoreVectorBuilder, Float similarity)
      Defines a kNN search.
      Parameters:
      field - the name of the vector field to search against
      queryVector - the query vector
      k - the final number of nearest neighbors to return as top hits
      numCands - the number of nearest neighbor candidates to consider per shard
      visitPercentage - percentage of the total number of vectors to visit per shard
    • KnnSearchBuilder

      public KnnSearchBuilder(String field, QueryVectorBuilder queryVectorBuilder, int k, int numCands, Float visitPercentage, RescoreVectorBuilder rescoreVectorBuilder, Float similarity)
      Defines a kNN search where the query vector will be provided by the queryVectorBuilder
      Parameters:
      field - the name of the vector field to search against
      queryVectorBuilder - the query vector builder
      k - the final number of nearest neighbors to return as top hits
      numCands - the number of nearest neighbor candidates to consider per shard
      visitPercentage - percentage of the total number of vectors to visit per shard
    • KnnSearchBuilder

      public KnnSearchBuilder(String field, VectorData queryVector, QueryVectorBuilder queryVectorBuilder, int k, int numCands, Float visitPercentage, RescoreVectorBuilder rescoreVectorBuilder, Float similarity)
    • KnnSearchBuilder

      public KnnSearchBuilder(StreamInput in) throws IOException
      Throws:
      IOException
  • Method Details