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

Update Semantic Search Tutorial to Use Elasticsearch Service and Remove References to Deprecated ELSER Service #117826

Merged
merged 10 commits into from
Dec 9, 2024

Conversation

eshaffer321
Copy link

Added a deprecation warning to the “Tutorial: semantic search with semantic_text” to inform users that the elser service is deprecated as of version 8.16 and will be removed in a future release. The warning advises users to use the Elasticsearch inference service with model_id in service_settings instead. This update aligns the tutorial with the existing deprecation notice on the ELSER documentation page, ensuring clarity for users following the tutorial.

[x] Have you signed the contributor license agreement?
[x] Have you followed the contributor guidelines?
[N/A] If submitting code, have you built your formula locally prior to submission with gradle check?
[N/A] If submitting code, is your pull request against main? Unless there is a good reason otherwise, we prefer pull requests against main and will backport as needed.
[N/A] If submitting code, have you checked that your submission is for an OS and architecture that we support?
[N/A] If you are submitting this code for a class then read our policy for that.

Added a deprecation warning to the “Tutorial: semantic search with semantic_text” to inform users that the elser service is deprecated as of version 8.16 and will be removed in a future release. The warning advises users to use the Elasticsearch inference service with model_id in service_settings instead. This update aligns the tutorial with the existing deprecation notice on the ELSER documentation page, ensuring clarity for users following the tutorial.
Copy link
Contributor

github-actions bot commented Dec 2, 2024

Documentation preview:

@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label v8.16.2 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Dec 2, 2024
@eshaffer321
Copy link
Author

Issue raised here
#117829

Copy link
Member

@maxhniebergall maxhniebergall left a comment

Choose a reason for hiding this comment

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

I think that rather than using a deprecation warning here, we should just change this tutorial to use the elasticsearch service. There is an example of this here: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elasticsearch.html#inference-example-elasticsearch-elser

@eshaffer321
Copy link
Author

I think that rather than using a deprecation warning here, we should just change this tutorial to use the elasticsearch service. There is an example of this here: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elasticsearch.html#inference-example-elasticsearch-elser

Thank you for the feedback! I’ve updated the tutorial to use the Elasticsearch service as suggested and removed the deprecation warning. Please let me know if there’s anything else you’d like adjusted.

@eshaffer321 eshaffer321 changed the title Add deprecation warning for ELSER in semantic search tutorial Update Semantic Search Tutorial to Use Elasticsearch Service and Remove References to Deprecated ELSER Service Dec 3, 2024
@PeteGillinElastic PeteGillinElastic added :ml Machine learning and removed needs:triage Requires assignment of a team area label labels Dec 5, 2024
@elasticsearchmachine elasticsearchmachine added the Team:ML Meta label for the ML team label Dec 5, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/ml-core (Team:ML)

@maxhniebergall maxhniebergall added >docs General docs changes v9.0.0 v8.17.1 labels Dec 6, 2024
@maxhniebergall maxhniebergall self-assigned this Dec 6, 2024
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Dec 6, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@leemthompo
Copy link
Contributor

@elasticmachine run elasticsearch-ci/docs

@leemthompo leemthompo added auto-backport Automatically create backport pull requests when merged v8.18.0 labels Dec 9, 2024
@leemthompo
Copy link
Contributor

run docs-build

Copy link
Member

@maxhniebergall maxhniebergall left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for iterating!

@maxhniebergall maxhniebergall merged commit 73b1418 into elastic:8.16 Dec 9, 2024
6 checks passed
@maxhniebergall
Copy link
Member

maxhniebergall commented Dec 9, 2024

We will also need to add PRs to add this change to other other branches: main, 8.17, 8.x.

@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
main Commit could not be cherrypicked due to conflicts
8.17 Commit could not be cherrypicked due to conflicts
8.x Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 117826

@elasticsearchmachine
Copy link
Collaborator

@maxhniebergall according to this PR's labels, it should not have a changelog YAML, but I can't delete it because it is closed. Please either delete the changelog from the appropriate branch yourself, or adjust the labels.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged backport pending >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team :ml Machine learning Team:Docs Meta label for docs team Team:ML Meta label for the ML team v8.16.2 v8.17.1 v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants