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

[PROPOSAL] Add/enhance educational materials related to usage of queries and processors maintained in this repo #948

Open
martin-gaievski opened this issue Oct 21, 2024 · 2 comments
Assignees
Labels
Documentation Update existing documentations such as README, instruction docs, etc.

Comments

@martin-gaievski
Copy link
Member

What/Why

What are you proposing?

As a user I would like to have access to more documentation and examples of neural search components, like neural/hybrid queries and different processor types.
This should help to speedup the ramp-up for new features and provide better self-service in scenarios like "why document X has that low/high score".

What users have asked for this feature?

For example, our main page for hybrid query https://opensearch.org/docs/latest/search-plugins/hybrid-search/#using-hybrid-search does have some examples for weights, but it's not explicitly stated how user can identify those weights in the actual system.
Another example would be the details of how scores are compute in hybrid query depending on distribution of documents, number of shards/replicas/data nodes, size of requested documents in sub-query etc. Ideally it can be something visual and interactive, maybe blog (good example is recently published blog https://opensearch.org/blog/How-does-the-rank-normalization-work-in-hybrid-search/).

@martin-gaievski martin-gaievski added the Documentation Update existing documentations such as README, instruction docs, etc. label Oct 21, 2024
@vibrantvarun
Copy link
Member

Thanks @martin-gaievski for creating this issue.

@epugh
Copy link

epugh commented Oct 30, 2024

I raised a similar comment about the amazing content in the blogs that should be better linked into the docs: https://opensearch.slack.com/archives/C052GAV1MQF/p1727441107926029

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Update existing documentations such as README, instruction docs, etc.
Projects
None yet
Development

No branches or pull requests

4 participants