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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Retrievers and rerankers #110007

Merged
merged 14 commits into from
Jul 18, 2024
Merged

[DOCS] Retrievers and rerankers #110007

merged 14 commits into from
Jul 18, 2024

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Jun 20, 2024 •
edited
Loading

Background

Semantic reranking docs require 3 components:

  1. The bare minimum API docs stuff in the Search API / Retriever API reference (normally devs make these updates)
  2. I'll need to update the high-level retrievers overview that lives in "Search your data" docs section
  3. New semantic reranking overview page, sibling to retrievers overview under new Retrievers and reranking section

Summary

  • This PR focuses on number 3, new high-level information about semantic reranking, with some small updates to 2.
  • [EDIT] Drafted 1 also in 4997577

✨ URL preview

@leemthompo leemthompo added the >docs General docs changes label Jun 20, 2024
@leemthompo leemthompo self-assigned this Jun 20, 2024
@github-actions GitHub Actions
Copy link
Contributor

Documentation preview:

@leemthompo
Copy link
Contributor Author

@elasticsearchmachine test this

@leemthompo
Copy link
Contributor Author

@elasticmachine update branch

joshdevins
joshdevins previously requested changes Jun 25, 2024
View reviewed changes
Copy link
Member

@joshdevins joshdevins left a comment

Choose a reason for hiding this comment

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

Generally looks fine, but since we don't support bi-encoders, we need to remove those references and rejig the content at the end a bit.

docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Show resolved Hide resolved
docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Show resolved Hide resolved
docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Outdated Show resolved Hide resolved
@leemthompo leemthompo marked this pull request as ready for review July 15, 2024 10:23
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Jul 15, 2024
@demjened demjened self-requested a review July 15, 2024 13:36
demjened
demjened requested changes Jul 16, 2024
View reviewed changes
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.

@leemthompo Looks great - I've left some comments and filled in a couple of sections, please review them.

docs/reference/search/retriever.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/retriever.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/retriever.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/retriever.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/retriever.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Outdated
[[semantic-reranking-in-es]]
==== Semantic reranking in {es}

In {es}, semantic rerankers are implemented using the {es} *Inference API* and a <<retriever,retriever>>.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we link to the Inference API reference docs here?

docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Outdated Show resolved Hide resolved
@leemthompo
Copy link
Contributor Author

Thanks @demjened for the keen-eyed review 👍

@leemthompo leemthompo requested a review from demjened July 17, 2024 13:09
demjened
demjened approved these changes Jul 17, 2024
View reviewed changes
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, just a couple of nitpicks.

docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-your-data/retrievers-reranking/semantic-reranking.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/retriever.asciidoc Outdated Show resolved Hide resolved
@leemthompo leemthompo dismissed joshdevins’s stale review July 17, 2024 16:49

Points were addressed :)

@leemthompo @demjened
Little cleanups
a443687 
Co-authored-by: Adam Demjen <[email protected]>
@leemthompo leemthompo merged commit b535df7 into elastic:main Jul 18, 2024
5 checks passed
@leemthompo leemthompo deleted the retrievers-rerank branch July 18, 2024 07:41
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Jul 18, 2024
@leemthompo @demjened
[DOCS] Retrievers and rerankers (elastic#110007)
49ba928 
Co-authored-by: Adam Demjen <[email protected]>
@leemthompo leemthompo mentioned this pull request Jul 18, 2024
Merged
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
✅ 8.15

elasticsearchmachine pushed a commit that referenced this pull request Jul 18, 2024
@leemthompo @demjened
[DOCS] Retrievers and rerankers (#110007) (#111008)
5b9639a 
Co-authored-by: Adam Demjen <[email protected]>
ioanatia pushed a commit to ioanatia/elasticsearch that referenced this pull request Jul 22, 2024
@leemthompo @demjened @ioanatia
[DOCS] Retrievers and rerankers (elastic#110007)
b9257ce 
Co-authored-by: Adam Demjen <[email protected]>
salvatore-campagna pushed a commit to salvatore-campagna/elasticsearch that referenced this pull request Jul 23, 2024
@leemthompo @demjened @salvatore-campagna
[DOCS] Retrievers and rerankers (elastic#110007)
e94580b 
Co-authored-by: Adam Demjen <[email protected]>
@lkts lkts mentioned this pull request Aug 13, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@demjened demjened demjened approved these changes

@joshdevins joshdevins joshdevins left review comments

Assignees

@leemthompo leemthompo

Labels
>docs General docs changes Team:Docs Meta label for docs team v8.15.0 v8.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@leemthompo @elasticsearchmachine @joshdevins @demjened @elasticmachine