Package org.apache.lucene.search
Class KnnVectorQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.search.KnnVectorQuery
-
public class KnnVectorQuery extends Query
UsesKnnVectorsReader.search(java.lang.String, float[], int, org.apache.lucene.util.Bits, int)
to perform nearest neighbour search.This query also allows for performing a kNN search subject to a filter. In this case, it first executes the filter for each leaf, then chooses a strategy dynamically:
- If the filter cost is less than k, just execute an exact search
- Otherwise run a kNN search subject to the filter
- If the kNN search visits too many vectors without completing, stop and run an exact search
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
KnnVectorQuery.BitSetCollector
(package private) static class
KnnVectorQuery.DocAndScoreQuery
Caches the results of a KnnVector search: a list of docs and their scores
-
Constructor Summary
Constructors Constructor Description KnnVectorQuery(java.lang.String field, float[] target, int k)
Find thek
nearest documents to the target vector according to the vectors in the given field.KnnVectorQuery(java.lang.String field, float[] target, int k, Query filter)
Find thek
nearest documents to the target vector according to the vectors in the given field.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private TopDocs
approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitedLimit)
private Query
createRewrittenQuery(IndexReader reader, TopDocs topK)
boolean
equals(java.lang.Object obj)
Override and implement query instance equivalence properly in a subclass.protected TopDocs
exactSearch(LeafReaderContext context, DocIdSetIterator acceptIterator)
private int[]
findSegmentStarts(IndexReader reader, int[] docs)
int
hashCode()
Override and implement query hash code properly in a subclass.Query
rewrite(IndexReader reader)
Expert: called to re-write queries into primitive queries.private TopDocs
searchLeaf(LeafReaderContext ctx, KnnVectorQuery.BitSetCollector filterCollector)
java.lang.String
toString(java.lang.String field)
Prints a query to a string, withfield
assumed to be the default field and omitted.void
visit(QueryVisitor visitor)
Recurse through the query tree, visiting any child queries-
Methods inherited from class org.apache.lucene.search.Query
classHash, createWeight, sameClassAs, toString
-
-
-
-
Constructor Detail
-
KnnVectorQuery
public KnnVectorQuery(java.lang.String field, float[] target, int k)
Find thek
nearest documents to the target vector according to the vectors in the given field.target
vector.- Parameters:
field
- a field that has been indexed as aKnnVectorField
.target
- the target of the searchk
- the number of documents to find- Throws:
java.lang.IllegalArgumentException
- ifk
is less than 1
-
KnnVectorQuery
public KnnVectorQuery(java.lang.String field, float[] target, int k, Query filter)
Find thek
nearest documents to the target vector according to the vectors in the given field.target
vector.- Parameters:
field
- a field that has been indexed as aKnnVectorField
.target
- the target of the searchk
- the number of documents to findfilter
- a filter applied before the vector search- Throws:
java.lang.IllegalArgumentException
- ifk
is less than 1
-
-
Method Detail
-
rewrite
public Query rewrite(IndexReader reader) throws java.io.IOException
Description copied from class:Query
Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.Callers are expected to call
rewrite
multiple times if necessary, until the rewritten query is the same as the original query.- Overrides:
rewrite
in classQuery
- Throws:
java.io.IOException
- See Also:
IndexSearcher.rewrite(Query)
-
searchLeaf
private TopDocs searchLeaf(LeafReaderContext ctx, KnnVectorQuery.BitSetCollector filterCollector) throws java.io.IOException
- Throws:
java.io.IOException
-
approximateSearch
private TopDocs approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitedLimit) throws java.io.IOException
- Throws:
java.io.IOException
-
exactSearch
protected TopDocs exactSearch(LeafReaderContext context, DocIdSetIterator acceptIterator) throws java.io.IOException
- Throws:
java.io.IOException
-
createRewrittenQuery
private Query createRewrittenQuery(IndexReader reader, TopDocs topK)
-
findSegmentStarts
private int[] findSegmentStarts(IndexReader reader, int[] docs)
-
toString
public java.lang.String toString(java.lang.String field)
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted.
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:Query
Recurse through the query tree, visiting any child queries
-
equals
public boolean equals(java.lang.Object obj)
Description copied from class:Query
Override and implement query instance equivalence properly in a subclass. This is required so thatQueryCache
works properly.Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical that other instance. Utility methods are provided for certain repetitive code.
- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
-
hashCode
public int hashCode()
Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly.- Specified by:
hashCode
in classQuery
- See Also:
Query.equals(Object)
-
-