Add Query for reranking KnnFloatVectorQuery with full-precision vectors #14009
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,128 @@ | ||
| /* | ||
| * 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.Objects; | ||
| import org.apache.lucene.index.IndexReader; | ||
|
|
||
| /** | ||
| * A Query that re-scores another Query with a DoubleValueSource function and cut-off the results at | ||
|
||
| * top N. | ||
| * | ||
| * @lucene.experimental | ||
| */ | ||
| public class RescoreTopNQuery extends Query { | ||
dungba88 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private final int n; | ||
| private final Query query; | ||
| private final DoubleValuesSource valuesSource; | ||
|
|
||
| /** | ||
dungba88 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * Execute the inner Query, re-score using a customizable DoubleValueSource and trim down the | ||
dungba88 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * result to k | ||
| * | ||
| * @param query the query to execute as initial phase | ||
| * @param valuesSource the double value source to re-score | ||
| * @param n the number of documents to find | ||
| * @throws IllegalArgumentException if <code>n</code> is less than 1 | ||
| */ | ||
| public RescoreTopNQuery(Query query, DoubleValuesSource valuesSource, int n) { | ||
| if (n < 1) { | ||
| throw new IllegalArgumentException("n must be >= 1"); | ||
| } | ||
| this.query = query; | ||
| this.valuesSource = valuesSource; | ||
| this.n = n; | ||
| } | ||
|
|
||
| @Override | ||
| public Query rewrite(IndexSearcher indexSearcher) throws IOException { | ||
| DoubleValuesSource rewrittenValueSource = valuesSource.rewrite(indexSearcher); | ||
| IndexReader reader = indexSearcher.getIndexReader(); | ||
| Query rewritten = indexSearcher.rewrite(query); | ||
| Weight weight = indexSearcher.createWeight(rewritten, ScoreMode.COMPLETE_NO_SCORES, 1.0f); | ||
| HitQueue queue = new HitQueue(n, false); | ||
| for (var leaf : reader.leaves()) { | ||
| Scorer innerScorer = weight.scorer(leaf); | ||
| if (innerScorer == null) { | ||
| continue; | ||
| } | ||
| DoubleValues rescores = rewrittenValueSource.getValues(leaf, getDoubleValues(innerScorer)); | ||
| DocIdSetIterator iterator = innerScorer.iterator(); | ||
| while (iterator.nextDoc() != DocIdSetIterator.NO_MORE_DOCS) { | ||
| int docId = iterator.docID(); | ||
| if (rescores.advanceExact(docId)) { | ||
| double v = rescores.doubleValue(); | ||
| queue.insertWithOverflow(new ScoreDoc(leaf.docBase + docId, (float) v)); | ||
| } else { | ||
| queue.insertWithOverflow(new ScoreDoc(leaf.docBase + docId, 0f)); | ||
| } | ||
| } | ||
| } | ||
| int i = 0; | ||
| ScoreDoc[] scoreDocs = new ScoreDoc[queue.size()]; | ||
| for (ScoreDoc topDoc : queue) { | ||
| scoreDocs[i++] = topDoc; | ||
| } | ||
| TopDocs topDocs = | ||
| new TopDocs(new TotalHits(queue.size(), TotalHits.Relation.EQUAL_TO), scoreDocs); | ||
|
||
| return KnnFloatVectorQuery.createRewrittenQuery(reader, topDocs, 0); | ||
dungba88 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| private DoubleValues getDoubleValues(Scorer innerScorer) { | ||
| // if the value source doesn't need document score to compute value, return null | ||
| if (valuesSource.needsScores() == false) { | ||
| return null; | ||
| } | ||
| return DoubleValuesSource.fromScorer(innerScorer); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| int result = valuesSource.hashCode(); | ||
| result = 31 * result + Objects.hash(query, n); | ||
| return result; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| RescoreTopNQuery that = (RescoreTopNQuery) o; | ||
| return Objects.equals(query, that.query) | ||
| && Objects.equals(valuesSource, that.valuesSource) | ||
| && n == that.n; | ||
| } | ||
|
|
||
| @Override | ||
| public void visit(QueryVisitor visitor) { | ||
| query.visit(visitor); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString(String field) { | ||
| return getClass().getSimpleName() | ||
| + ":" | ||
| + query.toString(field) | ||
| + ":" | ||
| + valuesSource.toString() | ||
| + "[" | ||
| + n | ||
| + "]"; | ||
| } | ||
| } | ||
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.
Seems like my IDE automatically removes extra spaces. If there is objection I'll revert that in next rev, along with other feedbacks.