Module org.apache.lucene.core

Package org.apache.lucene.search

Class AbstractVectorSimilarityQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.AbstractVectorSimilarityQuery

Direct Known Subclasses:

ByteVectorSimilarityQuery, FloatVectorSimilarityQuery

abstract class AbstractVectorSimilarityQuery
extends Query

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	AbstractVectorSimilarityQuery.VectorSimilarityScorer

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	field
protected final Query	filter
protected final float	resultSimilarity
protected final float	traversalSimilarity

Constructor Summary

Constructors

Constructor	Description
AbstractVectorSimilarityQuery(String field, float traversalSimilarity, float resultSimilarity, Query filter)	Search for all (approximate) vectors above a similarity threshold using VectorSimilarityCollector.

Method Summary

Modifier and Type	Method	Description
protected abstract TopDocs	approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitLimit)
(package private) abstract VectorScorer	createVectorScorer(LeafReaderContext context)
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.
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, 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

traversalSimilarity

protected final float traversalSimilarity

resultSimilarity

protected final float resultSimilarity

filter

protected final Query filter

Constructor Details

AbstractVectorSimilarityQuery

AbstractVectorSimilarityQuery(String field,
 float traversalSimilarity,
 float resultSimilarity,
 Query filter)

Search for all (approximate) vectors above a similarity threshold using VectorSimilarityCollector. If a filter is applied, it traverses as many nodes as the cost of the filter, and then falls back to exact search if results are incomplete.

Parameters:

field - a field that has been indexed as a vector field.

traversalSimilarity - (lower) similarity score for graph traversal.

resultSimilarity - (higher) similarity score for result collection.

filter - a filter applied before the vector search.

Method Details

createVectorScorer

abstract VectorScorer createVectorScorer(LeafReaderContext context)
                                  throws IOException

Throws:

IOException

approximateSearch

protected abstract TopDocs approximateSearch(LeafReaderContext context,
 Bits acceptDocs,
 int visitLimit)
                                      throws IOException

Throws:

IOException

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

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.

Specified by:

equals in class Query

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.

Specified by:

hashCode in class Query

See Also:

• Query.equals(Object)