Skip to content
New issue

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

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

Already on GitHub? # to your account

[Serverless]: Update the semantic search section in the docs #61

Closed
szabosteve opened this issue Sep 27, 2024 · 2 comments
Closed

[Serverless]: Update the semantic search section in the docs #61

szabosteve opened this issue Sep 27, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation Serverless bug bash 🐛 Issues discovered during the Serverless UX bug bash

Comments

@szabosteve
Copy link
Contributor

Serverless Docs

Elasticsearch

Description

  1. Update the semantic search page under the Search your data section. A lot has happened in the semantic search domain since this page was updated, the latest changes are available in the classic docs.

  2. Add a semantic_text tutorial next to the ELSER tutorial as a subpage of the semantic search page.

Resources and additional context

Source of information:

@szabosteve szabosteve added documentation Improvements or additions to documentation Serverless bug bash 🐛 Issues discovered during the Serverless UX bug bash labels Sep 27, 2024
@kosabogi
Copy link
Contributor

The documentation team will be making a decision this week on our approach to handling cases where documentation would potentially be duplicated on serverless. We are considering whether to maintain deployment-specific guides or consolidate content to avoid redundancy. Once a decision is made, I'll proceed with the necessary updates and move this issue forward accordingly.

@kosabogi
Copy link
Contributor

To avoid duplication, we decided to remove redundant content from the Serverless documentation and add a page with links and descriptions for existing tutorials in the Elasticsearch documentation.

After restructuring, the Semantic search page now has the following structure:

  • Semantic search: Introduction, description, a list of recommended workflows, and a link to the guide in the Elasticsearch documentation.
  • Semantic search with the inference API workflow: Introduction, description, and a link to the guide in the Elasticsearch documentation.
  • Semantic search with semantic_text workflow: Introduction, description, and a link to the guide in the Elasticsearch documentation.
  • Semantic search with a deployed model workflow: Introduction, description, and a link to the guide in the Elasticsearch documentation.

Updated documentation: Semantic search

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation Serverless bug bash 🐛 Issues discovered during the Serverless UX bug bash
Projects
None yet
Development

No branches or pull requests

3 participants