Skip to content

docs: Add documentation page for OpenSearchMetadataRetriever#11797

Open
jialiuyang wants to merge 5 commits into
deepset-ai:mainfrom
jialiuyang:docs/add-opensearch-metadata-retriever-page
Open

docs: Add documentation page for OpenSearchMetadataRetriever#11797
jialiuyang wants to merge 5 commits into
deepset-ai:mainfrom
jialiuyang:docs/add-opensearch-metadata-retriever-page

Conversation

@jialiuyang

Copy link
Copy Markdown

Summary

Adds a dedicated documentation page for the OpenSearchMetadataRetriever component, which was missing from docs-website/.

Changes

  • Added opensearchmetadataretriever.mdx under docs-website/docs/pipeline-components/retrievers/ and mirrored it into the version-2.30 snapshot.
  • The page covers:
    • the component's purpose and how it differs from the other OpenSearch retrievers (it returns metadata dictionaries instead of Document objects),
    • the supported field types (text/keyword) and the caveats around numeric, boolean, and mixed-type fields,
    • the two search modes (strict and fuzzy) and the fuzzy-mode parameters (fuzziness, prefix_length, max_expansions, tie_breaker, jaccard_n),
    • multi-part comma-separated queries, run-time filters, the async run_async method, and raise_on_failure error handling.
  • Added the new page to docs-website/sidebars.js and docs-website/versioned_sidebars/version-2.30-sidebars.json.
  • Added a row for the new component in the retrievers index table (docs-website/docs/pipeline-components/retrievers.mdx and its version-2.30 snapshot).

Related Issue

Closes #11788

Adds the page under docs-website/docs/pipeline-components/retrievers/
and mirrors it into the version-2.30 snapshot. Updates the retrievers
index and sidebar navigation in both the current and versioned configs.
@jialiuyang jialiuyang requested a review from a team as a code owner June 28, 2026 14:30
@jialiuyang jialiuyang requested review from sjrl and removed request for a team June 28, 2026 14:30
@vercel

vercel Bot commented Jun 28, 2026

Copy link
Copy Markdown

@jialiuyang is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant

CLAassistant commented Jun 28, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@vercel

vercel Bot commented Jun 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jun 29, 2026 6:29am

Request Review


### Combining with filters

You can narrow the candidate set before scoring by passing standard Haystack `filters` at run time. The filters are applied as a `query_string` clause inside the OpenSearch request:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is incorrect. In _metadata_search, filters go through normalize_filters(...) and are applied via _apply_metadata_search_filters as a bool filter clause (added to the existing bool.filter in strict mode, or wrapping the dis_max in bool.must + filter in fuzzy mode).

@sjrl sjrl requested a review from davidsbatista June 30, 2026 06:36
@sjrl

sjrl commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Hey @davidsbatista I'd also appreciate your review on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs for OpenSearchMetadataRetriever component

4 participants