Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tutorial for creating Bedrock connector using Cloud Formation template #9343

Merged

Conversation

rithin-pullela-aws
Copy link
Contributor

Description

Tutorial to create bedrock connector on AWS using CFN template

Issues Resolved

Closes #[delete this text, including the brackets, and replace with the issue number]

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

github-actions bot commented Mar 4, 2025

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Copy link
Contributor

@Zhangxunmt Zhangxunmt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cfn-template.html - This is the AWS doc for reference.
Is it required to include a bedrock specific tutorial, or a tutorial for CFN integration in general for all models? I think adding a tutorial for running CFN integration that is general enough for all models are more useful.

@rithin-pullela-aws
Copy link
Contributor Author

https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cfn-template.html - This is the AWS doc for reference. Is it required to include a bedrock specific tutorial, or a tutorial for CFN integration in general for all models? I think adding a tutorial for running CFN integration that is general enough for all models are more useful.

There's already a tutorial for the SageMaker CFN here: SageMaker Connector Tutorial.

Given that the SageMaker connector documentation contains details that are not applicable to the Bedrock CFN integration, it made more sense to create a separate, Bedrock-specific guide to avoid confusion and provide clarity for the customer.

While the AWS doc is helpful, having it in OpenSearch makes it easier for customers to find everything in one place. Plus, the OpenSearch guide offers more detailed instructions than AWS.

@Zhangxunmt
Copy link
Contributor

https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cfn-template.html - This is the AWS doc for reference. Is it required to include a bedrock specific tutorial, or a tutorial for CFN integration in general for all models? I think adding a tutorial for running CFN integration that is general enough for all models are more useful.

There's already a tutorial for the SageMaker CFN here: SageMaker Connector Tutorial.

Given that the SageMaker connector documentation contains details that are not applicable to the Bedrock CFN integration, it made more sense to create a separate, Bedrock-specific guide to avoid confusion and provide clarity for the customer.

While the AWS doc is helpful, having it in OpenSearch makes it easier for customers to find everything in one place. Plus, the OpenSearch guide offers more detailed instructions than AWS.

Fair enough.

@rithin-pullela-aws
Copy link
Contributor Author

@kolchfa-aws, can you please review this PR

Signed-off-by: Fanit Kolchina <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!


1. Enter your **Amazon OpenSearch Endpoint**.
2. In the Model configuration, select a **Model** to be deployed. Choose one of the following supported models:
- `amazon.titan-embed-text-v1`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should there be a noun after "configuration", or could the sentence just start at "Select..."? Or should it be "In Model configuration..."?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The latter. I'll update

- `amazon.titan-embed-text-v2:0`
- `cohere.embed-english-v3`
- `cohere.embed-multilingual-v3`
3. Select a **Model Region** (this is the Amazon Bedrock service region).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If "service region" refers to an AWS Region, please change to "Amazon Bedrock Region".

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @rithin-pullela-aws!

Signed-off-by: Fanit Kolchina <[email protected]>
@kolchfa-aws kolchfa-aws merged commit b15ea45 into opensearch-project:main Mar 6, 2025
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 6, 2025
…plate (#9343)

* Add tutorial for creating Bedrock connector using Cloud Formation template

Signed-off-by: rithin-pullela-aws <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _vector-search/tutorials/semantic-search/semantic-search-cfn-bedrock.md

Signed-off-by: kolchfa-aws <[email protected]>

* Fix links

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: rithin-pullela-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit b15ea45)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants