Introduce Ml Inference Search Request Extension #3284

mingshl · 2024-12-16T23:29:14Z

Description

Introduce Ml Inference Search Request Extension, this is adding ml_inference search extension during search request/query phase,

For the search response side, I already introduced a ml_inference search response extension in earlier PR released in 2.18. Support ML Inference Search Processor Writing to Search Extension

Related Issues

#3286
#3054

Check List

New functionality includes testing.
New functionality has been documented.
API changes companion pull request created.
Commits are signed per the DCO using --signoff.
Public documentation issue/PR created.

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.

dhrubo-os · 2024-12-16T23:31:28Z

@mingshl let's take the update from main. File has conflict.

mingshl · 2024-12-17T19:49:08Z

thanks @dhrubo-os ， rebased and resolved conflicts.

dhrubo-os · 2024-12-30T22:37:02Z

Tests are failing

mingshl · 2024-12-30T22:40:18Z

Tests are failing

there is no changes related to ConversationalMemory, will try rerun the tests.

> Task :opensearch-ml-memory:test

ConversationalMemoryHandlerITTests > testDifferentUsers_DifferentConversations FAILED
    java.lang.NoClassDefFoundError at ConversationalMemoryHandlerITTests.java:389
        Caused by: java.lang.ClassNotFoundException at ConversationalMemoryHandlerITTests.java:389

mingshl · 2024-12-31T06:34:50Z

rebased and resolved conflicts.

dhrubo-os · 2024-12-31T15:08:56Z

D:\a\ml-commons\ml-commons\common\build\generated\sources\delombok\java\main\org\opensearch\ml\common\utils\StringUtils.java:379: error: unknown tag: implNote
     * @implNote This method uses JsonPath for JSON manipulation and StringUtils for path existence checks.
       ^

plugin/src/main/java/org/opensearch/ml/processor/MLInferenceSearchRequestProcessor.java

plugin/src/main/java/org/opensearch/ml/processor/ModelExecutor.java

plugin/src/main/java/org/opensearch/ml/searchext/MLInferenceRequestParametersExtBuilder.java

plugin/src/main/java/org/opensearch/ml/searchext/MLInferenceRequestParametersUtil.java

austintlee · 2025-01-17T23:32:15Z

Looks good overall, but can you add REST test cases with some non trivial examples?

common/src/main/java/org/opensearch/ml/common/utils/StringUtils.java

dhrubo-os · 2025-01-24T22:18:04Z

memory/build.gradle

@@ -41,6 +41,7 @@ dependencies {
    testImplementation("com.fasterxml.jackson.core:jackson-annotations:${versions.jackson}")
    testImplementation("com.fasterxml.jackson.core:jackson-databind:${versions.jackson_databind}")
    testImplementation group: 'com.networknt' , name: 'json-schema-validator', version: '1.4.0'
+    testImplementation 'com.jayway.jsonpath:json-path:2.9.0'


Just curious why do we need this here? I don't see any tests in memory module.

if I remove this dependency, it's throwing error in the build

ConversationMetaIndexITTests > testConversationsCanBeDeleted FAILED java.lang.NoClassDefFoundError at ConversationMetaIndexITTests.java:268 Caused by: java.lang.ExceptionInInitializerError at IndexUtils.java:126 ConversationMetaIndexITTests > testCanQueryOverConversations FAILED java.lang.NoClassDefFoundError at ConversationMetaIndexITTests.java:431 Caused by: java.lang.ExceptionInInitializerError at IndexUtils.java:126 ConversationMetaIndexITTests > testCanGetAConversationById FAILED java.lang.NoClassDefFoundError at ConversationMetaIndexITTests.java:539 Caused by: java.lang.ExceptionInInitializerError at IndexUtils.java:126 ConversationMetaIndexITTests > testCanQueryOverConversationsByAdditionalInfo FAILED java.lang.NoClassDefFoundError at ConversationMetaIndexITTests.java:679 Caused by: java.lang.ExceptionInInitializerError at IndexUtils.java:126 ConversationMetaIndexITTests > testCanAddNewConversation FAILED java.lang.NoClassDefFoundError at ConversationMetaIndexITTests.java:152 Caused by: java.lang.ExceptionInInitializerError at IndexUtils.java:126

dhrubo-os · 2025-01-24T22:19:11Z

plugin/src/main/java/org/opensearch/ml/processor/MLInferenceSearchRequestProcessor.java

@@ -219,13 +226,15 @@ private void rewriteQueryString(SearchRequest request, String queryString, Actio
     * @param queryString      the original query string
     * @param requestListener  the {@link ActionListener} to be notified when the query string or query template is updated
     * @param processOutputMap the list of output mappings
+     * @param requestContext


add a description?

added and rebased

plugin/src/main/java/org/opensearch/ml/processor/MLInferenceSearchRequestProcessor.java

plugin/src/main/java/org/opensearch/ml/processor/ModelExecutor.java

plugin/src/main/java/org/opensearch/ml/searchext/MLInferenceRequestParametersUtil.java

Signed-off-by: Mingshi Liu <[email protected]>

…uest body Signed-off-by: Mingshi Liu <[email protected]>

Signed-off-by: Mingshi Liu <[email protected]>

mingshl · 2025-01-25T06:12:41Z

Looks good overall, but can you add REST test cases with some non trivial examples?

I added two REST tests to verify in the new commit add REST test and javadoc and just rebased the changes from main branch

codecov · 2025-01-25T08:26:30Z

Codecov Report

Attention: Patch coverage is 71.14094% with 43 lines in your changes missing coverage. Please review.

Project coverage is 80.30%. Comparing base (f28bb74) to head (0960694).
Report is 173 commits behind head on main.

Files with missing lines	Patch %	Lines
...va/org/opensearch/ml/common/utils/StringUtils.java	51.11%	19 Missing and 3 partials ⚠️
...l/processor/MLInferenceSearchRequestProcessor.java	68.00%	5 Missing and 3 partials ⚠️
...ava/org/opensearch/ml/processor/ModelExecutor.java	58.82%	5 Missing and 2 partials ⚠️
...ml/searchext/MLInferenceRequestParametersUtil.java	75.00%	1 Missing and 3 partials ⚠️
...rg/opensearch/ml/plugin/MachineLearningPlugin.java	50.00%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #3284      +/-   ##
============================================
- Coverage     81.31%   80.30%   -1.01%     
- Complexity     6094     6713     +619     
============================================
  Files           573      602      +29     
  Lines         25268    28974    +3706     
  Branches       2666     3213     +547     
============================================
+ Hits          20547    23269    +2722     
- Misses         3601     4327     +726     
- Partials       1120     1378     +258

Flag	Coverage Δ
ml-commons	`80.30% <71.14%> (-1.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mingshl requested review from b4sjoo, dhrubo-os, jngz-es, model-collapse, rbhavna, ylwu-amzn, zane-neo, Zhangxunmt, austintlee, HenryL27 and xinyual as code owners December 16, 2024 23:29

mingshl had a problem deploying to ml-commons-cicd-env-require-approval December 16, 2024 23:29 — with GitHub Actions Failure

mingshl force-pushed the feature/ml-inference-search-extension branch from b2504c4 to d5f7605 Compare December 17, 2024 19:45

mingshl had a problem deploying to ml-commons-cicd-env-require-approval December 17, 2024 19:45 — with GitHub Actions Failure

mingshl changed the title ~~Introduce Ml Inference Search Extension~~ Introduce Ml Inference Search Request Extension Dec 17, 2024

mingshl mentioned this pull request Dec 17, 2024

[DOC] Introduce Ml Inference Search Request Extension opensearch-project/documentation-website#8968

Open

3 tasks

mingshl had a problem deploying to ml-commons-cicd-env-require-approval December 30, 2024 22:40 — with GitHub Actions Failure

mingshl had a problem deploying to ml-commons-cicd-env-require-approval December 31, 2024 00:36 — with GitHub Actions Failure

mingshl force-pushed the feature/ml-inference-search-extension branch from d5f7605 to cfa8a38 Compare December 31, 2024 06:29

mingshl had a problem deploying to ml-commons-cicd-env-require-approval December 31, 2024 06:30 — with GitHub Actions Failure

mingshl force-pushed the feature/ml-inference-search-extension branch from 9c576ec to 3cf89dc Compare December 31, 2024 22:34

mingshl requested a deployment to ml-commons-cicd-env-require-approval December 31, 2024 22:34 — with GitHub Actions Waiting

mingshl force-pushed the feature/ml-inference-search-extension branch from 3cf89dc to 037fd7f Compare December 31, 2024 22:39

mingshl temporarily deployed to ml-commons-cicd-env-require-approval December 31, 2024 22:40 — with GitHub Actions Inactive

mingshl temporarily deployed to ml-commons-cicd-env-require-approval January 2, 2025 20:33 — with GitHub Actions Inactive

martin-gaievski reviewed Jan 3, 2025

View reviewed changes

mingshl had a problem deploying to ml-commons-cicd-env-require-approval January 16, 2025 06:03 — with GitHub Actions Failure

mingshl temporarily deployed to ml-commons-cicd-env-require-approval January 16, 2025 06:03 — with GitHub Actions Inactive

mingshl temporarily deployed to ml-commons-cicd-env-require-approval January 16, 2025 23:47 — with GitHub Actions Inactive

mingshl temporarily deployed to ml-commons-cicd-env-require-approval January 17, 2025 20:23 — with GitHub Actions Inactive

dhrubo-os reviewed Jan 24, 2025

View reviewed changes

common/src/main/java/org/opensearch/ml/common/utils/StringUtils.java Outdated Show resolved Hide resolved

dhrubo-os reviewed Jan 24, 2025

View reviewed changes

plugin/src/main/java/org/opensearch/ml/processor/MLInferenceSearchRequestProcessor.java Show resolved Hide resolved

dhrubo-os reviewed Jan 24, 2025

View reviewed changes

plugin/src/main/java/org/opensearch/ml/processor/ModelExecutor.java Show resolved Hide resolved

dhrubo-os reviewed Jan 24, 2025

View reviewed changes

plugin/src/main/java/org/opensearch/ml/searchext/MLInferenceRequestParametersUtil.java Show resolved Hide resolved

mingshl added 4 commits January 24, 2025 20:57

add ml inference search extension

ccc7f38

Signed-off-by: Mingshi Liu <[email protected]>

pass search extension to pipeline context

c72e7a5

Signed-off-by: Mingshi Liu <[email protected]>

allow write to requestContext when outputmap's key not present in req…

368f1af

…uest body Signed-off-by: Mingshi Liu <[email protected]>

add REST test and javadoc

0960694

Signed-off-by: Mingshi Liu <[email protected]>

mingshl force-pushed the feature/ml-inference-search-extension branch from d23f14c to 0960694 Compare January 25, 2025 06:11

mingshl had a problem deploying to ml-commons-cicd-env January 25, 2025 06:12 — with GitHub Actions Failure

mingshl temporarily deployed to ml-commons-cicd-env January 25, 2025 06:12 — with GitHub Actions Inactive

mingshl temporarily deployed to ml-commons-cicd-env January 25, 2025 07:26 — with GitHub Actions Inactive

mingshl temporarily deployed to ml-commons-cicd-env January 25, 2025 08:26 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce Ml Inference Search Request Extension #3284

Introduce Ml Inference Search Request Extension #3284

mingshl commented Dec 16, 2024 •

edited

Loading

dhrubo-os commented Dec 16, 2024

mingshl commented Dec 17, 2024

dhrubo-os commented Dec 30, 2024

mingshl commented Dec 30, 2024

mingshl commented Dec 31, 2024

dhrubo-os commented Dec 31, 2024

austintlee commented Jan 17, 2025

dhrubo-os Jan 24, 2025

mingshl Jan 25, 2025

dhrubo-os Jan 24, 2025

mingshl Jan 25, 2025

mingshl commented Jan 25, 2025

codecov bot commented Jan 25, 2025 •

edited

Loading

Introduce Ml Inference Search Request Extension #3284

Are you sure you want to change the base?

Introduce Ml Inference Search Request Extension #3284

Conversation

mingshl commented Dec 16, 2024 • edited Loading

Description

Related Issues

Check List

dhrubo-os commented Dec 16, 2024

mingshl commented Dec 17, 2024

dhrubo-os commented Dec 30, 2024

mingshl commented Dec 30, 2024

mingshl commented Dec 31, 2024

dhrubo-os commented Dec 31, 2024

austintlee commented Jan 17, 2025

dhrubo-os Jan 24, 2025

Choose a reason for hiding this comment

mingshl Jan 25, 2025

Choose a reason for hiding this comment

dhrubo-os Jan 24, 2025

Choose a reason for hiding this comment

mingshl Jan 25, 2025

Choose a reason for hiding this comment

mingshl commented Jan 25, 2025

codecov bot commented Jan 25, 2025 • edited Loading

Codecov Report

mingshl commented Dec 16, 2024 •

edited

Loading

codecov bot commented Jan 25, 2025 •

edited

Loading