docs: add OpenSearchSQLRetriever documentation page#11543
Open
Srivatsa03 wants to merge 4 commits into
Open
Conversation
|
@Srivatsa03 is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Author
|
Note: this is a docs-only change with no library code, so I believe it needs the ignore-for-release-notes label to satisfy the reno check. Could a maintainer apply it when reviewing? Happy to adjust anything else. |
Contributor
|
can you please also add it to the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issues
Proposed Changes:
Adds a documentation page for the
OpenSearchSQLRetrievercomponent, which was missing from the docs website. Modeled on the existingElasticsearchSQLRetrieverpage (#11494).docs-website/docs/pipeline-components/retrievers/opensearchsqlretriever.mdxdocs-website/sidebars.js).docs-website/docs/pipeline-components/retrievers.mdx).Unlike the BM25 and embedding retrievers, this component takes a SQL query string and returns the raw OpenSearch SQL JSON response (
result["result"]["hits"]["hits"]for regular queries, and theaggregationsblock for grouped aggregate queries) rather than a list ofDocuments, so the Usage section documents a basic query and an aggregation query.How did you test it?
Manual verification. The page content and signatures were checked against the component source in
integrations/opensearch/src/haystack_integrations/components/retrievers/opensearch/sql_retriever.py. This is a docs-only change with no code modifications.Notes for the reviewer
This resolves an issue in the
haystack-core-integrationsrepo, but per the issue the page belongs in the core repo's docs website, so the PR is here. It mirrors the recently mergedElasticsearchSQLRetrieverpage (#11494), adjusted for the OpenSearch SQL result shape. Since this is docs-only, it likely needs theignore-for-release-noteslabel to satisfy the reno check.Checklist
docs:.Closes deepset-ai/haystack-core-integrations#3352