Package org.apache.lucene.search
Class FloatVectorSimilarityQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.FloatVectorSimilarityQuery
Search for all (approximate) float vectors above a similarity threshold.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
Fields -
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 TopDocsapproximateSearch(LeafReaderContext context, Bits acceptDocs, int visitLimit, KnnCollectorManager knnCollectorManager) createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.booleanOverride and implement query instance equivalence properly in a subclass.protected KnnCollectorManagerinthashCode()Override and implement query hash code properly in a subclass.Prints a query to a string, withfieldassumed to be the default field and omitted.voidvisit(QueryVisitor visitor) Recurse through the query tree, visiting any child queries.Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
Field Details
-
field
-
traversalSimilarity
protected final float traversalSimilarity -
resultSimilarity
protected final float resultSimilarity -
filter
-
-
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
-
approximateSearch
protected TopDocs approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitLimit, KnnCollectorManager knnCollectorManager) throws IOException - Throws:
IOException
-
toString
Description copied from class:QueryPrints a query to a string, withfieldassumed to be the default field and omitted. -
equals
Description copied from class:QueryOverride and implement query instance equivalence properly in a subclass. This is required so thatQueryCacheworks 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:
-
hashCode
public int hashCode()Description copied from class:QueryOverride and implement query hash code properly in a subclass. This is required so thatQueryCacheworks properly.- See Also:
-
getKnnCollectorManager
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException Description copied from class:QueryExpert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeightin classQuery- Parameters:
scoreMode- How the produced scorers will be consumed.boost- The boost that is propagated by the parent queries.- Throws:
IOException
-
visit
Description copied from class:QueryRecurse through the query tree, visiting any child queries.
-