Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Knn(Float-->Byte)VectorField javadocs update in KnnByteVectorQuery (#13637)

This commit is contained in:
Christine Poerschke 2024-08-09 09:44:12 +01:00 committed by GitHub
parent 843273e20b
commit ea562f6ef2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lucene/core/src/java/org/apache/lucene/search/KnnByteVectorQuery.java
View File

@ -20,7 +20,7 @@ import java.io.IOException;
import java.util.Arrays;
import java.util.Objects;
import org.apache.lucene.codecs.KnnVectorsReader;
import org.apache.lucene.document.KnnFloatVectorField;
import org.apache.lucene.document.KnnByteVectorField;
import org.apache.lucene.index.ByteVectorValues;
import org.apache.lucene.index.FieldInfo;
import org.apache.lucene.index.LeafReader;
@ -52,7 +52,7 @@ public class KnnByteVectorQuery extends AbstractKnnVectorQuery {
* Find the <code>k</code> nearest documents to the target vector according to the vectors in the
* given field. <code>target</code> vector.
*
* @param field a field that has been indexed as a {@link KnnFloatVectorField}.
* @param field a field that has been indexed as a {@link KnnByteVectorField}.
* @param target the target of the search
* @param k the number of documents to find
* @throws IllegalArgumentException if <code>k</code> is less than 1
@ -65,7 +65,7 @@ public class KnnByteVectorQuery extends AbstractKnnVectorQuery {
* Find the <code>k</code> nearest documents to the target vector according to the vectors in the
* given field. <code>target</code> vector.
*
* @param field a field that has been indexed as a {@link KnnFloatVectorField}.
* @param field a field that has been indexed as a {@link KnnByteVectorField}.
* @param target the target of the search
* @param k the number of documents to find
* @param filter a filter applied before the vector search