Added Conversation API in MLClient

[owaiskazi19]

Description

Added Conversation API in MLClient

Issues Resolved

[List any issues this PR will resolve]

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed 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.

[owaiskazi19]

@dhrubo-os @jngz-es @rbhavna can you take a look? Thanks

[dhrubo-os]

Let's add a test.

[dhrubo-os]

Just curious to know if we should mark this as shadow?

[owaiskazi19]

Memory package doesn't have a publishing task that's why @jngz-es suggested to keep it like this.

[codecov]

Codecov Report

Attention: Patch coverage is 55.55556% with 8 lines in your changes are missing coverage. Please review.

Project coverage is 81.89%. Comparing base (c233356) to head (1e74bab).

❗ Current head 1e74bab differs from pull request most recent head 03d19b1. Consider uploading reports for the commit 03d19b1 to get more accurate results

Files	Patch %	Lines
...ction/conversation/CreateConversationResponse.java	0.00%	8 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #2211      +/-   ##
============================================
- Coverage     81.91%   81.89%   -0.02%     
- Complexity     5719     5724       +5     
============================================
  Files           547      547              
  Lines         23064    23082      +18     
  Branches       2378     2378              
============================================
+ Hits          18892    18903      +11     
- Misses         3227     3235       +8     
+ Partials        945      944       -1     

Flag	Coverage Δ
ml-commons	81.89% <55.55%> (-0.02%)	⬇️

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.

[ylwu-amzn]

I don't think we should add this API. We should create a new conversation automatically when conversation id not set.

[amitgalitz]

Oh okay @ylwu-amzn so if we want users to be able to do one click creation for conversation use case with some defaults for demo/poc purpose, we can just skip this step and not give rag processor the conversation ID?

[austintlee]

I think you do want the ability to give conversations human-readable names.

cc: @HenryL27

[amitgalitz]

The main reason I am currently adding this is so we can have default use cases ready to go for conversational search opensearch-project/flow-framework#588

We want to be able to do something like setting up the whole e2e with just:

http://localhost:9200/_plugins/_flow_framework/workflow?use_case=conversationl_search&provision=true
{
    "create_connector.credential.key" : "123"
}

all fields can be overriden but at least for easy poc/dev I thought it would be useful,

If we have some nice human-readable name in the processor for memory will it even be seen. I was thinking this part creates the memory id to give here, not conversation ID:

GET /my_rag_test_data/_search
{
 "query": {
   "match": {
     "text": "What's the population of NYC metro area in 2023"
   }
 },
 "ext": {
   "generative_qa_parameters": {
     "llm_model": "gpt-3.5-turbo",
     "llm_question": "What's the population of NYC metro area in 2023",
     "memory_id": "znCqcI0BfUsSoeNTntd7",
     "context_size": 5,
     "message_size": 5,
     "timeout": 15
   }
 }
}

[HenryL27]

I was thinking this part creates the memory id to give here, not conversation ID

memory=conversation. message=interaction. Sorry about the confusion here... we probably need to rename the internal classes to match the API names.

[Zhangxunmt]

Yes, we need to follow the new names. Use Memory to replace Conversation, and Message to replace Interaction. Can you update based on the API name in the doc https://opensearch.org/docs/latest/ml-commons-plugin/api/memory-apis/create-memory?

[HenryL27]

Do you wanna add any more APIs than just "CreateConversation" / "CreateMemory"? Also @Zhangxunmt which name scheme we going with?

[Zhangxunmt]

Yes, we need to follow the new names. Use Memory to replace Conversation, and Message to replace Interaction.

[austintlee]

@owaiskazi19 Do you want to try to get this into 2.18?