Skip to content

Add missing weight parameter documentation for Weighted RRF retriever and update elasticsearch-specification #136477

@mridula-s109

Description

@mridula-s109

The new weight attribute introduced as part of the Weighted RRF retriever (GA’d in #130658) is currently not documented in the REST API reference and not reflected in the elasticsearch-specification TypeScript definitions.

Details:

Docs page missing update:
RRF Retriever REST API Reference

The page still refers to “equally weighting” retrievers and doesn’t include the new weight field in the retriever container examples.

Specification type missing:
In _types/Retriever.ts, the RRF retriever definition does not include an optional weight property for each retriever container.

Relevant PR introducing feature:
elastic/elasticsearch#130658

Action Items:

Update RRF retriever docs to include:

  • weight parameter in the retriever container schema
  • Example JSON usage with weighted retrievers
  • Updated language removing “equal weighting”
    Update elasticsearch-specification to include:
  • weight?: float;
    in the RRF retriever container definition.

Metadata

Metadata

Assignees

Labels

:SearchOrg/RelevanceLabel for the Search (solution/org) Relevance team>docsGeneral docs changesTeam:DocsMeta label for docs teamTeam:Search - RelevanceThe Search organization Search Relevance teamTeam:SearchOrgMeta label for the Search Org (Enterprise Search)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions