make early termination disabled by default

tteofili · tteofili · commit 98c42d2307f7 · 2025-05-28T15:11:16.000+02:00
diff --git a/server/src/main/java/org/elasticsearch/index/mapper/vectors/DenseVectorFieldMapper.java b/server/src/main/java/org/elasticsearch/index/mapper/vectors/DenseVectorFieldMapper.java
@@ -117,7 +117,10 @@ public class DenseVectorFieldMapper extends FieldMapper {
     public static final String COSINE_MAGNITUDE_FIELD_SUFFIX = "._magnitude";
     private static final float EPS = 1e-3f;
     public static final int BBQ_MIN_DIMS = 64;
+
+    // early termination configuration
     private static final String EARLY_EXIT_PARAM_NAME = "early_exit";
+    private static final boolean DEFAULT_EARLY_EXIT = false;
 
     public static boolean isNotUnitVector(float magnitude) {
         return Math.abs(magnitude - 1.0f) > EPS;
@@ -1426,7 +1429,7 @@ public IndexOptions parseIndexOptions(String fieldName, Map<String, ?> indexOpti
                     efConstructionNode = Lucene99HnswVectorsFormat.DEFAULT_BEAM_WIDTH;
                 }
                 if (earlyExitNode == null) {
-                    earlyExitNode = true;
+                    earlyExitNode = DEFAULT_EARLY_EXIT;
                 }
                 int m = XContentMapValues.nodeIntegerValue(mNode);
                 int efConstruction = XContentMapValues.nodeIntegerValue(efConstructionNode);
@@ -1704,7 +1707,7 @@ boolean updatableTo(IndexOptions update) {
 
         @Override
         boolean earlyExit() {
-            return false;
+            return DEFAULT_EARLY_EXIT;
         }
     }
 
@@ -1737,7 +1740,7 @@ boolean updatableTo(IndexOptions update) {
 
         @Override
         boolean earlyExit() {
-            return false;
+            return DEFAULT_EARLY_EXIT;
         }
 
         @Override
@@ -1758,7 +1761,7 @@ static class Int4HnswIndexOptions extends QuantizedIndexOptions {
         private final boolean earlyExit;
 
         Int4HnswIndexOptions(int m, int efConstruction, Float confidenceInterval, RescoreVector rescoreVector) {
-            this(m, efConstruction, confidenceInterval, rescoreVector, true);
+            this(m, efConstruction, confidenceInterval, rescoreVector, DEFAULT_EARLY_EXIT);
         }
 
         Int4HnswIndexOptions(int m, int efConstruction, Float confidenceInterval, RescoreVector rescoreVector, boolean earlyExit) {
@@ -1896,7 +1899,7 @@ boolean updatableTo(IndexOptions update) {
 
         @Override
         boolean earlyExit() {
-            return false;
+            return DEFAULT_EARLY_EXIT;
         }
 
     }
@@ -1908,7 +1911,7 @@ public static class Int8HnswIndexOptions extends QuantizedIndexOptions {
         private final boolean earlyExit;
 
         public Int8HnswIndexOptions(int m, int efConstruction, Float confidenceInterval, RescoreVector rescoreVector) {
-            this(m, efConstruction, confidenceInterval, rescoreVector, true);
+            this(m, efConstruction, confidenceInterval, rescoreVector, DEFAULT_EARLY_EXIT);
         }
 
         public Int8HnswIndexOptions(int m, int efConstruction, Float confidenceInterval, RescoreVector rescoreVector, boolean earlyExit) {
@@ -2002,7 +2005,7 @@ static class HnswIndexOptions extends IndexOptions {
         private final boolean earlyExit;
 
         HnswIndexOptions(int m, int efConstruction) {
-            this(m, efConstruction, true);
+            this(m, efConstruction, DEFAULT_EARLY_EXIT);
         }
 
         HnswIndexOptions(int m, int efConstruction, boolean earlyExit) {
diff --git a/server/src/test/java/org/elasticsearch/index/mapper/vectors/DenseVectorFieldTypeTests.java b/server/src/test/java/org/elasticsearch/index/mapper/vectors/DenseVectorFieldTypeTests.java
@@ -11,6 +11,7 @@
 
 import org.apache.lucene.search.KnnByteVectorQuery;
 import org.apache.lucene.search.KnnFloatVectorQuery;
+import org.apache.lucene.search.PatienceKnnVectorQuery;
 import org.apache.lucene.search.Query;
 import org.apache.lucene.search.join.BitSetProducer;
 import org.apache.lucene.search.join.DiversifyingChildrenByteKnnVectorQuery;
@@ -478,7 +479,7 @@ public void testCreateKnnQueryMaxDims() {
                 null,
                 randomFrom(DenseVectorFieldMapper.FilterHeuristic.values())
             );
-            assertThat(query, instanceOf(KnnByteVectorQuery.class));
+            assertThat(query, instanceOf(ESKnnByteVectorQuery.class));
         }
     }
 
@@ -577,16 +578,20 @@ public void testRescoreOversampleUsedWithoutQuantization() {
         );
 
         if (elementType == BYTE) {
-            KnnByteVectorQuery knnByteVectorQuery = (KnnByteVectorQuery) knnQuery;
-            assertThat(knnByteVectorQuery.getK(), is(100));
-            if (knnByteVectorQuery instanceof ESKnnByteVectorQuery esKnnByteVectorQuery) {
-                assertThat(esKnnByteVectorQuery.kParam(), is(10));
+            if (knnQuery instanceof PatienceKnnVectorQuery patienceKnnVectorQuery) {
+                assertThat(patienceKnnVectorQuery.getK(), is(100));
+            } else {
+                ESKnnByteVectorQuery knnByteVectorQuery = (ESKnnByteVectorQuery) knnQuery;
+                assertThat(knnByteVectorQuery.getK(), is(100));
+                assertThat(knnByteVectorQuery.kParam(), is(10));
             }
         } else {
-            KnnFloatVectorQuery knnFloatVectorQuery = (KnnFloatVectorQuery) knnQuery;
-            assertThat(knnFloatVectorQuery.getK(), is(100));
-            if (knnFloatVectorQuery instanceof ESKnnFloatVectorQuery esKnnFloatVectorQuery) {
-                assertThat(esKnnFloatVectorQuery.kParam(), is(10));
+            if (knnQuery instanceof PatienceKnnVectorQuery patienceKnnVectorQuery) {
+                assertThat(patienceKnnVectorQuery.getK(), is(100));
+            } else {
+                ESKnnFloatVectorQuery knnFloatVectorQuery = (ESKnnFloatVectorQuery) knnQuery;
+                assertThat(knnFloatVectorQuery.getK(), is(100));
+                assertThat(knnFloatVectorQuery.kParam(), is(10));
             }
         }
     }
@@ -635,7 +640,7 @@ public void testRescoreOversampleQueryOverrides() {
             null,
             randomFrom(DenseVectorFieldMapper.FilterHeuristic.values())
         );
-        assertTrue(query instanceof KnnFloatVectorQuery);
+        assertTrue(query instanceof ESKnnFloatVectorQuery);
 
         // verify we can override a `0` to a positive number
         fieldType = new DenseVectorFieldType(
@@ -738,11 +743,14 @@ private static void checkRescoreQueryParameters(
             randomFrom(DenseVectorFieldMapper.FilterHeuristic.values())
         );
         RescoreKnnVectorQuery rescoreQuery = (RescoreKnnVectorQuery) query;
-        KnnFloatVectorQuery knnQuery = (KnnFloatVectorQuery) rescoreQuery.innerQuery();
-        assertThat("Unexpected total results", rescoreQuery.k(), equalTo(expectedResults));
-        assertThat("Unexpected candidates", knnQuery.getK(), equalTo(expectedCandidates));
-        if (knnQuery instanceof ESKnnFloatVectorQuery esKnnFloatVectorQuery) {
-            assertThat("Unexpected k parameter", esKnnFloatVectorQuery.kParam(), equalTo(expectedK));
+        Query innerQuery = rescoreQuery.innerQuery();
+        if (innerQuery instanceof PatienceKnnVectorQuery patienceKnnVectorQuery) {
+            assertThat("Unexpected candidates", patienceKnnVectorQuery.getK(), equalTo(expectedCandidates));
+        } else {
+            ESKnnFloatVectorQuery knnQuery = (ESKnnFloatVectorQuery) innerQuery;
+            assertThat("Unexpected total results", rescoreQuery.k(), equalTo(expectedResults));
+            assertThat("Unexpected candidates", knnQuery.getK(), equalTo(expectedCandidates));
+            assertThat("Unexpected k parameter", knnQuery.kParam(), equalTo(expectedK));
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,10 @@ public class DenseVectorFieldMapper extends FieldMapper {`
`117`	`117`	`public static final String COSINE_MAGNITUDE_FIELD_SUFFIX = "._magnitude";`
`118`	`118`	`private static final float EPS = 1e-3f;`
`119`	`119`	`public static final int BBQ_MIN_DIMS = 64;`
	`120`	`+`
	`121`	`+ // early termination configuration`
`120`	`122`	`private static final String EARLY_EXIT_PARAM_NAME = "early_exit";`
	`123`	`+ private static final boolean DEFAULT_EARLY_EXIT = false;`
`121`	`124`
`122`	`125`	`public static boolean isNotUnitVector(float magnitude) {`
`123`	`126`	`return Math.abs(magnitude - 1.0f) > EPS;`
`@@ -1426,7 +1429,7 @@ public IndexOptions parseIndexOptions(String fieldName, Map<String, ?> indexOpti`
`1426`	`1429`	`efConstructionNode = Lucene99HnswVectorsFormat.DEFAULT_BEAM_WIDTH;`
`1427`	`1430`	`}`
`1428`	`1431`	`if (earlyExitNode == null) {`
`1429`		`- earlyExitNode = true;`
	`1432`	`+ earlyExitNode = DEFAULT_EARLY_EXIT;`
`1430`	`1433`	`}`
`1431`	`1434`	`int m = XContentMapValues.nodeIntegerValue(mNode);`
`1432`	`1435`	`int efConstruction = XContentMapValues.nodeIntegerValue(efConstructionNode);`
`@@ -1704,7 +1707,7 @@ boolean updatableTo(IndexOptions update) {`
`1704`	`1707`
`1705`	`1708`	`@Override`
`1706`	`1709`	`boolean earlyExit() {`
`1707`		`- return false;`
	`1710`	`+ return DEFAULT_EARLY_EXIT;`
`1708`	`1711`	`}`
`1709`	`1712`	`}`
`1710`	`1713`
`@@ -1737,7 +1740,7 @@ boolean updatableTo(IndexOptions update) {`
`1737`	`1740`
`1738`	`1741`	`@Override`
`1739`	`1742`	`boolean earlyExit() {`
`1740`		`- return false;`
	`1743`	`+ return DEFAULT_EARLY_EXIT;`
`1741`	`1744`	`}`
`1742`	`1745`
`1743`	`1746`	`@Override`
`@@ -1758,7 +1761,7 @@ static class Int4HnswIndexOptions extends QuantizedIndexOptions {`
`1758`	`1761`	`private final boolean earlyExit;`
`1759`	`1762`
`1760`	`1763`	`Int4HnswIndexOptions(int m, int efConstruction, Float confidenceInterval, RescoreVector rescoreVector) {`
`1761`		`- this(m, efConstruction, confidenceInterval, rescoreVector, true);`
	`1764`	`+ this(m, efConstruction, confidenceInterval, rescoreVector, DEFAULT_EARLY_EXIT);`
`1762`	`1765`	`}`
`1763`	`1766`
`1764`	`1767`	`Int4HnswIndexOptions(int m, int efConstruction, Float confidenceInterval, RescoreVector rescoreVector, boolean earlyExit) {`
`@@ -1896,7 +1899,7 @@ boolean updatableTo(IndexOptions update) {`
`1896`	`1899`
`1897`	`1900`	`@Override`
`1898`	`1901`	`boolean earlyExit() {`
`1899`		`- return false;`
	`1902`	`+ return DEFAULT_EARLY_EXIT;`
`1900`	`1903`	`}`
`1901`	`1904`
`1902`	`1905`	`}`
`@@ -1908,7 +1911,7 @@ public static class Int8HnswIndexOptions extends QuantizedIndexOptions {`
`1908`	`1911`	`private final boolean earlyExit;`
`1909`	`1912`
`1910`	`1913`	`public Int8HnswIndexOptions(int m, int efConstruction, Float confidenceInterval, RescoreVector rescoreVector) {`
`1911`		`- this(m, efConstruction, confidenceInterval, rescoreVector, true);`
	`1914`	`+ this(m, efConstruction, confidenceInterval, rescoreVector, DEFAULT_EARLY_EXIT);`
`1912`	`1915`	`}`
`1913`	`1916`
`1914`	`1917`	`public Int8HnswIndexOptions(int m, int efConstruction, Float confidenceInterval, RescoreVector rescoreVector, boolean earlyExit) {`
`@@ -2002,7 +2005,7 @@ static class HnswIndexOptions extends IndexOptions {`
`2002`	`2005`	`private final boolean earlyExit;`
`2003`	`2006`
`2004`	`2007`	`HnswIndexOptions(int m, int efConstruction) {`
`2005`		`- this(m, efConstruction, true);`
	`2008`	`+ this(m, efConstruction, DEFAULT_EARLY_EXIT);`
`2006`	`2009`	`}`
`2007`	`2010`
`2008`	`2011`	`HnswIndexOptions(int m, int efConstruction, boolean earlyExit) {`