[Feature] Support for Default Model Id #337

vibrantvarun · 2023-09-25T20:02:49Z

Description

This PR provides a functionality to client to skip passing model id in the neural search query request.

Issues Resolved

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed as per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Varun Jain <[email protected]>

codecov · 2023-09-26T20:32:52Z

Codecov Report

Merging #337 (ce28954) into main (7bef7a0) will increase coverage by 0.05%.
Report is 1 commits behind head on main.
The diff coverage is 87.50%.

@@             Coverage Diff              @@
##               main     #337      +/-   ##
============================================
+ Coverage     84.56%   84.62%   +0.05%     
- Complexity      427      445      +18     
============================================
  Files            35       38       +3     
  Lines          1289     1333      +44     
  Branches        189      199      +10     
============================================
+ Hits           1090     1128      +38     
- Misses          118      119       +1     
- Partials         81       86       +5

Files	Coverage Δ
...rch/neuralsearch/util/NeuralSearchClusterUtil.java	`100.00% <100.00%> (ø)`
...g/opensearch/neuralsearch/plugin/NeuralSearch.java	`71.42% <50.00%> (-2.26%)`	⬇️
...search/processor/NeuralQueryEnricherProcessor.java	`92.85% <92.85%> (ø)`
...nsearch/neuralsearch/query/NeuralQueryBuilder.java	`88.88% <91.66%> (-0.13%)`	⬇️
...search/query/visitor/NeuralSearchQueryVisitor.java	`76.92% <76.92%> (ø)`

navneet1v · 2023-09-26T21:47:27Z

@vibrantvarun remove the skip changelog tag and put the info in change log.

navneet1v · 2023-09-26T21:47:49Z

@vibrantvarun fill the checklist too

navneet1v · 2023-09-26T21:49:07Z

@vibrantvarun add documentation on all public classes and public functions

src/main/java/org/opensearch/neuralsearch/query/visitor/NeuralSearchQueryVisitor.java

src/main/java/org/opensearch/neuralsearch/util/NeuralSearchClusterUtil.java

Signed-off-by: Varun Jain <[email protected]>

navneet1v · 2023-09-28T21:02:53Z

@vibrantvarun can we fix the github action: codecov/patch and codecov/project

seems like the coverage has dropped

Signed-off-by: Varun Jain <[email protected]>

martin-gaievski

few minor things, over looks good

martin-gaievski · 2023-09-29T03:16:18Z

src/test/java/org/opensearch/neuralsearch/processor/NeuralQueryProcessorTests.java

+
+public class NeuralQueryProcessorTests extends OpenSearchTestCase {
+
+    public void testFactory() throws Exception {


please use naming convention from other tests - whatYouTesting_conditions_expectation, I think may be optional sometimes, when it's obvious, but other two are must

martin-gaievski · 2023-09-29T03:16:43Z

src/test/java/org/opensearch/neuralsearch/processor/NeuralQueryProcessorTests.java

+        assertEquals("vasdcvkcjkbldbjkd", processor.getModelId());
+        assertEquals("bahbkcdkacb", processor.getNeuralFieldDefaultIdMap().get("fieldName").toString());
+
+        // Missing "query" parameter:


why do we need this?

To check exception

martin-gaievski · 2023-09-29T03:18:13Z

src/test/java/org/opensearch/neuralsearch/processor/NeuralQueryProcessorTests.java

+        expectThrows(IllegalArgumentException.class, () -> factory.create(Collections.emptyMap(), null, null, false, configMap, null));
+    }
+
+    public void testProcessRequest() throws Exception {


nit: you can use @SneakyThrow for exceptions in tests

martin-gaievski · 2023-09-29T03:24:45Z

src/main/java/org/opensearch/neuralsearch/processor/NeuralQueryProcessor.java

+ */
+@Setter
+@Getter
+public class NeuralQueryProcessor extends AbstractProcessor implements SearchRequestProcessor {


I would rename class to something closer to a processor type name, although I left the final call to you

Signed-off-by: Varun Jain <[email protected]>

navneet1v · 2023-09-29T17:27:39Z

src/main/java/org/opensearch/neuralsearch/processor/EnrichingQueryDefaultProcessor.java

+    /**
+     * Key to reference this processor type from a search pipeline.
+     */
+    public static final String TYPE = "enriching_query_defaults";


neural_query_enricher name seems better here

@martin-gaievski I am finally going with neural_query_enricher

agree, that sounds reasonable, please update the class with that new name

navneet1v · 2023-09-29T17:28:06Z

src/main/java/org/opensearch/neuralsearch/processor/EnrichingQueryDefaultProcessor.java

+        ) throws IllegalArgumentException {
+            String modelId;
+            try {
+                modelId = (String) config.remove(DEFAULT_MODEL_ID);


why config.remove?

Took reference from OS core

navneet1v · 2023-09-29T17:29:26Z

src/main/java/org/opensearch/neuralsearch/processor/EnrichingQueryDefaultProcessor.java

+        ) throws IllegalArgumentException {
+            String modelId;
+            try {
+                modelId = (String) config.remove(DEFAULT_MODEL_ID);


There is a better way to get the string. Check this: https://github.com/opensearch-project/neural-search/blob/main/src/main/java/org/opensearch/neuralsearch/processor/factory/TextEmbeddingProcessorFactory.java#L40C9-L40C89

navneet1v · 2023-09-29T17:38:33Z

src/main/java/org/opensearch/neuralsearch/plugin/NeuralSearch.java

@@ -80,6 +80,7 @@ public Collection<Object> createComponents(
        final IndexNameExpressionResolver indexNameExpressionResolver,
        final Supplier<RepositoriesService> repositoriesServiceSupplier
    ) {
+        NeuralSearchClusterUtil.instance().initialize(clusterService);


We should start getting rid of these kind of inits and move towards singleton pattern without this kind of inits.

May be an AI for maintainers

src/test/java/org/opensearch/neuralsearch/processor/EnrichingQueryDefaultProcessorIT.java

navneet1v · 2023-09-29T17:41:51Z

src/test/resources/processor/IndexMappings.json

+      },
+      "passage_embedding": {
+        "type": "knn_vector",
+        "dimension": 768
+      },
+      "passage_text": {
+        "type": "text"


why we need these new fields? why we cannot use older fields?

Because they don't have text matching

do we need text matching?

yeah i wrote a test case where I am passing querytext as hello world. If I don't add this field here then it will fail

Signed-off-by: Varun Jain <[email protected]>

opensearch-trigger-bot · 2023-09-29T19:37:40Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-337-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9c37b0e9dbaac0c4607385c728196f36164f705d
# Push it to GitHub
git push --set-upstream origin backport/backport-337-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-337-to-2.x.

* Support for default Model Id Signed-off-by: Varun Jain <[email protected]> * Support for Default Model id Signed-off-by: Varun Jain <[email protected]> * Support for default model Id Signed-off-by: Varun Jain <[email protected]> * Removing wildcard Imports Signed-off-by: Varun Jain <[email protected]> * Typo fix Signed-off-by: Varun Jain <[email protected]> * Integ test cases Signed-off-by: Varun Jain <[email protected]> * Fixing Integ Test case Signed-off-by: Varun Jain <[email protected]> * Addressing Comments Signed-off-by: Varun Jain <[email protected]> * Added Visitor test cases and addressed comments Signed-off-by: Varun Jain <[email protected]> * Comments Addressed of Jack Signed-off-by: Varun Jain <[email protected]> * Addressed changes requested by Martin Signed-off-by: Varun Jain <[email protected]> * Addressed changes requested by Martin Signed-off-by: Varun Jain <[email protected]> * Fixing test cases Signed-off-by: Varun Jain <[email protected]> * Increasing test coverage Signed-off-by: Varun Jain <[email protected]> * Renaming and addressing comments of Martin Signed-off-by: Varun Jain <[email protected]> * Addressing Comments of Navneet Signed-off-by: Varun Jain <[email protected]> * Updating tests Signed-off-by: Varun Jain <[email protected]> --------- Signed-off-by: Varun Jain <[email protected]>

Signed-off-by: Varun Jain <[email protected]>

* [Feature] Support for Default Model Id (#337) Signed-off-by: Varun Jain <[email protected]>

martin-gaievski · 2023-10-03T19:09:52Z

src/test/resources/processor/IndexMappings.json

+      },
+      "passage_embedding": {
+        "type": "knn_vector",
+        "dimension": 768


this need to have a lucene as engine, otherwise it uses default which is nmslib and that fails, as nmslib is not part of the knn zip fopr integ tests @vibrantvarun

Where is this field used by the way?

vibrantvarun added 3 commits August 23, 2023 13:29

Support for default Model Id

dac5012

Signed-off-by: Varun Jain <[email protected]>

Support for Default Model id

6903f94

Signed-off-by: Varun Jain <[email protected]>

rebasing

88ba2e9

Signed-off-by: Varun Jain <[email protected]>

vibrantvarun requested review from heemin32, navneet1v, VijayanB, vamshin, jmazanec15, naveentatikonda, junqiu-lei, martin-gaievski, sean-zheng-amazon, model-collapse, wujunshen, zane-neo, ylwu-amzn and jngz-es as code owners September 25, 2023 20:02

Support for default model Id

c06d07a

Signed-off-by: Varun Jain <[email protected]>

vibrantvarun added the skip-changelog label Sep 26, 2023

vibrantvarun added 4 commits September 25, 2023 17:57

Removing wildcard Imports

7c3a302

Signed-off-by: Varun Jain <[email protected]>

Typo fix

dee67ca

Signed-off-by: Varun Jain <[email protected]>

Integ test cases

b13eb80

Signed-off-by: Varun Jain <[email protected]>

Fixing Integ Test case

badced1

Signed-off-by: Varun Jain <[email protected]>

vibrantvarun removed the skip-changelog label Sep 26, 2023

navneet1v reviewed Sep 26, 2023

View reviewed changes

Addressing Comments

9c010e7

Signed-off-by: Varun Jain <[email protected]>

vibrantvarun requested review from martin-gaievski and navneet1v September 28, 2023 19:48

vibrantvarun added 2 commits September 28, 2023 13:01

Addressed changes requested by Martin

e9efd72

Signed-off-by: Varun Jain <[email protected]>

Fixing test cases

ff10aba

Signed-off-by: Varun Jain <[email protected]>

Increasing test coverage

c3d0649

Signed-off-by: Varun Jain <[email protected]>

martin-gaievski reviewed Sep 29, 2023

View reviewed changes

Renaming and addressing comments of Martin

ef5f939

Signed-off-by: Varun Jain <[email protected]>

vibrantvarun requested a review from martin-gaievski September 29, 2023 17:23

navneet1v reviewed Sep 29, 2023

View reviewed changes

src/test/java/org/opensearch/neuralsearch/processor/EnrichingQueryDefaultProcessorIT.java Outdated Show resolved Hide resolved

navneet1v reviewed Sep 29, 2023

View reviewed changes

vibrantvarun added 2 commits September 29, 2023 11:21

Addressing Comments of Navneet

29017ba

Signed-off-by: Varun Jain <[email protected]>

Updating tests

ce28954

Signed-off-by: Varun Jain <[email protected]>

vibrantvarun requested a review from navneet1v September 29, 2023 18:26

martin-gaievski approved these changes Sep 29, 2023

View reviewed changes

navneet1v approved these changes Sep 29, 2023

View reviewed changes

navneet1v merged commit 9c37b0e into opensearch-project:main Sep 29, 2023
16 checks passed

vibrantvarun deleted the Default-Processor branch September 29, 2023 19:37

vibrantvarun added a commit to vibrantvarun/neural-search that referenced this pull request Sep 29, 2023

[Backport 2.x] Support for Default Model Id (opensearch-project#337)

ce50d03

Signed-off-by: Varun Jain <[email protected]>

vibrantvarun mentioned this pull request Sep 29, 2023

[Backport 2.x] [Feature] Support for Default Model Id #365

Merged

5 tasks

martin-gaievski pushed a commit that referenced this pull request Oct 3, 2023

[Backport 2.x] [Feature] Support for Default Model Id (#365)

8d749b8

* [Feature] Support for Default Model Id (#337) Signed-off-by: Varun Jain <[email protected]>

martin-gaievski reviewed Oct 3, 2023

View reviewed changes

This was referenced Feb 22, 2024

[FEATURE] support default model id in neural_sparse query #610

Closed

[Fix] add non-null check for queryBuilder in NeuralQueryEnricherProcessor #615

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature] Support for Default Model Id #337

[Feature] Support for Default Model Id #337

vibrantvarun commented Sep 25, 2023 •

edited

Loading

codecov bot commented Sep 26, 2023 •

edited

Loading

navneet1v commented Sep 26, 2023

navneet1v commented Sep 26, 2023

navneet1v commented Sep 26, 2023

navneet1v commented Sep 28, 2023

martin-gaievski left a comment

martin-gaievski Sep 29, 2023

martin-gaievski Sep 29, 2023

vibrantvarun Sep 29, 2023

martin-gaievski Sep 29, 2023

martin-gaievski Sep 29, 2023

navneet1v Sep 29, 2023

vibrantvarun Sep 29, 2023

martin-gaievski Sep 29, 2023

navneet1v Sep 29, 2023

vibrantvarun Sep 29, 2023

navneet1v Sep 29, 2023

navneet1v Sep 29, 2023

navneet1v Sep 29, 2023

vibrantvarun Sep 29, 2023

navneet1v Sep 29, 2023

vibrantvarun Sep 29, 2023

opensearch-trigger-bot bot commented Sep 29, 2023

martin-gaievski Oct 3, 2023

heemin32 Oct 3, 2023


		public class NeuralQueryProcessorTests extends OpenSearchTestCase {

		public void testFactory() throws Exception {

[Feature] Support for Default Model Id #337

[Feature] Support for Default Model Id #337

Conversation

vibrantvarun commented Sep 25, 2023 • edited Loading

Description

Issues Resolved

Check List

codecov bot commented Sep 26, 2023 • edited Loading

Codecov Report

navneet1v commented Sep 26, 2023

navneet1v commented Sep 26, 2023

navneet1v commented Sep 26, 2023

navneet1v commented Sep 28, 2023

martin-gaievski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Sep 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vibrantvarun commented Sep 25, 2023 •

edited

Loading

codecov bot commented Sep 26, 2023 •

edited

Loading