Package org.apache.lucene.search

Class ByteVectorSimilarityQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.ByteVectorSimilarityQuery

Direct Known Subclasses:

ByteVectorSimilarityQuery.Adaptive, ByteVectorSimilarityQuery.Explicit

public abstract sealed class ByteVectorSimilarityQuery
extends Query
permits ByteVectorSimilarityQuery.Adaptive, ByteVectorSimilarityQuery.Explicit

Search for all (approximate) byte vectors above a similarity threshold.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ByteVectorSimilarityQuery.Adaptive	A ByteVectorSimilarityQuery with an adaptive threshold for graph traversal.
static class	ByteVectorSimilarityQuery.Explicit	Deprecated. Equivalent to the ByteVectorSimilarityQuery constructors in Lucene 10.4 and earlier, use ByteVectorSimilarityQuery.Adaptive for a more performant version.

Field Summary

Fields

Modifier and Type	Field	Description
protected final float	decay
protected final String	field
protected final Query	filter
protected final float	resultSimilarity
protected final KnnSearchStrategy	searchStrategy

Method Summary

Modifier and Type	Method	Description
protected TopDocs	approximateSearch(LeafReaderContext context, AcceptDocs acceptDocs, int visitLimit, KnnCollectorManager knnCollectorManager)
Weight	createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)	Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(Object o)	Override and implement query instance equivalence properly in a subclass.
protected KnnCollectorManager	getKnnCollectorManager()	Returns a KnnCollectorManager that always builds a VectorSimilarityCollector configured with this query's searchStrategy.
KnnSearchStrategy	getSearchStrategy()
int	hashCode()	Override and implement query hash code properly in a subclass.
void	visit(QueryVisitor visitor)	Recurse through the query tree, visiting any child queries.

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

classHash, rewrite, sameClassAs, toString, toString

Methods inherited from class java.lang.Object

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

Field Details

field

protected final String field

resultSimilarity

protected final float resultSimilarity

decay

protected final float decay

filter

protected final Query filter

searchStrategy

protected final KnnSearchStrategy searchStrategy

Method Details

approximateSearch

protected TopDocs approximateSearch(LeafReaderContext context,
 AcceptDocs acceptDocs,
 int visitLimit,
 KnnCollectorManager knnCollectorManager)
                             throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Description copied from class: Query

Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache 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 to those of the other instance. Utility methods are provided for certain repetitive code.

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 that QueryCache works properly.

See Also:

• Query.equals(Object)

getKnnCollectorManager

protected KnnCollectorManager getKnnCollectorManager()

Returns a KnnCollectorManager that always builds a VectorSimilarityCollector configured with this query's searchStrategy.

The manager's strategy and LeafReaderContext parameters are intentionally ignored: top-k queries may override the strategy on a per-search basis, but similarity- threshold queries pin the strategy to the query's own value at construction time so that Query.equals(java.lang.Object) / getSearchStrategy() remain a faithful description of search behavior.

getSearchStrategy

public KnnSearchStrategy getSearchStrategy()

Returns:

the KnnSearchStrategy used during graph search.

createWeight

public Weight createWeight(IndexSearcher searcher,
 ScoreMode scoreMode,
 float boost)
                    throws IOException

Description copied from class: Query

Expert: Constructs an appropriate Weight implementation for this query.

Only implemented by primitive queries, which re-write to themselves.

Overrides:

createWeight in class Query

Parameters:

scoreMode - How the produced scorers will be consumed.

boost - The boost that is propagated by the parent queries.

Throws:

IOException

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries.

Specified by:

visit in class Query

Parameters:

visitor - a QueryVisitor to be called by each query in the tree