Skip to content

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Sep 16, 2024

See the URL preview 👁️ 🔭

Summary of this small refactoring:

  • Retrievers overview goes under "The Search API" section
  • LTR and semantic reranking get grouped under new "Reranking" section

Screenshots

Before

Screenshot 2024-09-16 at 18 44 25

After (Search your data)

Screenshot 2024-09-18 at 18 23 06

After (Reranking)

Screenshot 2024-09-18 at 18 08 36

Copy link
Contributor

Documentation preview:

@shainaraskas shainaraskas self-requested a review September 16, 2024 16:50
@leemthompo
Copy link
Contributor Author

leemthompo commented Sep 16, 2024

ℹ️ LTR is super deeply nested, so doesn't play nice if I deepen the subheadings of the LTR child pages. Have to decide whether to rework that here or in follow-up.

Another option of course is to remove "Reranking" from "Search your data"

[EDIT] this felt like the absolute best approach

@leemthompo leemthompo marked this pull request as ready for review September 18, 2024 16:34
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Sep 18, 2024
@elasticsearchmachine
Copy link
Collaborator

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

@leemthompo leemthompo requested review from kderusso and removed request for katherinesasek1 September 18, 2024 16:34
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.

LGTM with a couple of suggestions

@leemthompo
Copy link
Contributor Author

@kderusso I pushed an update to provide more context, hopefully it makes sense and is somewhat correct 😄. LMKWYT. Would be nice to have a diagram one day, but probably won't happen in this PR.

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.

This is looking good so far, thanks for iterating. I have some additional feedback.

[[re-ranking-ranking-overview-hybrid]]
==== Hybrid techniques

Hybrid search techniques combine results from full-text and vector search pipelines.
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure how much we have here, but we've been getting more and more questions and feedback on people who want more information on linear boosting as well. I wonder if a sentence here and a link to somewhere else (if we have it) would be worth doing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In future we want to have fuller docs sections for:

  • Full-text search
  • ML-powered search
  • Hybrid search

I think we'll want to revisit that when the time comes. The goal here is to put LTR and semantic reranking in a smarter IA, first and foremost, not to be the exhaustive source of truth for all these topics.

Copy link
Member

Choose a reason for hiding this comment

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

Sure sure, push back on my scope creep 😀

@@ -0,0 +1,71 @@
[[re-ranking-overview]]
= Re-ranking
Copy link
Member

Choose a reason for hiding this comment

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

I'm noticing some inconsistency - sometimes we use Reranking and other times we use Re-ranking. I slightly prefer reranking but am fine with either, though we should do a pass for consistency.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

realized that in course of this PR and tried to align on hyphenated version, will need to update the semantic re-reranking page too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

should be good after e815f94

Copy link
Contributor Author

Choose a reason for hiding this comment

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

FWIW I also prefer reranking but the hyphenated version seems more au courant :)

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.

Looks great, thanks @leemthompo !

[[re-ranking-ranking-overview-hybrid]]
==== Hybrid techniques

Hybrid search techniques combine results from full-text and vector search pipelines.
Copy link
Member

Choose a reason for hiding this comment

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

Sure sure, push back on my scope creep 😀

Co-authored-by: Kathleen DeRusso <[email protected]>
@leemthompo leemthompo merged commit 163b2c7 into elastic:main Sep 19, 2024
5 checks passed
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Sep 19, 2024
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.15
8.x

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes Team:Docs Meta label for docs team v8.15.0 v8.16.0 v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants