benwtrent commented on code in PR #12679: URL: https://github.com/apache/lucene/pull/12679#discussion_r1393228359
########## lucene/core/src/java/org/apache/lucene/search/AbstractVectorSimilarityQuery.java: ########## @@ -0,0 +1,246 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.lucene.search; + +import java.io.IOException; +import java.util.Arrays; +import java.util.Comparator; +import java.util.Objects; +import org.apache.lucene.index.LeafReaderContext; +import org.apache.lucene.util.Bits; + +/** + * Search for all (approximate) vectors above a similarity threshold. + * + * @lucene.experimental + */ +abstract class AbstractVectorSimilarityQuery extends Query { + protected final String field; + protected final float traversalSimilarity, resultSimilarity; + protected final long visitLimit; + + /** + * Search for all (approximate) vectors above a similarity threshold. First performs a + * similarity-based graph search using {@link VectorSimilarityCollector} between {@link + * #traversalSimilarity} and {@link #resultSimilarity}. If this does not complete within a + * specified {@link #visitLimit}, returns a lazy-loading iterator over all vectors above the + * {@link #resultSimilarity}. + * + * @param field a field that has been indexed as a vector field. + * @param traversalSimilarity (lower) similarity score for graph traversal. + * @param resultSimilarity (higher) similarity score for result collection. + * @param visitLimit limit on number of nodes to visit before falling back to a lazy-loading + * iterator. + */ + AbstractVectorSimilarityQuery( + String field, float traversalSimilarity, float resultSimilarity, long visitLimit) { + this.field = Objects.requireNonNull(field, "field"); + this.traversalSimilarity = traversalSimilarity; + this.resultSimilarity = resultSimilarity; + this.visitLimit = visitLimit; + } + + abstract VectorScorer createVectorScorer(LeafReaderContext context) throws IOException; + + protected abstract void approximateSearch(LeafReaderContext context, KnnCollector collector) + throws IOException; Review Comment: If the user provides a filter where `iterator.cost() < numVectors()`, we do all this work in approximateSearch (because we need to score the values) only to throw it away. I guess the way around this is for users to provide a sane "visitLimit" to prevent too much work from happening. I am not sure another way around this other than providing a pre-filter. Perhaps the cost is acceptable. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
