Skip to content

Apache Lucene open-source search software

CHANGES/MIGRATE entries for KnnVectorValues API change (#13833)

Michael Sokolovf2b2bfc41487
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index 589bf708c3b..dcd9fdbbc14 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -175,6 +175,10 @@ API Changes
* GITHUB#13780: Remove `IndexSearcher#search(List<LeafReaderContext>, Weight, Collector)` in favour of the newly
introduced `IndexSearcher#search(LeafReaderContextPartition[], Weight, Collector)`
+* GITHUB#13779: First-class random access API for KnnVectorValues
+ unifies Byte/FloatVectorValues incorporating RandomAccess* API and introduces
+ DocIndexIterator for iterative access in place of direct inheritance from DISI.
+
New Features
---------------------
diff --git a/lucene/MIGRATE.md b/lucene/MIGRATE.md
index 3052c7319ac..0411791165d 100644
--- a/lucene/MIGRATE.md
+++ b/lucene/MIGRATE.md
@@ -888,3 +888,7 @@ additional vectors into the same field with either 4 or 7 bit
quantization (or no quantization), and ensure all older (9.x written)
segments are rewritten either via `IndexWriter.forceMerge` or
`IndexWriter.addIndexes(CodecReader...)`, or reindexing entirely.
+
+### Vector values APIs switched to primarily random-access
+
+`{Byte/Float}VectorValues` no longer inherit from `DocIdSetIterator`. Rather they extend a common class, `KnnVectorValues`, that provides a random access API (previously provided by `RandomAccessVectorValues`, now removed), and an `iterator()` method for retrieving `DocIndexIterator`: an iterator which is a DISI that also provides an `index()` method. Therefore, any iteration over vector values must now be performed using the values' `iterator()`. Random access works as before, but does not require casting to `RandomAccessVectorValues`.