java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.AbstractVectorSimilarityQuery
org.apache.lucene.search.FloatVectorSimilarityQuery
Search for all (approximate) float vectors above a similarity threshold.
-
Field Summary
FieldsFields inherited from class org.apache.lucene.search.AbstractVectorSimilarityQuery
field, filter, resultSimilarity, traversalSimilarity
-
Constructor Summary
ConstructorsConstructorDescriptionFloatVectorSimilarityQuery
(String field, float[] target, float resultSimilarity) Search for all (approximate) float vectors above a similarity threshold usingVectorSimilarityCollector
.FloatVectorSimilarityQuery
(String field, float[] target, float traversalSimilarity, float resultSimilarity) Search for all (approximate) float vectors above a similarity threshold usingVectorSimilarityCollector
.FloatVectorSimilarityQuery
(String field, float[] target, float traversalSimilarity, float resultSimilarity, Query filter) Search for all (approximate) float vectors above a similarity threshold usingVectorSimilarityCollector
.FloatVectorSimilarityQuery
(String field, float[] target, float resultSimilarity, Query filter) Search for all (approximate) float vectors above a similarity threshold usingVectorSimilarityCollector
. -
Method Summary
Modifier and TypeMethodDescriptionprotected TopDocs
approximateSearch
(LeafReaderContext context, Bits acceptDocs, int visitLimit) (package private) VectorScorer
createVectorScorer
(LeafReaderContext context) boolean
Override and implement query instance equivalence properly in a subclass.int
hashCode()
Override and implement query hash code properly in a subclass.Prints a query to a string, withfield
assumed to be the default field and omitted.Methods inherited from class org.apache.lucene.search.AbstractVectorSimilarityQuery
createWeight, visit
-
Field Details
-
target
private final float[] target
-
-
Constructor Details
-
FloatVectorSimilarityQuery
public FloatVectorSimilarityQuery(String field, float[] target, float traversalSimilarity, float resultSimilarity, Query filter) Search for all (approximate) float vectors above a similarity threshold usingVectorSimilarityCollector
. 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 aKnnFloatVectorField
.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.
-
FloatVectorSimilarityQuery
public FloatVectorSimilarityQuery(String field, float[] target, float traversalSimilarity, float resultSimilarity) Search for all (approximate) float vectors above a similarity threshold usingVectorSimilarityCollector
.- Parameters:
field
- a field that has been indexed as aKnnFloatVectorField
.target
- the target of the search.traversalSimilarity
- (lower) similarity score for graph traversal.resultSimilarity
- (higher) similarity score for result collection.
-
FloatVectorSimilarityQuery
public FloatVectorSimilarityQuery(String field, float[] target, float resultSimilarity, Query filter) Search for all (approximate) float vectors above a similarity threshold usingVectorSimilarityCollector
. 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 aKnnFloatVectorField
.target
- the target of the search.resultSimilarity
- similarity score for result collection.filter
- a filter applied before the vector search.
-
FloatVectorSimilarityQuery
Search for all (approximate) float vectors above a similarity threshold usingVectorSimilarityCollector
.- Parameters:
field
- a field that has been indexed as aKnnFloatVectorField
.target
- the target of the search.resultSimilarity
- similarity score for result collection.
-
-
Method Details
-
createVectorScorer
- Specified by:
createVectorScorer
in classAbstractVectorSimilarityQuery
- Throws:
IOException
-
approximateSearch
protected TopDocs approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitLimit) throws IOException - Specified by:
approximateSearch
in classAbstractVectorSimilarityQuery
- Throws:
IOException
-
toString
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted. -
equals
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 to those of the other instance. Utility methods are provided for certain repetitive code.
- Overrides:
equals
in classAbstractVectorSimilarityQuery
- See Also:
-
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.- Overrides:
hashCode
in classAbstractVectorSimilarityQuery
- See Also:
-