Update knn query parameter expand_nested_docs tp expand_nested and up…

…date the change log. Signed-off-by: Bo Zhang <bzhangam@amazon.com>
opensearch-project · Dec 16, 2024 · 07ddbc0 · 07ddbc0
1 parent c515587
commit 07ddbc0
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Features
 ### Enhancements
 - Set neural-search plugin 3.0.0 baseline JDK version to JDK-2 ([#838](https://github.com/opensearch-project/neural-search/pull/838))
-- Support new knn query parameter expand_nested_docs ([#1008](https://github.com/opensearch-project/neural-search/issues/1008))
 ### Bug Fixes
 - Fix for nested field missing sub embedding field in text embedding processor ([#913](https://github.com/opensearch-project/neural-search/pull/913))
 ### Infrastructure
@@ -18,6 +17,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ## [Unreleased 2.x](https://github.com/opensearch-project/neural-search/compare/2.18...2.x)
 ### Features
 ### Enhancements
+- Support new knn query parameter expand_nested_docs ([#1013](https://github.com/opensearch-project/neural-search/pull/1013))
 ### Bug Fixes
 -  Address inconsistent scoring in hybrid query results ([#998](https://github.com/opensearch-project/neural-search/pull/998))
 ### Infrastructure

diff --git a/qa/restart-upgrade/src/test/java/org/opensearch/neuralsearch/bwc/HybridSearchIT.java b/qa/restart-upgrade/src/test/java/org/opensearch/neuralsearch/bwc/HybridSearchIT.java
@@ -127,7 +127,7 @@ private HybridQueryBuilder getQueryBuilder(
         neuralQueryBuilder.queryText(QUERY);
         neuralQueryBuilder.k(5);
         if (expandNestedDocs != null) {
-            neuralQueryBuilder.expandNestedDocs(expandNestedDocs);
+            neuralQueryBuilder.expandNested(expandNestedDocs);
         }
         if (methodParameters != null) {
             neuralQueryBuilder.methodParameters(methodParameters);

diff --git a/qa/rolling-upgrade/src/test/java/org/opensearch/neuralsearch/bwc/HybridSearchIT.java b/qa/rolling-upgrade/src/test/java/org/opensearch/neuralsearch/bwc/HybridSearchIT.java
@@ -134,7 +134,7 @@ private HybridQueryBuilder getQueryBuilder(
         neuralQueryBuilder.queryText(QUERY);
         neuralQueryBuilder.k(5);
         if (expandNestedDocs != null) {
-            neuralQueryBuilder.expandNestedDocs(expandNestedDocs);
+            neuralQueryBuilder.expandNested(expandNestedDocs);
         }
         if (methodParameters != null) {
             neuralQueryBuilder.methodParameters(methodParameters);

diff --git a/src/main/java/org/opensearch/neuralsearch/query/NeuralQueryBuilder.java b/src/main/java/org/opensearch/neuralsearch/query/NeuralQueryBuilder.java
@@ -99,7 +99,7 @@ public static void initialize(MLCommonsClientAccessor mlClient) {
     private Integer k = null;
     private Float maxDistance = null;
     private Float minScore = null;
-    private Boolean expandNestedDocs;
+    private Boolean expandNested;
     @VisibleForTesting
     @Getter(AccessLevel.PACKAGE)
     @Setter(AccessLevel.PACKAGE)
@@ -135,7 +135,7 @@ public NeuralQueryBuilder(StreamInput in) throws IOException {
             this.minScore = in.readOptionalFloat();
         }
         if (isClusterOnOrAfterMinReqVersion(EXPAND_NESTED_FIELD.getPreferredName())) {
-            this.expandNestedDocs = in.readOptionalBoolean();
+            this.expandNested = in.readOptionalBoolean();
         }
         if (isClusterOnOrAfterMinReqVersion(METHOD_PARAMS_FIELD.getPreferredName())) {
             this.methodParameters = MethodParametersParser.streamInput(in, MinClusterVersionUtil::isClusterOnOrAfterMinReqVersion);
@@ -164,7 +164,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
             out.writeOptionalFloat(this.minScore);
         }
         if (isClusterOnOrAfterMinReqVersion(EXPAND_NESTED_FIELD.getPreferredName())) {
-            out.writeOptionalBoolean(this.expandNestedDocs);
+            out.writeOptionalBoolean(this.expandNested);
         }
         if (isClusterOnOrAfterMinReqVersion(METHOD_PARAMS_FIELD.getPreferredName())) {
             MethodParametersParser.streamOutput(out, methodParameters, MinClusterVersionUtil::isClusterOnOrAfterMinReqVersion);
@@ -192,8 +192,8 @@ protected void doXContent(XContentBuilder xContentBuilder, Params params) throws
         if (Objects.nonNull(minScore)) {
             xContentBuilder.field(MIN_SCORE_FIELD.getPreferredName(), minScore);
         }
-        if (Objects.nonNull(expandNestedDocs)) {
-            xContentBuilder.field(EXPAND_NESTED_FIELD.getPreferredName(), expandNestedDocs);
+        if (Objects.nonNull(expandNested)) {
+            xContentBuilder.field(EXPAND_NESTED_FIELD.getPreferredName(), expandNested);
         }
         if (Objects.nonNull(methodParameters)) {
             MethodParametersParser.doXContent(xContentBuilder, methodParameters);
@@ -286,7 +286,7 @@ private static void parseQueryParams(XContentParser parser, NeuralQueryBuilder n
                 } else if (MIN_SCORE_FIELD.match(currentFieldName, parser.getDeprecationHandler())) {
                     neuralQueryBuilder.minScore(parser.floatValue());
                 } else if (EXPAND_NESTED_FIELD.match(currentFieldName, parser.getDeprecationHandler())) {
-                    neuralQueryBuilder.expandNestedDocs(parser.booleanValue());
+                    neuralQueryBuilder.expandNested(parser.booleanValue());
                 } else {
                     throw new ParsingException(
                         parser.getTokenLocation(),
@@ -331,7 +331,7 @@ protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext) {
                 .filter(filter())
                 .maxDistance(maxDistance)
                 .minScore(minScore)
-                .expandNested(expandNestedDocs)
+                .expandNested(expandNested)
                 .k(k)
                 .methodParameters(methodParameters)
                 .rescoreContext(rescoreContext)
@@ -360,7 +360,7 @@ protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext) {
             k(),
             maxDistance(),
             minScore(),
-            expandNestedDocs(),
+            expandNested(),
             vectorSetOnce::get,
             filter(),
             methodParameters(),

diff --git a/src/test/java/org/opensearch/neuralsearch/query/NeuralQueryBuilderTests.java b/src/test/java/org/opensearch/neuralsearch/query/NeuralQueryBuilderTests.java
@@ -232,7 +232,7 @@ public void testFromXContent_whenBuiltWithOptionals_thenBuildSuccessfully() {
         assertEquals(K, neuralQueryBuilder.k());
         assertEquals(BOOST, neuralQueryBuilder.boost(), 0.0);
         assertEquals(QUERY_NAME, neuralQueryBuilder.queryName());
-        assertEquals(Boolean.TRUE, neuralQueryBuilder.expandNestedDocs());
+        assertEquals(Boolean.TRUE, neuralQueryBuilder.expandNested());
     }
 
     @SneakyThrows
@@ -432,7 +432,7 @@ public void testToXContent() {
             .modelId(MODEL_ID)
             .queryText(QUERY_TEXT)
             .k(K)
-            .expandNestedDocs(Boolean.TRUE)
+            .expandNested(Boolean.TRUE)
             .filter(TEST_FILTER);
 
         XContentBuilder builder = XContentFactory.jsonBuilder();
@@ -724,7 +724,7 @@ public void testRewrite_whenVectorNull_thenReturnCopy() {
             .queryImage(IMAGE_TEXT)
             .modelId(MODEL_ID)
             .k(K)
-            .expandNestedDocs(Boolean.TRUE)
+            .expandNested(Boolean.TRUE)
             .vectorSupplier(nullSupplier);
         QueryBuilder queryBuilder = neuralQueryBuilder.doRewrite(null);
         assertEquals(neuralQueryBuilder, queryBuilder);
@@ -736,7 +736,7 @@ public void testRewrite_whenVectorSupplierAndVectorSet_thenReturnKNNQueryBuilder
             .queryImage(IMAGE_TEXT)
             .modelId(MODEL_ID)
             .k(K)
-            .expandNestedDocs(Boolean.TRUE)
+            .expandNested(Boolean.TRUE)
             .methodParameters(Map.of("ef_search", 100))
             .rescoreContext(RescoreContext.getDefault())
             .vectorSupplier(TEST_VECTOR_SUPPLIER);