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

[DOC] Documentation for adding aggregations support in hybrid query #6644

Closed
1 of 4 tasks
martin-gaievski opened this issue Mar 11, 2024 · 5 comments · Fixed by #6661
Closed
1 of 4 tasks

[DOC] Documentation for adding aggregations support in hybrid query #6644

martin-gaievski opened this issue Mar 11, 2024 · 5 comments · Fixed by #6661
Assignees
Labels
3 - Done Issue is done/complete v2.13.0
Milestone

Comments

@martin-gaievski
Copy link
Member

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request.
The team is enhancing the existing hybrid query clause by adding support for aggregations. Existing syntax for both hybrid query and aggregations will keep unchanged. Main change is on a backend, today hybrid query when used with aggregations will either fail or produce incorrect results.
We'd like to request change in a hybrid search section.

Functionality is aimed for 2.13 release.

What other resources are available?
RFC issue on github: opensearch-project/neural-search#604
Existing documentation for hybrid query search: https://opensearch.org/docs/latest/search-plugins/hybrid-search/
Existing documentation for aggs: https://opensearch.org/docs/latest/aggregations/

@hdhalter
Copy link
Contributor

@martin-gaievski - Does this really need a documentation change if it is only a back-end fix? Maybe it just needs to be in the release notes?

@martin-gaievski
Copy link
Member Author

@martin-gaievski - Does this really need a documentation change if it is only a back-end fix? Maybe it just needs to be in the release notes?

I think we need to add a statement to the documentation page stating that aggregations are fully supported in hybrid queries. Although there are no changes in the UI or API, this feature is highly demanded by customers. @vamshin what do you think, are release notes enough?

@vamshin
Copy link
Member

vamshin commented Mar 12, 2024

@martin-gaievski Lets give example(s) on how to use aggregations with Hybrid query. This will be useful.

@hdhalter hdhalter added the 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. label Mar 12, 2024
@hdhalter
Copy link
Contributor

@martin-gaievski
Copy link
Member Author

Sounds good. Who can make the change to https://github.com/opensearch-project/documentation-website/edit/main/_search-plugins/hybrid-search.md? Thanks!

I've put together initial version of PR #6661

@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. labels Mar 13, 2024
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete v2.13.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants