Simplified Linear and RRF Retrievers Docs #130559
Conversation
Mikep86
added
>docs
|
🔍 Preview links for changed docs: 🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes. |
elasticsearchmachine
added
Team:Docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/search-eng (Team:SearchOrg) |
|
Pinging @elastic/search-relevance (Team:Search - Relevance) |
|
@leemthompo Do we have to use any special tags to indicate that this functionality is only in 9.1+? |
|
@Mikep86 we certainly do: the applies_to tags You'll probably need the section and inline level ones specifically :) |
| Required when `query` is specified. | ||
|
|
||
| ::::{warning} | ||
| Avoid using `none` as that will disable normalization and may bias the result set towards lexical matches. |
There was a problem hiding this comment.
| Avoid using `none` as that will disable normalization and may bias the result set towards lexical matches. | |
| Avoid using `none` when performing hybrid search as that will disable normalization and may bias the result set towards lexical matches. |
There was a problem hiding this comment.
Should this warning go under the Normalizers section instead of params? Or be duplicated?
There was a problem hiding this comment.
Ah nevermind, I see you have it down under the field boosting section, I think 3x might be overkill 😉 But we could consider moving it. I'll leave that up to you.
There was a problem hiding this comment.
I think it's good where it is. Also, I'm reticent to include the qualifier of "when performing hybrid search" because:
- We haven't introduced the concept of hybrid search here, so mentioning it out of nowhere could be confusing.
- This feature is primarily targeted at users who want an easy button, and adding the cognitive load of figuring out if they are performing a hybrid search goes against that.
We could add general advice about when normalization is required (outside of the multi-field query format), but this linear retriever example already does that (and we link to it on this page), so it seems repetitive.
|
|
||
| The score breakdown would be: | ||
|
|
||
| * Lexical fields (50% of score): |
There was a problem hiding this comment.
@Mikep86 it looks like you've got some chicken-and-egg build failures because you have two open PRs that depend on each other for newly created anchor sections. The solution here is to comment out X-links that aren't live yet, and then open follow up PRs to uncomment. This will be another pain point fixed by moving the examples page into Elasticsearch repo.
Co-authored-by: Kathleen DeRusso <[email protected]>
🔍 Preview links for changed docs |
💚 Backport successful
|
Adds simplified `linear` and `rrf` retriever examples. Sibling PR to elastic/elasticsearch#130559. --------- Co-authored-by: Liam Thompson <[email protected]>
Adds documentation for the simplified
linearandrrfretriever query syntax. Sibling PR to elastic/docs-content#2026.Will spin up a separate pr for 8.19 once these changes are approved.