Include Pinned Retriever in 8.19 Documentation #129217
Conversation
mridula-s109
added
>non-issue
:SearchOrg/Relevance
|
Documentation preview: |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
elasticsearchmachine
added
Team:SearchOrg
|
Pinging @elastic/search-eng (Team:SearchOrg) |
|
Pinging @elastic/search-relevance (Team:Search - Relevance) |
mridula-s109
force-pushed
the
update-pinned-docs-8.19
branch
from
40a8242 to
07d8f88
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
This PR updates the search documentation to include details for the new Pinned Retriever in version 8.19.
- Added an entry for Pinned Retriever in the retrievers overview file.
- Included a new example section with parameter details and usage examples for the pinned retriever in the examples file.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/reference/search/search-your-data/retrievers-overview.asciidoc | Added a new bullet referencing the Pinned Retriever with a brief explanation. |
| docs/reference/search/search-your-data/retrievers-examples.asciidoc | Introduced a new example section for the Pinned Retriever with detailed parameter and usage instructions. |
|
@kderusso Have made changes related to the index usage as discussed in the call yesterday. |
There was a problem hiding this comment.
Let's please follow the standard that we use for other docs. Please reach out to @leemthompo if you have questions on where you should put stuff as well, thanks.
|
|
||
| The pinned retriever allows you to always place specific documents at the top of the results, with the remaining hits provided by a secondary retriever. | ||
|
|
||
| .Parameters |
There was a problem hiding this comment.
I don't think parameters belong here, it should be in the retrievers overview. If you notice no parameters are in any of the other examples. Instead, please add parameter information to retriever.asciidoc and follow the paradigm that we use for other retreivers.
There was a problem hiding this comment.
++ The examples pages should only house examples, not reference info :)
Summary of changes
retrievers-overview.