Skip to content
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

[DOCS] Add retrievers overview #107959

Merged
merged 5 commits into from May 7, 2024
Merged

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Apr 26, 2024

@leemthompo leemthompo added >docs General docs changes auto-backport-and-merge Automatically create backport pull requests and merge when ready v8.14.0 labels Apr 26, 2024
@leemthompo leemthompo self-assigned this Apr 26, 2024
Copy link

Documentation preview:

Copy link
Contributor

@demjened demjened left a comment

Choose a reason for hiding this comment

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

Nice doc, I left some minor comments.

mixing syntaxes.
* <<knn-retriever,*kNN Retriever*>>. Returns top documents from a <<search-api-knn,knn search>>,
in the context of a retriever framework.
* <<rrf-retriever,*RRF Retriever*>>. Combines and ranks multiple standard retrievers using
Copy link
Contributor

Choose a reason for hiding this comment

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

I think "standard" is misleading here - the RRF retriever can nest multiple retrievers, including standard and kNN (and possibly later a reranker as well).

I suggest either removing "standard" or replacing it with "first-stage" (but then you'd need to clarify what a first stage retriever is 😉 )

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good one for the glossary, let me know if there's other terms you think should be in there :)

@leemthompo leemthompo requested a review from demjened May 7, 2024 08:11
@leemthompo
Copy link
Contributor Author

We'll definitely update this based on feedback, but probably worth considering merging at this stage

@leemthompo leemthompo marked this pull request as ready for review May 7, 2024 09:56
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label May 7, 2024
@elasticsearchmachine
Copy link
Collaborator

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

Copy link
Contributor

@demjened demjened left a comment

Choose a reason for hiding this comment

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

LGTM

@leemthompo leemthompo merged commit b2ebaee into elastic:main May 7, 2024
5 checks passed
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request May 7, 2024
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.14

@leemthompo leemthompo deleted the retrievers-docs branch May 7, 2024 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport-and-merge Automatically create backport pull requests and merge when ready >docs General docs changes Team:Docs Meta label for docs team v8.14.0 v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants