Add Cohere Chat blueprint with RAG #1991

tianjing-li · 2024-02-02T15:22:24Z

Description

[Describe what this change achieves]

Adds a new Cohere Chat connector blueprint

Issues Resolved

[List any issues this PR will resolve]
N/A

Check List

No new functionality, just new docs

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.

codecov · 2024-02-02T15:48:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (521b880) 82.94% compared to head (d9a8b3f) 82.92%.
Report is 41 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1991      +/-   ##
============================================
- Coverage     82.94%   82.92%   -0.02%     
+ Complexity     5414     5412       -2     
============================================
  Files           521      521              
  Lines         21713    21713              
  Branches       2215     2215              
============================================
- Hits          18009    18005       -4     
- Misses         2808     2811       +3     
- Partials        896      897       +1

Flag	Coverage Δ
ml-commons	`82.92% <ø> (-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.

tianjing-li · 2024-02-05T20:10:16Z

@ylwu-amzn also updated this new doc with some of the suggestions from the Embed one. Take a look when you get a chance, many thanks.

ylwu-amzn · 2024-02-07T00:13:54Z

docs/remote_inference_blueprints/cohere_connector_chat_blueprint.md

+
+This blueprint will show you how to connect a Cohere chat model to your Opensearch cluster. You will require a Cohere API key to create a connector.
+
+It is suggested to use the default `command` model for using Chat. Cohere's Chat endpoint also features Retrievel Augmented Generation (or RAG) parameters, by adding `connectors` or `documents` in your request body, in addition to allowing you to pass a `conversation_id` to provide context to Cohere's model. 


by adding connectors or documents in your request body

I think you mean Cohere connectors here, right?

Yes correct, Cohere connectors - there should be text earlier linking docs and explaining the difference, but I can clarify that here as well

ylwu-amzn · 2024-02-07T19:50:02Z

docs/remote_inference_blueprints/cohere_connector_chat_blueprint.md

+POST /_plugins/_ml/models/<MODEL_ID_HERE>/_predict
+{
+  "parameters": {
+    "message": "What is the weather like in London?",


Make sure the example in this doc can work

Suggested change

"message": "What is the weather like in London?",

"message": "What is the weather like in London?"

ylwu-amzn · 2024-02-07T19:50:53Z

docs/remote_inference_blueprints/cohere_connector_chat_blueprint.md

+        "Authorization": "Bearer ${credential.cohere_key}",
+        "Request-Source": "unspecified:opensearch"
+      },
+      "request_body": "{ \"message\": ${parameters.message}, \"model\": \"${parameters.model}\" }"


Suggested change

"request_body": "{ \"message\": ${parameters.message}, \"model\": \"${parameters.model}\" }"

"request_body": "{ \"message\": \"${parameters.message}\", \"model\": \"${parameters.model}\" }"

ylwu-amzn · 2024-02-12T18:57:11Z

@tianjing-li You can refer to this tutorial for how to use Cohere command model in RAG pipeline #2075

tianjing-li · 2024-02-13T15:25:09Z

@ylwu-amzn thank you!

* Add Chat blueprint with RAG * Remove content-type * Updates * Update docs (cherry picked from commit 38566f5)

* Add Chat blueprint with RAG * Remove content-type * Updates * Update docs (cherry picked from commit 38566f5) Co-authored-by: Tianjing Li <[email protected]>

* Add Chat blueprint with RAG * Remove content-type * Updates * Update docs

Add Chat blueprint with RAG

399ce90

tianjing-li requested review from b4sjoo, dhrubo-os, jngz-es, model-collapse, rbhavna, ylwu-amzn, zane-neo, Zhangxunmt, austintlee and HenryL27 as code owners February 2, 2024 15:22

tianjing-li temporarily deployed to ml-commons-cicd-env February 2, 2024 15:22 — with GitHub Actions Inactive

tianjing-li changed the title ~~Add Chat blueprint with RAG~~ Add Cohere Chat blueprint with RAG Feb 2, 2024

tianjing-li temporarily deployed to ml-commons-cicd-env February 2, 2024 15:22 — with GitHub Actions Inactive

Remove content-type

5cb81e5

tianjing-li temporarily deployed to ml-commons-cicd-env February 2, 2024 15:23 — with GitHub Actions Inactive

tianjing-li temporarily deployed to ml-commons-cicd-env February 2, 2024 15:50 — with GitHub Actions Inactive

Updates

3605b92

tianjing-li temporarily deployed to ml-commons-cicd-env February 5, 2024 19:22 — with GitHub Actions Inactive

tianjing-li temporarily deployed to ml-commons-cicd-env February 5, 2024 19:50 — with GitHub Actions Inactive

tianjing-li had a problem deploying to ml-commons-cicd-env February 5, 2024 19:50 — with GitHub Actions Failure

tianjing-li temporarily deployed to ml-commons-cicd-env February 5, 2024 19:50 — with GitHub Actions Inactive

Update docs

d9a8b3f

tianjing-li had a problem deploying to ml-commons-cicd-env February 6, 2024 17:55 — with GitHub Actions Error

tianjing-li had a problem deploying to ml-commons-cicd-env February 6, 2024 17:55 — with GitHub Actions Failure

tianjing-li temporarily deployed to ml-commons-cicd-env February 6, 2024 17:56 — with GitHub Actions Inactive

tianjing-li temporarily deployed to ml-commons-cicd-env February 6, 2024 18:23 — with GitHub Actions Inactive

ylwu-amzn reviewed Feb 7, 2024

View reviewed changes

ylwu-amzn approved these changes Feb 8, 2024

View reviewed changes

Zhangxunmt approved these changes Feb 8, 2024

View reviewed changes

jngz-es merged commit 38566f5 into opensearch-project:main Feb 13, 2024
10 of 14 checks passed

tianjing-li mentioned this pull request Feb 13, 2024

Add updated Cohere blueprints to connector blueprints section opensearch-project/documentation-website#6396

Merged

1 task

ylwu-amzn added the backport 2.x label Feb 29, 2024

opensearch-trigger-bot bot pushed a commit that referenced this pull request Feb 29, 2024

Add Cohere Chat blueprint with RAG (#1991)

a41e479

* Add Chat blueprint with RAG * Remove content-type * Updates * Update docs (cherry picked from commit 38566f5)

opensearch-trigger-bot bot mentioned this pull request Feb 29, 2024

[Backport 2.x] Add Cohere Chat blueprint with RAG #2168

Merged

dhrubo-os pushed a commit that referenced this pull request Feb 29, 2024

Add Cohere Chat blueprint with RAG (#1991) (#2168)

d6c67b4

* Add Chat blueprint with RAG * Remove content-type * Updates * Update docs (cherry picked from commit 38566f5) Co-authored-by: Tianjing Li <[email protected]>

austintlee pushed a commit to austintlee/ml-commons that referenced this pull request Mar 19, 2024

Add Cohere Chat blueprint with RAG (opensearch-project#1991)

ea714b3

* Add Chat blueprint with RAG * Remove content-type * Updates * Update docs

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Cohere Chat blueprint with RAG #1991

Add Cohere Chat blueprint with RAG #1991

tianjing-li commented Feb 2, 2024

codecov bot commented Feb 2, 2024 •

edited

Loading

tianjing-li commented Feb 5, 2024

ylwu-amzn Feb 7, 2024

tianjing-li Feb 7, 2024

ylwu-amzn Feb 7, 2024

ylwu-amzn Feb 7, 2024

ylwu-amzn commented Feb 12, 2024

tianjing-li commented Feb 13, 2024


		This blueprint will show you how to connect a Cohere chat model to your Opensearch cluster. You will require a Cohere API key to create a connector.

		It is suggested to use the default `command` model for using Chat. Cohere's Chat endpoint also features Retrievel Augmented Generation (or RAG) parameters, by adding `connectors` or `documents` in your request body, in addition to allowing you to pass a `conversation_id` to provide context to Cohere's model.

	"message": "What is the weather like in London?",
	"message": "What is the weather like in London?"

	"request_body": "{ \"message\": ${parameters.message}, \"model\": \"${parameters.model}\" }"
	"request_body": "{ \"message\": \"${parameters.message}\", \"model\": \"${parameters.model}\" }"

Add Cohere Chat blueprint with RAG #1991

Add Cohere Chat blueprint with RAG #1991

Conversation

tianjing-li commented Feb 2, 2024

Description

Issues Resolved

Check List

codecov bot commented Feb 2, 2024 • edited Loading

Codecov Report

tianjing-li commented Feb 5, 2024

ylwu-amzn Feb 7, 2024

Choose a reason for hiding this comment

tianjing-li Feb 7, 2024

Choose a reason for hiding this comment

ylwu-amzn Feb 7, 2024

Choose a reason for hiding this comment

ylwu-amzn Feb 7, 2024

Choose a reason for hiding this comment

ylwu-amzn commented Feb 12, 2024

tianjing-li commented Feb 13, 2024

codecov bot commented Feb 2, 2024 •

edited

Loading