Module org.elasticsearch.server
Package org.elasticsearch.search.vectors

Class VectorSimilarityQuery

java.lang.Object
org.apache.lucene.search.Query
org.elasticsearch.search.vectors.VectorSimilarityQuery
public class VectorSimilarityQuery extends org.apache.lucene.search.Query
This query provides a simple post-filter for the provided Query. The query is assumed to be a Knn(Float|Byte)VectorQuery.

  • Constructor Summary

    Constructors
    Constructor
    Description
    VectorSimilarityQuery(org.apache.lucene.search.Query innerKnnQuery, float similarity, float docScore)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.lucene.search.Weight
    createWeight(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.search.ScoreMode scoreMode, float boost)
     
    boolean
    equals(Object obj)
     
    int
    hashCode()
     
    org.apache.lucene.search.Query
    rewrite(org.apache.lucene.search.IndexSearcher searcher)
     
    String
    toString(String field)
     
    void
    visit(org.apache.lucene.search.QueryVisitor visitor)
     

    Methods inherited from class org.apache.lucene.search.Query

    classHash, rewrite, sameClassAs, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • VectorSimilarityQuery

      public VectorSimilarityQuery(org.apache.lucene.search.Query innerKnnQuery, float similarity, float docScore)
      Parameters:
      innerKnnQuery - A KnnFloatVectorQuery or KnnByteVectorQuery
      similarity - The similarity threshold originally provided (used in explanations)
      docScore - The similarity transformed into a score threshold applied after gathering the nearest neighbors

  • Method Details

    • rewrite

      public org.apache.lucene.search.Query rewrite(org.apache.lucene.search.IndexSearcher searcher) throws IOException
      Overrides:
      rewrite in class org.apache.lucene.search.Query
      Throws:
      IOException

    • createWeight

      public org.apache.lucene.search.Weight createWeight(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.search.ScoreMode scoreMode, float boost) throws IOException
      Overrides:
      createWeight in class org.apache.lucene.search.Query
      Throws:
      IOException

    • toString

      public String toString(String field)
      Specified by:
      toString in class org.apache.lucene.search.Query

    • visit

      public void visit(org.apache.lucene.search.QueryVisitor visitor)
      Specified by:
      visit in class org.apache.lucene.search.Query

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in class org.apache.lucene.search.Query

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in class org.apache.lucene.search.Query