Module org.apache.lucene.core

Package org.apache.lucene.search

Class ByteVectorSimilarityQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.AbstractVectorSimilarityQuery

org.apache.lucene.search.ByteVectorSimilarityQuery

public class ByteVectorSimilarityQuery
extends AbstractVectorSimilarityQuery

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

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	target

Fields inherited from class org.apache.lucene.search.AbstractVectorSimilarityQuery

field, filter, resultSimilarity, traversalSimilarity

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected TopDocs	approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitLimit)
(package private) VectorScorer	createVectorScorer(LeafReaderContext context)
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.
String	toString(String field)	Prints a query to a string, with field assumed to be the default field and omitted.

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

createWeight, visit

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

classHash, rewrite, rewrite, sameClassAs, toString

Methods inherited from class java.lang.Object

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

Field Details

target

private final byte[] target

Constructor Details

ByteVectorSimilarityQuery

public ByteVectorSimilarityQuery(String field,
 byte[] target,
 float traversalSimilarity,
 float resultSimilarity,
 Query filter)

Search for all (approximate) byte 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 KnnByteVectorField.

target - the target of the search.

traversalSimilarity - (lower) similarity score for graph traversal.

resultSimilarity - (higher) similarity score for result collection.

filter - a filter applied before the vector search.

ByteVectorSimilarityQuery

public ByteVectorSimilarityQuery(String field,
 byte[] target,
 float traversalSimilarity,
 float resultSimilarity)

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

Parameters:

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

target - the target of the search.

traversalSimilarity - (lower) similarity score for graph traversal.

resultSimilarity - (higher) similarity score for result collection.

ByteVectorSimilarityQuery

public ByteVectorSimilarityQuery(String field,
 byte[] target,
 float resultSimilarity,
 Query filter)

Search for all (approximate) byte 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 KnnByteVectorField.

target - the target of the search.

resultSimilarity - similarity score for result collection.

filter - a filter applied before the vector search.

ByteVectorSimilarityQuery

public ByteVectorSimilarityQuery(String field,
 byte[] target,
 float resultSimilarity)

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

Parameters:

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

target - the target of the search.

resultSimilarity - similarity score for result collection.

Method Details

createVectorScorer

VectorScorer createVectorScorer(LeafReaderContext context)
                         throws IOException

Specified by:

createVectorScorer in class AbstractVectorSimilarityQuery

Throws:

IOException

approximateSearch

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

Specified by:

approximateSearch in class AbstractVectorSimilarityQuery

Throws:

IOException

toString

public String toString(String field)

Description copied from class: Query

Prints a query to a string, with field assumed to be the default field and omitted.

Specified by:

toString in class Query

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.

Overrides:

equals in class AbstractVectorSimilarityQuery

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.

Overrides:

hashCode in class AbstractVectorSimilarityQuery

See Also:

• Query.equals(Object)