Add timeout support to AbstractKnnVectorQuery #13202
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| /* | ||
| * 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 org.apache.lucene.index.LeafReaderContext; | ||
| import org.apache.lucene.index.QueryTimeout; | ||
| import org.apache.lucene.search.knn.KnnCollectorManager; | ||
|
|
||
| /** A {@link KnnCollectorManager} that collects results with a timeout. */ | ||
| public class TimeLimitingKnnCollectorManager implements KnnCollectorManager { | ||
| private final KnnCollectorManager delegate; | ||
| private final QueryTimeout queryTimeout; | ||
|
|
||
| public TimeLimitingKnnCollectorManager(KnnCollectorManager delegate, QueryTimeout timeout) { | ||
| this.delegate = delegate; | ||
| this.queryTimeout = timeout; | ||
| } | ||
|
|
||
| /** Get the {@link QueryTimeout} for terminating graph searches. */ | ||
| public QueryTimeout getQueryTimeout() { | ||
| return queryTimeout; | ||
| } | ||
|
|
||
| @Override | ||
| public KnnCollector newCollector(int visitedLimit, LeafReaderContext context) throws IOException { | ||
| KnnCollector collector = delegate.newCollector(visitedLimit, context); | ||
| if (queryTimeout == null) { | ||
| return collector; | ||
| } | ||
| return new KnnCollector() { | ||
| @Override | ||
| public boolean earlyTerminated() { | ||
| return queryTimeout.shouldExit() || collector.earlyTerminated(); | ||
| } | ||
|
|
||
| @Override | ||
| public void incVisitedCount(int count) { | ||
| collector.incVisitedCount(count); | ||
| } | ||
|
|
||
| @Override | ||
| public long visitedCount() { | ||
| return collector.visitedCount(); | ||
| } | ||
|
|
||
| @Override | ||
| public long visitLimit() { | ||
| return collector.visitLimit(); | ||
| } | ||
|
|
||
| @Override | ||
| public int k() { | ||
| return collector.k(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean collect(int docId, float similarity) { | ||
| return collector.collect(docId, similarity); | ||
| } | ||
|
|
||
| @Override | ||
| public float minCompetitiveSimilarity() { | ||
| return collector.minCompetitiveSimilarity(); | ||
| } | ||
|
|
||
| @Override | ||
| public TopDocs topDocs() { | ||
| TopDocs docs = collector.topDocs(); | ||
|
|
||
| // Mark results as partial if timeout is met | ||
| TotalHits.Relation relation = | ||
| queryTimeout.shouldExit() | ||
| ? TotalHits.Relation.GREATER_THAN_OR_EQUAL_TO | ||
| : docs.totalHits.relation; | ||
|
|
||
| return new TopDocs(new TotalHits(docs.totalHits.value, relation), docs.scoreDocs); | ||
|
Comment on lines
+85
to
+91
There was a problem hiding this comment. Can we simply return There was a problem hiding this comment. I don't think the |
||
| } | ||
| }; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,6 +22,7 @@ | |
| import org.apache.lucene.index.DirectoryReader; | ||
| import org.apache.lucene.index.IndexReader; | ||
| import org.apache.lucene.index.LeafReaderContext; | ||
| import org.apache.lucene.index.QueryTimeout; | ||
| import org.apache.lucene.index.VectorSimilarityFunction; | ||
| import org.apache.lucene.store.Directory; | ||
| import org.apache.lucene.util.TestVectorUtil; | ||
|
|
@@ -102,14 +103,34 @@ public void testVectorEncodingMismatch() throws IOException { | |
| } | ||
| } | ||
|
|
||
| public void testTimeout() throws IOException { | ||
|
There was a problem hiding this comment. We could also add a test for the partial result case. You could create a mock query timeout that returns There was a problem hiding this comment. Makes sense! There was a consideration here that the number of levels in the HNSW graph should be == 1, because if the timeout is hit while finding the best entry point for the last level, we haven't collected any results yet. I think this should be fine as we're only indexing 3 vectors, and running these tests for a few thousand times did not give an error. Added a note about this as well Also fixed another place where the timeout needs to be checked |
||
| try (Directory indexStore = | ||
| getIndexStore("field", new float[] {0, 1}, new float[] {1, 2}, new float[] {0, 0}); | ||
| IndexReader reader = DirectoryReader.open(indexStore)) { | ||
| IndexSearcher searcher = newSearcher(reader); | ||
|
|
||
| AbstractKnnVectorQuery query = getKnnVectorQuery("field", new float[] {0.0f, 1.0f}, 2); | ||
| AbstractKnnVectorQuery exactQuery = | ||
| getKnnVectorQuery("field", new float[] {0.0f, 1.0f}, 10, new MatchAllDocsQuery()); | ||
|
|
||
| assertEquals(2, searcher.count(query)); // Expect some results without timeout | ||
| assertEquals(3, searcher.count(exactQuery)); // Same for exact search | ||
|
|
||
| searcher.setTimeout(() -> true); // Immediately timeout | ||
| assertEquals(0, searcher.count(query)); // Expect no results with the timeout | ||
| assertEquals(0, searcher.count(exactQuery)); // Same for exact search | ||
| } | ||
| } | ||
|
|
||
| private static class ThrowingKnnVectorQuery extends KnnByteVectorQuery { | ||
|
|
||
| public ThrowingKnnVectorQuery(String field, byte[] target, int k, Query filter) { | ||
| super(field, target, k, filter); | ||
| } | ||
|
|
||
| @Override | ||
| protected TopDocs exactSearch( | ||
| LeafReaderContext context, DocIdSetIterator acceptIterator, QueryTimeout queryTimeout) { | ||
| throw new UnsupportedOperationException("exact search is not supported"); | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, so both
searchLevel()andfindBestEntryPoint()inHnswGraphSearchercheckearlyTerminated()on their collector to abort the search, so configuring the timeout check allows us to preempt the approximate search.