opensearch-project / documentation-website

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.
https://opensearch.org/docs
Apache License 2.0
68 stars 473 forks source link

[DOC] Update Cohere Connector documentation (v3 and PQ guidance) #6648

Open dylan-tong-aws opened 6 months ago

dylan-tong-aws commented 6 months ago

What do you want to do?

Tell us about your request. Provide a summary of the request and all versions that are affected.

Update the Cohere connector documentation: https://opensearch.org/docs/latest/ml-commons-plugin/remote-models/connectors/#cohere-connector

  1. Update the blueprint to use the latest version for cohere embed v3. Please work with @ylwu-amzn to obtain the latest blueprint. I can't find it in Github, and there are no examples in the documentation.

  2. Add a section for PQ support guidance:

Cohere embed v3 has been tuned for IVF PQ index support (https://opensearch.org/docs/latest/search-plugins/knn/knn-index/#supported-faiss-encoders). The following default parameters should work well:

code_size=8 Cohere recommend m=256 (for a 16x compression) or m=128 (for a 32x compression).

As similarity_metric, cohere has tested and tuned the model inner product

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

ylwu-amzn commented 6 months ago

Cohere embed blueprint (v2 and v3): https://github.com/opensearch-project/ml-commons/blob/2.x/docs/remote_inference_blueprints/cohere_connector_embedding_blueprint.md

hdhalter commented 6 months ago

Thanks, @dylan-tong-aws and @ylwu-amzn ! Is this connected to a release?

ylwu-amzn commented 6 months ago

Cohere Connector documentation

This part is not for 2.13 release. It's just a doc for released feature.

hdhalter commented 6 months ago

This PR addresses the first item above: https://github.com/opensearch-project/documentation-website/pull/6671

hdhalter commented 6 months ago

The first item is merged. I'm working with jmazane on the second item.

hdhalter commented 5 months ago

@jmazanec15 - Did we address #2 above?