Skip to content

[8.19] Simplified Linear and RRF Retrievers Docs #130842

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

Merged

Conversation

Mikep86
Copy link
Contributor

@Mikep86 Mikep86 commented Jul 8, 2025

Manual backport of #130559

Copy link
Contributor

github-actions bot commented Jul 8, 2025

Documentation preview:

@Mikep86 Mikep86 changed the title Update linear retriever documentation [8.19] Simplified Linear and RRF Retrievers Docs Jul 8, 2025
@Mikep86 Mikep86 added >docs General docs changes :SearchOrg/Relevance Label for the Search (solution/org) Relevance team labels Jul 8, 2025
@@ -1277,59 +1547,65 @@ The output of which, albeit a bit verbose, will provide all the necessary info t
"_score": 0.5,
"_explanation": {
"value": 0.5,
"description": "rrf score: [0.5] computed for initial ranks [0, 1] with rankConstant: [1] as sum of [1 / (rank + rankConstant)] for each query",
"description": "sum of:",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This change is not related to the backport. The actual response for this example did not match what was here before. Did the test for this example ever pass? Why did this change? I have no idea 🤷‍♂️ . Perhaps the test for this example wasn't executing for some reason, and the changes I added in the backport inadvertently "fixed the glitch". However the scenario arose, I fixed the test to get green CI for this backport.

What I can say for sure is that the response for this example was not influenced by what I added to the docs or the addition of the multi-field query format. I tested this same example on 8.18 manually and got the same response as 8.19.

Copy link
Member

Choose a reason for hiding this comment

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

It appears this has actually changed elsewhere, but approving this as it can be updated if the unrelated issue is fixed down the line.

@Mikep86 Mikep86 requested review from leemthompo and kderusso July 9, 2025 20:46
@Mikep86 Mikep86 marked this pull request as ready for review July 9, 2025 20:46
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:SearchOrg Meta label for the Search Org (Enterprise Search) Team:Search - Relevance The Search organization Search Relevance team labels Jul 9, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/search-eng (Team:SearchOrg)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/search-relevance (Team:Search - Relevance)

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.

🚀

@@ -1277,59 +1547,65 @@ The output of which, albeit a bit verbose, will provide all the necessary info t
"_score": 0.5,
"_explanation": {
"value": 0.5,
"description": "rrf score: [0.5] computed for initial ranks [0, 1] with rankConstant: [1] as sum of [1 / (rank + rankConstant)] for each query",
"description": "sum of:",
Copy link
Member

Choose a reason for hiding this comment

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

It appears this has actually changed elsewhere, but approving this as it can be updated if the unrelated issue is fixed down the line.

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Per the preview, your subheadings were missing some tags and therefore they sat at the same level as the parent.

My suggestions should fix that. Thanks @Mikep86!

@Mikep86 Mikep86 merged commit 0b16ce8 into elastic:8.19 Jul 10, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :SearchOrg/Relevance Label for the Search (solution/org) Relevance team Team:Docs Meta label for docs team Team:Search - Relevance The Search organization Search Relevance team Team:SearchOrg Meta label for the Search Org (Enterprise Search) v8.19.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants