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

Tutorial: Semantic Search Documentation using deprecated elser service instead of elasticsearch service #117829

Closed
eshaffer321 opened this issue Dec 2, 2024 · 7 comments · Fixed by #118007
Assignees
Labels
>docs General docs changes :ml Machine learning Team:Docs Meta label for docs team Team:ML Meta label for the ML team

Comments

@eshaffer321
Copy link

eshaffer321 commented Dec 2, 2024

The “Tutorial: semantic search with semantic_text” in the Elasticsearch documentation currently uses the ELSER model, which has been deprecated as of version 8.16. However, the tutorial does not include any deprecation warning to notify users about this status. This can lead to confusion for users following the tutorial, as they may unknowingly rely on a deprecated service.

Steps to Reproduce:

1.	Navigate to the tutorial: [Semantic Search Tutorial](https://github.com/elastic/elasticsearch/issues/link-to-tutorial-page).
2.	Observe that there is no mention of ELSER being deprecated.
3.	Compare with the [ELSER documentation](https://github.com/elastic/elasticsearch/issues/link-to-elser-page), which clearly states the deprecation notice:
The ELSER service is deprecated as of version 8.16 and will be removed in a future release. Use the Elasticsearch inference service instead, with model_id included in service_settings.

Expected Behavior:

•	The tutorial should clearly display a deprecation warning for the ELSER service.
•	The warning should guide users to use the recommended Elasticsearch inference service with model_id in service_settings as an alternative.

Suggested Fix:

	 Deprecated in 8.16
The ELSER service used in this tutorial is deprecated and will be removed in a future release. Use the Elasticsearch inference service with model_id included in service_settings instead. Refer to the [ELSER documentation](https://github.com/elastic/elasticsearch/issues/link-to-elser-page) for details.
@eshaffer321
Copy link
Author

#117826

@davidkyle davidkyle added >docs General docs changes :ml Machine learning and removed needs:triage Requires assignment of a team area label labels Dec 2, 2024
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:ML Meta label for the ML team labels Dec 2, 2024
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

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

@davidkyle
Copy link
Member

Thanks for raising this issue @eshaffer321

The elser inference service was deprecated in 8.16 in favour of the elasticsearch inference service. The examples in the docs should be updated to use "service": "elasticsearch" instead of "service": "elser". I agree this is confusing and the example API calls need to be updated.

cc @maxhniebergall

@maxhniebergall maxhniebergall changed the title Tutorial: Semantic Search Documentation Missing Deprecation Warning for ELSER Tutorial: Semantic Search Documentation using deprecated elser service instead of elasticsearch service Dec 2, 2024
@maxhniebergall
Copy link
Member

Thanks Dave. I agree we should update the tutorial. However, 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

@davidkyle
Copy link
Member

Fixed in #118007

@kosabogi
Copy link
Contributor

kosabogi commented Dec 7, 2024

Fixed in #118007

Thank you for working on this! I'll close this issue once #118007 is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :ml Machine learning Team:Docs Meta label for docs team Team:ML Meta label for the ML team
Projects
None yet
5 participants