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

ML Commons Neural Embeddings Tutorial update #9536

Merged
merged 5 commits into from
Apr 3, 2025

Conversation

chloewqg
Copy link
Contributor

@chloewqg chloewqg commented Mar 31, 2025

Description

Update the Ingest Pipeline Setup for TextEmbeddingProcessor for desired behavior.

Issues Resolved

Closes opensearch-project/neural-search#1243

Version

2.19 and above

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

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
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, @chloewqg!

@kolchfa-aws
Copy link
Collaborator

@chloewqg Should we also list this change in https://opensearch.org/docs/latest/breaking-changes/? Also, are any other pages in the https://opensearch.org/docs/latest/vector-search/ai-search/index/ section affected by this?

@chloewqg
Copy link
Contributor Author

chloewqg commented Apr 2, 2025

@chloewqg Should we also list this change in https://opensearch.org/docs/latest/breaking-changes/? Also, are any other pages in the https://opensearch.org/docs/latest/vector-search/ai-search/index/ section affected by this?

Sure. I updated the breaking change document. Please take a look. For your second question, I took a look at the current five tutorials, none of them are using nested value like this and thus we don't need to update them

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, @chloewqg! Does my suggestion convey the desired meaning?

chloewqg and others added 2 commits April 2, 2025 16:09
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Chloe Gao <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Chloe Gao <[email protected]>
@kolchfa-aws kolchfa-aws added the 5 - Editorial review PR: Editorial review in progress label Apr 3, 2025
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 @chloewqg One minor addition. Thanks!

@kolchfa-aws kolchfa-aws removed the 5 - Editorial review PR: Editorial review in progress label Apr 3, 2025
@kolchfa-aws kolchfa-aws merged commit 9c40730 into opensearch-project:main Apr 3, 2025
5 checks passed
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.19 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.19 2.19
# Navigate to the new working tree
pushd ../.worktrees/backport-2.19
# Create a new branch
git switch --create backport/backport-9536-to-2.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9c407303435e7d68bcd218c65d3e961f7a3603bb
# Push it to GitHub
git push --set-upstream origin backport/backport-9536-to-2.19
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.19

Then, create a pull request where the base branch is 2.19 and the compare/head branch is backport/backport-9536-to-2.19.

@kolchfa-aws kolchfa-aws mentioned this pull request Apr 3, 2025
1 task
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.

[BUG] Breaking change in the text-embedding processor
3 participants