Added Conversation API in MLClient #3475

owaiskazi19 · 2025-01-31T02:10:48Z

Description

Added Conversation API in MLClient

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

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.

* fix parameter name in preprocess function; fix remote model function … (opensearch-project#1362) * fix parameter name in preprocess function; fix remote model function name Signed-off-by: Yaliang Wu <[email protected]> * fix failed unit test Signed-off-by: Yaliang Wu <[email protected]> --------- Signed-off-by: Yaliang Wu <[email protected]> * throw exception when model group not found during update request (opensearch-project#1447) Signed-off-by: Bhavana Ramaram <[email protected]> * add status code to model tensor (opensearch-project#1443) (opensearch-project#1453) Signed-off-by: Yaliang Wu <[email protected]> * register new versions to a model group based on the name provided (opensearch-project#1452) Signed-off-by: Bhavana Ramaram <[email protected]> * fixing metrics correlation algorithm (opensearch-project#1448) * fixing metrics correlation algorithm Signed-off-by: Dhrubo Saha <[email protected]> * if model version fails to register, update model group accordingly (opensearch-project#1463) * if model version fails to register, update model group accordingly Signed-off-by: Bhavana Ramaram <[email protected]> * Update Model API (opensearch-project#1350) * Update Model API POC Signed-off-by: Sicheng Song <[email protected]> * Using GetRequest to get model Signed-off-by: Sicheng Song <[email protected]> * Finalize model update API Signed-off-by: Sicheng Song <[email protected]> * Fix compile Signed-off-by: Sicheng Song <[email protected]> * Fix compileTest Signed-off-by: Sicheng Song <[email protected]> * Add Unit Test Cases for Update Model API Signed-off-by: Sicheng Song <[email protected]> * Tune back test coverage thereshold Signed-off-by: Sicheng Song <[email protected]> * Add more unit tests on Update model API Signed-off-by: Sicheng Song <[email protected]> * Add unit test for TransportUpdateModelAction class Signed-off-by: Sicheng Song <[email protected]> * Fix a test error Signed-off-by: Sicheng Song <[email protected]> * Change exception thrown to failure response Signed-off-by: Sicheng Song <[email protected]> * Move the function judgement to the outter block Signed-off-by: Sicheng Song <[email protected]> * Check if model is undeployed before update model Signed-off-by: Sicheng Song <[email protected]> * Add more unit test for update model API Signed-off-by: Sicheng Song <[email protected]> * Fix unit test due to blocking java 11 CI workflow Signed-off-by: Sicheng Song <[email protected]> * Enabling auto bumping model version during registering to a new model group and address reviewers' other concern Signed-off-by: Sicheng Song <[email protected]> * Autobump new model groups' latest version when register to a new model Signed-off-by: Sicheng Song <[email protected]> * Change the REST API method from POST to PUT Signed-off-by: Sicheng Song <[email protected]> * Change the update REST API endpoint Signed-off-by: Sicheng Song <[email protected]> --------- Signed-off-by: Sicheng Song <[email protected]> * Add a setting to control the update connector API (opensearch-project#1465) * Add a setting to control the update connector API Signed-off-by: Sicheng Song <[email protected]> * Enabling the update connnector setting in unit test Signed-off-by: Sicheng Song <[email protected]> * Enabling the update connnector setting in corresponding unit test Signed-off-by: Sicheng Song <[email protected]> --------- Signed-off-by: Sicheng Song <[email protected]> * fix update connector API (opensearch-project#1484) * fix update connector API Signed-off-by: Yaliang Wu <[email protected]> * Performance enhacement for predict action by caching model info (opensearch-project#1472) (opensearch-project#1508) * Performance enhacement for predict action by caching model info Signed-off-by: zane-neo <[email protected]> * Add context.restore() to avoid missing info Signed-off-by: zane-neo <[email protected]> --------- Signed-off-by: zane-neo <[email protected]> (cherry picked from commit a985f6e) Co-authored-by: zane-neo <[email protected]> * fix failed ut from PR 1472 (opensearch-project#1479) (opensearch-project#1510) * fix failed ut from PR 1472 Signed-off-by: Yaliang Wu <[email protected]> * exclude class for low coverage Signed-off-by: Yaliang Wu <[email protected]> --------- Signed-off-by: Yaliang Wu <[email protected]> (cherry picked from commit da5d829) Co-authored-by: Yaliang Wu <[email protected]> * [Backport to 2.11] throw exception if remote model doesn't return 2xx status code; fix p… (opensearch-project#1477) (opensearch-project#1509) * throw exception if remote model doesn't return 2xx status code; fix p… (opensearch-project#1473) * throw exception if remote model doesn't return 2xx status code; fix predict runner Signed-off-by: Yaliang Wu <[email protected]> * fix kmeans model deploy bug Signed-off-by: Yaliang Wu <[email protected]> * support multiple docs for remote embedding model Signed-off-by: Yaliang Wu <[email protected]> * fix ut Signed-off-by: Yaliang Wu <[email protected]> --------- Signed-off-by: Yaliang Wu <[email protected]> * fix wrong class Signed-off-by: Yaliang Wu <[email protected]> --------- Signed-off-by: Yaliang Wu <[email protected]> (cherry picked from commit 201c8a8) Co-authored-by: Yaliang Wu <[email protected]> * fix no worker node exception for remote embedding model (opensearch-project#1482) (opensearch-project#1511) * fix no worker node exception for remote embedding model Signed-off-by: Yaliang Wu <[email protected]> * only add model info to cache if model cache exist Signed-off-by: Yaliang Wu <[email protected]> --------- Signed-off-by: Yaliang Wu <[email protected]> (cherry picked from commit 6f83b9f) Co-authored-by: Yaliang Wu <[email protected]> * fix for delete model group API throwing incorrect error when model index not created (opensearch-project#1485) (opensearch-project#1486) (opensearch-project#1512) * fix for delete model group API throwing incorrect error when model index not created Signed-off-by: Bhavana Ramaram <[email protected]> (cherry picked from commit 60ef0fd) Co-authored-by: Bhavana Ramaram <[email protected]> (cherry picked from commit 5544681) Co-authored-by: opensearch-trigger-bot[bot] <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> * fix no worker node error on multi-node cluster (opensearch-project#1487) (opensearch-project#1513) Signed-off-by: Yaliang Wu <[email protected]> (cherry picked from commit cea1cd6) Co-authored-by: Yaliang Wu <[email protected]> * add prefix to show the error is from remote service (opensearch-project#1499) (opensearch-project#1515) Signed-off-by: Yaliang Wu <[email protected]> (cherry picked from commit 3897ad1) Co-authored-by: Yaliang Wu <[email protected]> * fix multiple docs support (opensearch-project#1516) Signed-off-by: Yaliang Wu <[email protected]> * adding another fix issue to the release note (opensearch-project#1498) (opensearch-project#1514) Signed-off-by: Dhrubo Saha <[email protected]> (cherry picked from commit 440155c) Co-authored-by: Dhrubo Saha <[email protected]> * add bedrockURL to trusted connector regex list (opensearch-project#1461) Signed-off-by: Bhavana Ramaram <[email protected]> * return parsing exception 400 for parsing errors Signed-off-by: Xun Zhang <[email protected]> * add more ut in restupdateconnector Signed-off-by: Xun Zhang <[email protected]> * fix format violations Signed-off-by: Bhavana Ramaram <[email protected]> * Fix model/connector update API to address security concern (opensearch-project#1595) * Fix model/connector update API to address appsec concern Signed-off-by: Sicheng Song <[email protected]> * Fix compile and build failure Signed-off-by: Sicheng Song <[email protected]> * Improve unit test coverage Signed-off-by: Sicheng Song <[email protected]> * Fix spotless Signed-off-by: Sicheng Song <[email protected]> * Merge update connector feature flag to remote inference feature flag Signed-off-by: Sicheng Song <[email protected]> * Fix compile Signed-off-by: Sicheng Song <[email protected]> * Fix exception status Signed-off-by: Sicheng Song <[email protected]> * Keep fixing exception status Signed-off-by: Sicheng Song <[email protected]> * Spotless fix Signed-off-by: Sicheng Song <[email protected]> * Add UT on parsing exception Signed-off-by: Sicheng Song <[email protected]> --------- Signed-off-by: Sicheng Song <[email protected]> * change XContentFactory to MediaTypeRegistry builder in MLRegisterModelInputTest class Signed-off-by: Bhavana Ramaram <[email protected]> --------- Signed-off-by: Yaliang Wu <[email protected]> Signed-off-by: Bhavana Ramaram <[email protected]> Signed-off-by: Dhrubo Saha <[email protected]> Signed-off-by: Sicheng Song <[email protected]> Signed-off-by: Xun Zhang <[email protected]> Co-authored-by: Yaliang Wu <[email protected]> Co-authored-by: Dhrubo Saha <[email protected]> Co-authored-by: Sicheng Song <[email protected]> Co-authored-by: opensearch-trigger-bot[bot] <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Co-authored-by: zane-neo <[email protected]> Co-authored-by: Xun Zhang <[email protected]>

Signed-off-by: Owais <[email protected]>

dhrubo-os · 2025-01-31T02:20:46Z

Does this PR need to go with 2.19 release?

owaiskazi19 · 2025-01-31T02:24:17Z

Does this PR need to go with 2.19 release?

No hard requirement here

codecov · 2025-01-31T03:20:12Z

Codecov Report

Attention: Patch coverage is 88.88889% with 2 lines in your changes missing coverage. Please review.

Project coverage is 80.22%. Comparing base (a6eaf08) to head (c04c5b1).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...ction/conversation/CreateConversationResponse.java	75.00%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #3475      +/-   ##
============================================
- Coverage     80.24%   80.22%   -0.03%     
- Complexity     6904     6906       +2     
============================================
  Files           610      610              
  Lines         30081    30094      +13     
  Branches       3370     3368       -2     
============================================
+ Hits          24139    24142       +3     
- Misses         4491     4498       +7     
- Partials       1451     1454       +3

Flag	Coverage Δ
ml-commons	`80.22% <88.88%> (-0.03%)`	⬇️

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.

pyek-bot · 2025-01-31T21:06:04Z

client/src/main/java/org/opensearch/ml/client/MachineLearningClient.java

+
+    /**
+     * Create conversational memory for conversation
+     * @param name name of the conversation, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/memory-apis/create-memory/


nit: typo name name

pyek-bot · 2025-01-31T21:08:22Z

client/src/test/java/org/opensearch/ml/client/MachineLearningClientTest.java

@@ -107,7 +107,7 @@ public class MachineLearningClientTest {
    MLRegisterAgentResponse registerAgentResponse;

    @Mock
-    MLConfigGetResponse configGetResponse;


any particular reason for replacing this?

pyek-bot · 2025-01-31T21:10:15Z

.../test/java/org/opensearch/ml/memory/action/conversation/CreateConversationResponseTests.java

+    public void fromActionResponseWithCreateConversationResponseSuccess() {
+        CreateConversationResponse responseFromActionResponse = CreateConversationResponse.fromActionResponse(response);
+        assertEquals(response.getId(), responseFromActionResponse.getId());
+    }
+
+    @Test
+    public void fromActionResponseSuccess() {
+        ActionResponse actionResponse = new ActionResponse() {
+            @Override
+            public void writeTo(StreamOutput out) throws IOException {
+                response.writeTo(out);
+            }
+        };
+        CreateConversationResponse responseFromActionResponse = CreateConversationResponse.fromActionResponse(actionResponse);
+        assertNotSame(response, responseFromActionResponse);
+        assertEquals(response.getId(), responseFromActionResponse.getId());
+    }
+
+    @Test(expected = UncheckedIOException.class)
+    public void fromActionResponseIOException() {
+        ActionResponse actionResponse = new ActionResponse() {
+            @Override
+            public void writeTo(StreamOutput out) throws IOException {
+                throw new IOException();
+            }
+        };
+        CreateConversationResponse.fromActionResponse(actionResponse);
+    }
 }


nit: what do you think about adding test prefix to the methods to keep it consistent with the file?

rbhavna and others added 13 commits November 17, 2023 01:19

Merge branch 'opensearch-project:main' into main

309617f

Merge branch 'opensearch-project:main' into main

0b1a6e4

Merge branch 'opensearch-project:main' into main

f762a75

Merge branch 'opensearch-project:main' into main

8ef2686

Merge branch 'opensearch-project:main' into main

b16b06e

Merge branch 'opensearch-project:main' into main

499f6c4

Merge branch 'opensearch-project:main' into main

ab1e054

Merge branch 'opensearch-project:main' into main

7655c5e

Merge branch 'opensearch-project:main' into main

28bf143

Merge branch 'opensearch-project:main' into main

36bda85

Merge branch 'opensearch-project:main' into main

bfff2b4

Added Conversation API in MLClient

c04c5b1

Signed-off-by: Owais <[email protected]>

owaiskazi19 requested review from b4sjoo, dhrubo-os, mingshl, jngz-es, model-collapse, rbhavna, ylwu-amzn, zane-neo, Zhangxunmt, austintlee, HenryL27 and xinyual as code owners January 31, 2025 02:10

owaiskazi19 mentioned this pull request Jan 31, 2025

Added Conversation API in MLClient #2211

Closed

5 tasks

owaiskazi19 temporarily deployed to ml-commons-cicd-env-require-approval January 31, 2025 02:12 — with GitHub Actions Inactive

owaiskazi19 temporarily deployed to ml-commons-cicd-env-require-approval January 31, 2025 03:20 — with GitHub Actions Inactive

pyek-bot reviewed Jan 31, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Conversation API in MLClient #3475

Added Conversation API in MLClient #3475

owaiskazi19 commented Jan 31, 2025

dhrubo-os commented Jan 31, 2025

owaiskazi19 commented Jan 31, 2025

codecov bot commented Jan 31, 2025 •

edited

Loading

pyek-bot Jan 31, 2025

pyek-bot Jan 31, 2025

pyek-bot Jan 31, 2025

Added Conversation API in MLClient #3475

Are you sure you want to change the base?

Added Conversation API in MLClient #3475

Conversation

owaiskazi19 commented Jan 31, 2025

Description

Related Issues

Check List

dhrubo-os commented Jan 31, 2025

owaiskazi19 commented Jan 31, 2025

codecov bot commented Jan 31, 2025 • edited Loading

Codecov Report

pyek-bot Jan 31, 2025

Choose a reason for hiding this comment

pyek-bot Jan 31, 2025

Choose a reason for hiding this comment

pyek-bot Jan 31, 2025

Choose a reason for hiding this comment

codecov bot commented Jan 31, 2025 •

edited

Loading