Package org.apache.lucene.search
Class ByteVectorSimilarityQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.search.ByteVectorSimilarityQuery
-
public class ByteVectorSimilarityQuery extends Query
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.
-
-
Field Summary
Fields Modifier and Type Field Description protected Stringfieldprotected Queryfilterprotected floatresultSimilarityprotected floattraversalSimilarity
-
Constructor Summary
Constructors Constructor Description ByteVectorSimilarityQuery(String field, byte[] target, float resultSimilarity)Search for all (approximate) byte vectors above a similarity threshold usingVectorSimilarityCollector.ByteVectorSimilarityQuery(String field, byte[] target, float traversalSimilarity, float resultSimilarity)Search for all (approximate) byte vectors above a similarity threshold usingVectorSimilarityCollector.ByteVectorSimilarityQuery(String field, byte[] target, float traversalSimilarity, float resultSimilarity, Query filter)Search for all (approximate) byte vectors above a similarity threshold usingVectorSimilarityCollector.ByteVectorSimilarityQuery(String field, byte[] target, float resultSimilarity, Query filter)Search for all (approximate) byte vectors above a similarity threshold usingVectorSimilarityCollector.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected TopDocsapproximateSearch(LeafReaderContext context, Bits acceptDocs, int visitLimit)WeightcreateWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)Expert: Constructs an appropriate Weight implementation for this query.booleanequals(Object o)Override and implement query instance equivalence properly in a subclass.inthashCode()Override and implement query hash code properly in a subclass.StringtoString(String field)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.
-
-
-
Constructor Detail
-
ByteVectorSimilarityQuery
public ByteVectorSimilarityQuery(String field, byte[] target, float traversalSimilarity, float resultSimilarity, Query filter)
Search for all (approximate) byte 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 aKnnByteVectorField.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 usingVectorSimilarityCollector.- Parameters:
field- a field that has been indexed as aKnnByteVectorField.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 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 aKnnByteVectorField.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 usingVectorSimilarityCollector.- Parameters:
field- a field that has been indexed as aKnnByteVectorField.target- the target of the search.resultSimilarity- similarity score for result collection.
-
-
Method Detail
-
approximateSearch
protected TopDocs approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitLimit) throws IOException
- Throws:
IOException
-
toString
public String toString(String field)
Description copied from class:QueryPrints a query to a string, withfieldassumed to be the default field and omitted.
-
equals
public boolean equals(Object o)
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:
Query.sameClassAs(Object),Query.classHash()
-
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:
Query.equals(Object)
-
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 classQueryscoreMode- 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:QueryRecurse through the query tree, visiting any child queries.
-
-