Skip to content

Add Simplified Linear & RRF Retriever Examples #2026

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Mikep86
Copy link

@Mikep86 Mikep86 commented Jul 3, 2025

Adds simplified linear and rrf retriever examples. Sibling PR to elastic/elasticsearch#130559.

Copy link
Member

@kderusso kderusso left a comment

Choose a reason for hiding this comment

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

Nice start, a few typos and suggestions on where we can add a bit more

@leemthompo
Copy link
Contributor

leemthompo commented Jul 3, 2025

@Mikep86 @kderusso

Question for the future: would it be better for the examples page to live in the elasticsearch repo eventually, as in a be a child to the reference page?

having the overview page in the search solution/use case makes sense, but then having examples/reference separated feels wrong 🤷‍♂️

this is an artifact of the docs migration...but we could re-home the page if it that sounds right

@Mikep86
Copy link
Author

Mikep86 commented Jul 3, 2025

@leemthompo I think it makes sense to make the examples page a child of the reference page

Copy link
Member

@kderusso kderusso left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

::::


## Example: RRF with the multi-field query format [retrievers-examples-rrf-multi-field-query-format]
Copy link
Member

Choose a reason for hiding this comment

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

Reading through this again, I wonder if we should lead in with the simple way and then have the more complicated example below? Try to get more people to see the simplified retriever first? WDYT?

Non blocking feedback

::::

We don't even need to specify the `fields` parameter when using the multi-field query format.
If we omit it, the retriever will automatically query fields specified in the `index.query.default_field` index setting, which is set to `*` by default.
Copy link
Member

Choose a reason for hiding this comment

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

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API docs documentation Improvements or additions to documentation v9.1.0 v9.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants