forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use to VectorScorer for exact vector scoring (elastic#109945)
Lucene 9.11 introduced a new VectorScorer interface. We should utilize this interface when scoring exact vectors. related to: elastic#109293
- Loading branch information
Showing
7 changed files
with
611 additions
and
80 deletions.
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
209 changes: 209 additions & 0 deletions
209
server/src/main/java/org/elasticsearch/search/vectors/DenseVectorQuery.java
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,209 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| package org.elasticsearch.search.vectors; | ||
|
|
||
| import org.apache.lucene.index.ByteVectorValues; | ||
| import org.apache.lucene.index.FloatVectorValues; | ||
| import org.apache.lucene.index.LeafReaderContext; | ||
| import org.apache.lucene.search.DocIdSetIterator; | ||
| import org.apache.lucene.search.Explanation; | ||
| import org.apache.lucene.search.IndexSearcher; | ||
| import org.apache.lucene.search.Query; | ||
| import org.apache.lucene.search.QueryVisitor; | ||
| import org.apache.lucene.search.ScoreMode; | ||
| import org.apache.lucene.search.Scorer; | ||
| import org.apache.lucene.search.VectorScorer; | ||
| import org.apache.lucene.search.Weight; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Arrays; | ||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * Exact knn query. Will iterate and score all documents that have the provided dense vector field in the index. | ||
| */ | ||
| public abstract class DenseVectorQuery extends Query { | ||
|
|
||
| protected final String field; | ||
|
|
||
| public DenseVectorQuery(String field) { | ||
| this.field = field; | ||
| } | ||
|
|
||
| @Override | ||
| public void visit(QueryVisitor queryVisitor) { | ||
| queryVisitor.visitLeaf(this); | ||
| } | ||
|
|
||
| abstract static class DenseVectorWeight extends Weight { | ||
| private final String field; | ||
| private final float boost; | ||
|
|
||
| protected DenseVectorWeight(DenseVectorQuery query, float boost) { | ||
| super(query); | ||
| this.field = query.field; | ||
| this.boost = boost; | ||
| } | ||
|
|
||
| abstract VectorScorer vectorScorer(LeafReaderContext leafReaderContext) throws IOException; | ||
|
|
||
| @Override | ||
| public Explanation explain(LeafReaderContext leafReaderContext, int i) throws IOException { | ||
| VectorScorer vectorScorer = vectorScorer(leafReaderContext); | ||
| if (vectorScorer == null) { | ||
| return Explanation.noMatch("No vector values found for field: " + field); | ||
| } | ||
| DocIdSetIterator iterator = vectorScorer.iterator(); | ||
| iterator.advance(i); | ||
| if (iterator.docID() == i) { | ||
| float score = vectorScorer.score(); | ||
| return Explanation.match(vectorScorer.score() * boost, "found vector with calculated similarity: " + score); | ||
| } | ||
| return Explanation.noMatch("Document not found in vector values for field: " + field); | ||
| } | ||
|
|
||
| @Override | ||
| public Scorer scorer(LeafReaderContext leafReaderContext) throws IOException { | ||
| VectorScorer vectorScorer = vectorScorer(leafReaderContext); | ||
| if (vectorScorer == null) { | ||
| return null; | ||
| } | ||
| return new DenseVectorScorer(this, vectorScorer); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isCacheable(LeafReaderContext leafReaderContext) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| public static class Floats extends DenseVectorQuery { | ||
|
|
||
| private final float[] query; | ||
|
|
||
| public Floats(float[] query, String field) { | ||
| super(field); | ||
| this.query = query; | ||
| } | ||
|
|
||
| public float[] getQuery() { | ||
| return query; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString(String field) { | ||
| return "DenseVectorQuery.Floats"; | ||
| } | ||
|
|
||
| @Override | ||
| public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException { | ||
| return new DenseVectorWeight(Floats.this, boost) { | ||
| @Override | ||
| VectorScorer vectorScorer(LeafReaderContext leafReaderContext) throws IOException { | ||
| FloatVectorValues vectorValues = leafReaderContext.reader().getFloatVectorValues(field); | ||
| if (vectorValues == null) { | ||
| return null; | ||
| } | ||
| return vectorValues.scorer(query); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| Floats floats = (Floats) o; | ||
| return Objects.equals(field, floats.field) && Objects.deepEquals(query, floats.query); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(field, Arrays.hashCode(query)); | ||
| } | ||
| } | ||
|
|
||
| public static class Bytes extends DenseVectorQuery { | ||
|
|
||
| private final byte[] query; | ||
|
|
||
| public Bytes(byte[] query, String field) { | ||
| super(field); | ||
| this.query = query; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString(String field) { | ||
| return "DenseVectorQuery.Bytes"; | ||
| } | ||
|
|
||
| @Override | ||
| public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException { | ||
| return new DenseVectorWeight(Bytes.this, boost) { | ||
| @Override | ||
| VectorScorer vectorScorer(LeafReaderContext leafReaderContext) throws IOException { | ||
| ByteVectorValues vectorValues = leafReaderContext.reader().getByteVectorValues(field); | ||
| if (vectorValues == null) { | ||
| return null; | ||
| } | ||
| return vectorValues.scorer(query); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| Bytes bytes = (Bytes) o; | ||
| return Objects.equals(field, bytes.field) && Objects.deepEquals(query, bytes.query); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(field, Arrays.hashCode(query)); | ||
| } | ||
| } | ||
|
|
||
| static class DenseVectorScorer extends Scorer { | ||
|
|
||
| private final VectorScorer vectorScorer; | ||
| private final DocIdSetIterator iterator; | ||
| private final float boost; | ||
|
|
||
| DenseVectorScorer(DenseVectorWeight weight, VectorScorer vectorScorer) { | ||
| super(weight); | ||
| this.vectorScorer = vectorScorer; | ||
| this.iterator = vectorScorer.iterator(); | ||
| this.boost = weight.boost; | ||
| } | ||
|
|
||
| @Override | ||
| public DocIdSetIterator iterator() { | ||
| return vectorScorer.iterator(); | ||
| } | ||
|
|
||
| @Override | ||
| public float getMaxScore(int i) throws IOException { | ||
| // TODO: can we optimize this at all? | ||
| return Float.POSITIVE_INFINITY; | ||
| } | ||
|
|
||
| @Override | ||
| public float score() throws IOException { | ||
| assert iterator.docID() != -1; | ||
| return vectorScorer.score() * boost; | ||
| } | ||
|
|
||
| @Override | ||
| public int docID() { | ||
| return iterator.docID(); | ||
| } | ||
| } | ||
| } |
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.