opensearch-docs-cn/_ml-commons-plugin/remote-models/connectors.md

307 lines
14 KiB
Markdown
Raw Normal View History

Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
---
layout: default
Add multimodal search/sparse search/pre- and post-processing function documentation (#5168) * Add multimodal search documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Text image embedding processor Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add prerequisite Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change query text Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added bedrock connector tutorial and renamed ML TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Name changes and rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change connector link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Link fix and field name fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add default text embedding preprocessing and post-processing functions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add sparse search documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Pre/post processing function tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Sparse search tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented doc review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add actual test sparse pipeline response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added tested examples Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added model choice for sparse search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove Bedrock connector Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add that the model must be deployed to neural search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Link fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add session token to sagemaker blueprint Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Formatted bullet points the same way Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Specified both model types in neural sparse query Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added more explanation for default pre/post-processing functions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove framework and extensibility references Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Minor rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-10-16 10:45:35 -04:00
title: Connectors
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
has_children: false
Add multimodal search/sparse search/pre- and post-processing function documentation (#5168) * Add multimodal search documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Text image embedding processor Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add prerequisite Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change query text Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added bedrock connector tutorial and renamed ML TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Name changes and rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change connector link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Link fix and field name fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add default text embedding preprocessing and post-processing functions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add sparse search documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Pre/post processing function tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Sparse search tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented doc review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add actual test sparse pipeline response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added tested examples Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added model choice for sparse search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove Bedrock connector Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add that the model must be deployed to neural search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Link fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add session token to sagemaker blueprint Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Formatted bullet points the same way Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Specified both model types in neural sparse query Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added more explanation for default pre/post-processing functions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove framework and extensibility references Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Minor rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-10-16 10:45:35 -04:00
has_toc: false
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
nav_order: 61
parent: Connecting to externally hosted models
Add an overview of search methods and pages for each search method (#5636) * Restructuring TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More foundational rewrites of ML Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * TOC restructure Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename and rewrite search pages and add keyword search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Small rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Move neural search to top of vector search list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change terminology Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reorganize search methods list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More link renames Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-11-29 15:28:20 -05:00
grand_parent: Integrating ML models
redirect_from:
Add agent framework/throttling/hidden model/OS assistant and update conversational search documentation (#6354) * Add agent framework documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add hidden model and API updates Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Vale error Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated field names Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add updating credentials Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added tools table Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add OpenSearch forum thread for OS Assistant Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add tech review for conv search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add tools Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add links to tools Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More info about tools Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tool parameters Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update cat-index-tool.md Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Parameter clarification Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Typo fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More tech review feedback: RAG tool Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review feedback: memory APis Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _ml-commons-plugin/agents-tools/index.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _ml-commons-plugin/opensearch-assistant.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _ml-commons-plugin/agents-tools/tools/ppl-tool.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Separated search and get APIs and add conversational flow agent Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More parameters for PPL tool Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added more parameters Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review feedback: PPL tool Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Rename to automating configurations Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Editorial comments on the new text Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add parameter to PPl tool Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Changed link to configurations Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rate limiter feedback and added warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2024-02-20 12:09:31 -05:00
- /ml-commons-plugin/extensibility/connectors/
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
---
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
# Creating connectors for third-party ML platforms
**Introduced 2.9**
{: .label .label-purple }
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
Connectors facilitate access to models hosted on third-party machine learning (ML) platforms.
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
OpenSearch provides connectors for several platforms, for example:
- [Amazon SageMaker](https://aws.amazon.com/sagemaker/) allows you to host and manage the lifecycle of text embedding models, powering semantic search queries in OpenSearch. When connected, Amazon SageMaker hosts your models and OpenSearch is used to query inferences. This benefits Amazon SageMaker users who value its functionality, such as model monitoring, serverless hosting, and workflow automation for continuous training and deployment.
- [OpenAI ChatGPT](https://openai.com/blog/chatgpt) enables you to invoke an OpenAI chat model from inside an OpenSearch cluster.
- [Cohere](https://cohere.com/) allows you to use data from OpenSearch to power the Cohere large language models.
- [Amazon Bedrock](https://aws.amazon.com/bedrock/) supports models like [Bedrock Titan Embeddings](https://aws.amazon.com/bedrock/titan/), which can drive semantic search and retrieval-augmented generation in OpenSearch.
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
## Connector blueprints
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
A _connector blueprint_ defines the set of parameters (the request body) you need to provide when sending an API request to create a specific connector. Connector blueprints may differ based on the platform and the model that you are accessing.
OpenSearch provides connector blueprints for several ML platforms and models. For a full list of connector blueprints provided by OpenSearch, see [Supported connectors](#supported-connectors).
As an ML developer, you can also create connector blueprints for other platforms and models. Data scientists and administrators can then use the blueprint to create connectors. They are only required to enter their `credential` settings, such as `openAI_key`, for the service to which they are connecting. For information about creating connector blueprints, including descriptions of all parameters, see [Connector blueprints]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/blueprints/).
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
## Supported connectors
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
The following table lists all connector blueprints provided by OpenSearch. Follow the links to each connector blueprint for an example request that you can use to create the connector, including all parameters, and an example Predict API request.
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
Platform | Model | Connector blueprint
:--- | :--- | :---
[Amazon Bedrock](https://aws.amazon.com/bedrock/) | [AI21 Labs Jurassic-2 Mid](https://aws.amazon.com/bedrock/jurassic/) | [Blueprint](https://github.com/opensearch-project/ml-commons/blob/2.x/docs/remote_inference_blueprints/bedrock_connector_ai21labs_jurassic_blueprint.md)
[Amazon Bedrock](https://aws.amazon.com/bedrock/) | [Anthropic Claude v2](https://aws.amazon.com/bedrock/claude/) | [Blueprint](https://github.com/opensearch-project/ml-commons/blob/2.x/docs/remote_inference_blueprints/bedrock_connector_anthropic_claude_blueprint.md)
[Amazon Bedrock](https://aws.amazon.com/bedrock/) | [Titan Text Embeddings](https://aws.amazon.com/bedrock/titan/) | [Blueprint](https://github.com/opensearch-project/ml-commons/blob/2.x/docs/remote_inference_blueprints/bedrock_connector_titan_embedding_blueprint.md)
[Amazon SageMaker](https://aws.amazon.com/sagemaker/) | Text embedding models | [Blueprint](https://github.com/opensearch-project/ml-commons/blob/2.x/docs/remote_inference_blueprints/sagemaker_connector_blueprint.md)
Update blueprint links (#6396) Clarification of Customer Comment # 20230525 (#6374) * 20230525 clarificaton for customer comment on refernes to kibana * 20230525 clarificaton for customer comment on refernes to kibana - scentance clarification --------- Add searchbp metrics to Performance Analyzer (#5390) * added searchbp metrics * Update reference.md * Update reference.md * Apply suggestions from code review --------- Add documentation for new reranking feature in 2.12 (#6368) * Create reranking.md document new reranking feature in 2.12 * Doc review and address comments * Apply suggestions from code review * Update _search-plugins/search-pipelines/rerank-processor.md * Update _search-plugins/search-pipelines/rerank-processor.md --------- Add Query Insights documentation (#6261) * Query Insights initial documentation * Doc review * update endpoints and remove exporters * Moved query insights to additional plugins section * Added installation instructions * Apply suggestions from code review * editorial comments * Resolve merge conflicts * merge conflicts and link fix * Fix link --------- Add Running a Workload (#6287) * Add Running a Workload draft * Apply suggestions from code review * Update running-workloads.md * Update _benchmark/user-guide/running-workloads.md * Fix link * Add additional missing link * Add running workloads * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Add numbered steps --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2024-02-14 10:49:56 -05:00
[Cohere](https://cohere.com/) | [Text Embedding models](https://docs.cohere.com/reference/embed) | [Blueprint](https://github.com/opensearch-project/ml-commons/blob/2.x/docs/remote_inference_blueprints/cohere_connector_embedding_blueprint.md)
[Cohere](https://cohere.com/) | [Chat models](https://docs.cohere.com/reference/chat) | [Blueprint](https://github.com/opensearch-project/ml-commons/blob/main/docs/remote_inference_blueprints/cohere_connector_chat_blueprint.md)
[OpenAI](https://openai.com/) | Chat models (for example, `gpt-3.5-turbo`) | [Blueprint](https://github.com/opensearch-project/ml-commons/blob/2.x/docs/remote_inference_blueprints/open_ai_connector_chat_blueprint.md)
[OpenAI](https://openai.com/) | Completion models (for example, `text-davinci-003`) | [Blueprint](https://github.com/opensearch-project/ml-commons/blob/2.x/docs/remote_inference_blueprints/open_ai_connector_completion_blueprint.md)
[OpenAI](https://openai.com/) | Text embedding models (for example, `text-embedding-ada-002`) | [Blueprint](https://github.com/opensearch-project/ml-commons/blob/2.x/docs/remote_inference_blueprints/openai_connector_embedding_blueprint.md)
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
## Creating a connector
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
You can provision connectors in two ways:
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
1. [Create a standalone connector](#creating-a-standalone-connector): A standalone connector can be reused and shared by multiple models but requires access to both the model and connector in OpenSearch and the third-party platform, such as OpenAI or Amazon SageMaker, that the connector is accessing. Standalone connectors are saved in a connector index.
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
2. [Create a connector for a specific externally hosted model](#creating-a-connector-for-a-specific-model): Alternatively, you can create a connector that can only be used with the model for which it was created. To access such a connector, you only need access to the model itself because the connection is established inside the model. These connectors are saved in the model index.
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
Add an overview of search methods and pages for each search method (#5636) * Restructuring TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More foundational rewrites of ML Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * TOC restructure Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename and rewrite search pages and add keyword search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Small rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Move neural search to top of vector search list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change terminology Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reorganize search methods list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More link renames Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-11-29 15:28:20 -05:00
## Creating a standalone connector
Add multimodal search/sparse search/pre- and post-processing function documentation (#5168) * Add multimodal search documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Text image embedding processor Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add prerequisite Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change query text Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added bedrock connector tutorial and renamed ML TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Name changes and rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change connector link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Link fix and field name fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add default text embedding preprocessing and post-processing functions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add sparse search documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Pre/post processing function tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Sparse search tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented doc review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add actual test sparse pipeline response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added tested examples Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added model choice for sparse search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove Bedrock connector Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add that the model must be deployed to neural search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Link fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add session token to sagemaker blueprint Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Formatted bullet points the same way Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Specified both model types in neural sparse query Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added more explanation for default pre/post-processing functions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove framework and extensibility references Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Minor rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-10-16 10:45:35 -04:00
Add an overview of search methods and pages for each search method (#5636) * Restructuring TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More foundational rewrites of ML Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * TOC restructure Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename and rewrite search pages and add keyword search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Small rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Move neural search to top of vector search list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change terminology Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reorganize search methods list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More link renames Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-11-29 15:28:20 -05:00
Standalone connectors can be used by multiple models. To create a standalone connector, send a request to the `connectors/_create` endpoint and provide all of the parameters described in [Connector blueprints]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/blueprints/):
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
```json
POST /_plugins/_ml/connectors/_create
{
"name": "OpenAI Chat Connector",
"description": "The connector to public OpenAI model service for GPT 3.5",
"version": 1,
"protocol": "http",
"parameters": {
"endpoint": "api.openai.com",
"model": "gpt-3.5-turbo"
},
"credential": {
"openAI_key": "..."
},
"actions": [
{
"action_type": "predict",
"method": "POST",
"url": "https://${parameters.endpoint}/v1/chat/completions",
"headers": {
"Authorization": "Bearer ${credential.openAI_key}"
},
"request_body": "{ \"model\": \"${parameters.model}\", \"messages\": ${parameters.messages} }"
}
]
}
```
{% include copy-curl.html %}
Add an overview of search methods and pages for each search method (#5636) * Restructuring TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More foundational rewrites of ML Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * TOC restructure Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename and rewrite search pages and add keyword search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Small rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Move neural search to top of vector search list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change terminology Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reorganize search methods list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More link renames Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-11-29 15:28:20 -05:00
## Creating a connector for a specific model
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
Add an overview of search methods and pages for each search method (#5636) * Restructuring TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More foundational rewrites of ML Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * TOC restructure Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename and rewrite search pages and add keyword search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Small rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Move neural search to top of vector search list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change terminology Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reorganize search methods list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More link renames Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-11-29 15:28:20 -05:00
To create a connector for a specific model, provide all of the parameters described in [Connector blueprints]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/blueprints/) within the `connector` object of a request to the `models/_register` endpoint:
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
```json
POST /_plugins/_ml/models/_register
{
Add an overview of search methods and pages for each search method (#5636) * Restructuring TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More foundational rewrites of ML Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * TOC restructure Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename and rewrite search pages and add keyword search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Small wording change Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Small rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Move neural search to top of vector search list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change terminology Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reorganize search methods list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rename links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More link renames Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-11-29 15:28:20 -05:00
"name": "openAI-GPT-3.5 model with a connector",
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
"function_name": "remote",
"model_group_id": "lEFGL4kB4ubqQRzegPo2",
"description": "test model",
"connector": {
"name": "OpenAI Connector",
"description": "The connector to public OpenAI model service for GPT 3.5",
"version": 1,
"protocol": "http",
"parameters": {
"endpoint": "api.openai.com",
"max_tokens": 7,
"temperature": 0,
"model": "text-davinci-003"
},
"credential": {
"openAI_key": "..."
},
"actions": [
{
"action_type": "predict",
"method": "POST",
"url": "https://${parameters.endpoint}/v1/completions",
"headers": {
"Authorization": "Bearer ${credential.openAI_key}"
},
"request_body": "{ \"model\": \"${parameters.model}\", \"prompt\": \"${parameters.prompt}\", \"max_tokens\": ${parameters.max_tokens}, \"temperature\": ${parameters.temperature} }"
}
]
}
}
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
```
Add multimodal search/sparse search/pre- and post-processing function documentation (#5168) * Add multimodal search documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Text image embedding processor Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add prerequisite Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change query text Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added bedrock connector tutorial and renamed ML TOC Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Name changes and rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change connector link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Link fix and field name fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add default text embedding preprocessing and post-processing functions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add sparse search documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Pre/post processing function tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Sparse search tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented doc review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add actual test sparse pipeline response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added tested examples Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added model choice for sparse search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove Bedrock connector Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add that the model must be deployed to neural search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Link fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add session token to sagemaker blueprint Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Formatted bullet points the same way Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Specified both model types in neural sparse query Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added more explanation for default pre/post-processing functions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove framework and extensibility references Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Minor rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-10-16 10:45:35 -04:00
{% include copy-curl.html %}
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
## Connector examples
The following sections contain examples of connectors for popular ML platforms. For a full list of supported connectors, see [Supported connectors](#supported-connectors).
### OpenAI chat connector
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
You can use the following example request to create a standalone OpenAI chat connector:
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
```json
POST /_plugins/_ml/connectors/_create
{
"name": "OpenAI Chat Connector",
"description": "The connector to public OpenAI model service for GPT 3.5",
"version": 1,
"protocol": "http",
"parameters": {
"endpoint": "api.openai.com",
"model": "gpt-3.5-turbo"
},
"credential": {
"openAI_key": "..."
},
"actions": [
{
"action_type": "predict",
"method": "POST",
"url": "https://${parameters.endpoint}/v1/chat/completions",
"headers": {
"Authorization": "Bearer ${credential.openAI_key}"
},
"request_body": "{ \"model\": \"${parameters.model}\", \"messages\": ${parameters.messages} }"
}
]
}
```
{% include copy-curl.html %}
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
### Amazon SageMaker connector
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
You can use the following example request to create a standalone Amazon SageMaker connector:
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
```json
POST /_plugins/_ml/connectors/_create
{
"name": "sagemaker: embedding",
"description": "Test connector for Sagemaker embedding model",
"version": 1,
"protocol": "aws_sigv4",
"credential": {
"access_key": "...",
"secret_key": "...",
"session_token": "..."
},
"parameters": {
"region": "us-west-2",
"service_name": "sagemaker"
},
"actions": [
{
"action_type": "predict",
"method": "POST",
"headers": {
"content-type": "application/json"
},
"url": "https://runtime.sagemaker.${parameters.region}.amazonaws.com/endpoints/lmi-model-2023-06-24-01-35-32-275/invocations",
"request_body": "[\"${parameters.inputs}\"]"
}
]
}
```
{% include copy-curl.html %}
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
The `credential` parameter contains the following options reserved for `aws_sigv4` authentication:
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
- `access_key`: Required. Provides the access key for the AWS instance.
- `secret_key`: Required. Provides the secret key for the AWS instance.
- `session_token`: Optional. Provides a temporary set of credentials for the AWS instance.
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
The `parameters` section requires the following options when using `aws_sigv4` authentication:
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
- `region`: The AWS Region in which the AWS instance is located.
- `service_name`: The name of the AWS service for the connector.
### Cohere connector
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
You can use the following example request to create a standalone Cohere connector:
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
```json
POST /_plugins/_ml/connectors/_create
{
"name": "<YOUR CONNECTOR NAME>",
"description": "<YOUR CONNECTOR DESCRIPTION>",
"version": "<YOUR CONNECTOR VERSION>",
"protocol": "http",
"credential": {
Update blueprint links (#6396) Clarification of Customer Comment # 20230525 (#6374) * 20230525 clarificaton for customer comment on refernes to kibana * 20230525 clarificaton for customer comment on refernes to kibana - scentance clarification --------- Add searchbp metrics to Performance Analyzer (#5390) * added searchbp metrics * Update reference.md * Update reference.md * Apply suggestions from code review --------- Add documentation for new reranking feature in 2.12 (#6368) * Create reranking.md document new reranking feature in 2.12 * Doc review and address comments * Apply suggestions from code review * Update _search-plugins/search-pipelines/rerank-processor.md * Update _search-plugins/search-pipelines/rerank-processor.md --------- Add Query Insights documentation (#6261) * Query Insights initial documentation * Doc review * update endpoints and remove exporters * Moved query insights to additional plugins section * Added installation instructions * Apply suggestions from code review * editorial comments * Resolve merge conflicts * merge conflicts and link fix * Fix link --------- Add Running a Workload (#6287) * Add Running a Workload draft * Apply suggestions from code review * Update running-workloads.md * Update _benchmark/user-guide/running-workloads.md * Fix link * Add additional missing link * Add running workloads * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Add numbered steps --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2024-02-14 10:49:56 -05:00
"cohere_key": "<YOUR COHERE API KEY HERE>"
},
"parameters": {
"model": "embed-english-v2.0",
"truncate": "END"
},
"actions": [
{
"action_type": "predict",
"method": "POST",
"url": "https://api.cohere.ai/v1/embed",
"headers": {
"Authorization": "Bearer ${credential.cohere_key}"
},
"request_body": "{ \"texts\": ${parameters.texts}, \"truncate\": \"${parameters.truncate}\", \"model\": \"${parameters.model}\" }",
"pre_process_function": "connector.pre_process.cohere.embedding",
"post_process_function": "connector.post_process.cohere.embedding"
}
]
Add ML connector edits (#4636) * Add ML connector edits Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change integrators to blueprints Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add PM feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Change connector names Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add note about which parameters are relevant to admins. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Make seperation between personas more clear Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Breakout connectors and blueprints into two pages. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix blueprint links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address additional technical feedback Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add Doc review Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-08-10 15:55:37 -04:00
}
```
{% include copy-curl.html %}
### Amazon Bedrock connector
You can use the following example request to create a standalone Amazon Bedrock connector:
```json
POST /_plugins/_ml/connectors/_create
{
"name": "Amazon Bedrock Connector: embedding",
"description": "The connector to the Bedrock Titan embedding model",
"version": 1,
"protocol": "aws_sigv4",
"parameters": {
"region": "<YOUR AWS REGION>",
"service_name": "bedrock"
},
"credential": {
"access_key": "<YOUR AWS ACCESS KEY>",
"secret_key": "<YOUR AWS SECRET KEY>",
"session_token": "<YOUR AWS SECURITY TOKEN>"
},
"actions": [
{
"action_type": "predict",
"method": "POST",
"url": "https://bedrock-runtime.us-east-1.amazonaws.com/model/amazon.titan-embed-text-v1/invoke",
"headers": {
"content-type": "application/json",
"x-amz-content-sha256": "required"
},
"request_body": "{ \"inputText\": \"${parameters.inputText}\" }",
"pre_process_function": "\n StringBuilder builder = new StringBuilder();\n builder.append(\"\\\"\");\n String first = params.text_docs[0];\n builder.append(first);\n builder.append(\"\\\"\");\n def parameters = \"{\" +\"\\\"inputText\\\":\" + builder + \"}\";\n return \"{\" +\"\\\"parameters\\\":\" + parameters + \"}\";",
"post_process_function": "\n def name = \"sentence_embedding\";\n def dataType = \"FLOAT32\";\n if (params.embedding == null || params.embedding.length == 0) {\n return params.message;\n }\n def shape = [params.embedding.length];\n def json = \"{\" +\n \"\\\"name\\\":\\\"\" + name + \"\\\",\" +\n \"\\\"data_type\\\":\\\"\" + dataType + \"\\\",\" +\n \"\\\"shape\\\":\" + shape + \",\" +\n \"\\\"data\\\":\" + params.embedding +\n \"}\";\n return json;\n "
}
]
}
```
{% include copy-curl.html %}
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
Add agent framework/throttling/hidden model/OS assistant and update conversational search documentation (#6354) * Add agent framework documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add hidden model and API updates Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Vale error Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated field names Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add updating credentials Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added tools table Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add OpenSearch forum thread for OS Assistant Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add tech review for conv search Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add tools Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add links to tools Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More info about tools Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tool parameters Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update cat-index-tool.md Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Parameter clarification Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Typo fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More tech review feedback: RAG tool Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review feedback: memory APis Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _ml-commons-plugin/agents-tools/index.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _ml-commons-plugin/opensearch-assistant.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _ml-commons-plugin/agents-tools/tools/ppl-tool.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Separated search and get APIs and add conversational flow agent Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More parameters for PPL tool Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added more parameters Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review feedback: PPL tool Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Rename to automating configurations Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Editorial comments on the new text Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add parameter to PPl tool Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Changed link to configurations Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rate limiter feedback and added warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2024-02-20 12:09:31 -05:00
## Updating connector credentials
In some cases, you may need to update credentials, like `access_key`, that you use to connect to externally hosted models. You can update credentials without undeploying the model by providing the new credentials in the following request:
```json
PUT /_plugins/_ml/models/<model_id>
{
"connector": {
"credential": {
"openAI_key": "YOUR NEW OPENAI KEY"
}
}
}
```
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
## Next steps
- To learn more about connecting to external models, see [Connecting to externally hosted models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index/).
Add Connectors and ML updates for 2.9 (#4554) * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add Connectors and ML updates for 2.9 Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix code block Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add connector settings and examples Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add GA warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add final experimental warning Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Address tech review. Fix typos Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix bad link. Add next steps section Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Update cluster-settings.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _ml-commons-plugin/connectors.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Change cluster values for boolean. Fix typo. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix cluser settings Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add missing config options. More technical feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Adjust cluster setting description. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add updated ChatGPT example Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add info and example for internal connector. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * One last adjustment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix dead link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix one last comment. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * change ordered list to numbered. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 19:35:46 -04:00
- To learn more about model access control and model groups, see [Model access control]({{site.url}}{{site.baseurl}}/ml-commons-plugin/model-access-control/).