Skip to content

Conversation

pmpailis
Copy link
Contributor

Now that the rework of RRF and retrievers in general has been merged, it's probably time to remove the tech-preview header from the documentation in time for 8.16 and mark the feature as GA.

@pmpailis pmpailis added >docs General docs changes :Search Relevance/Ranking Scoring, rescoring, rank evaluation. auto-backport Automatically create backport pull requests when merged v8.16.0 v9.0.0 labels Oct 15, 2024
Copy link
Contributor

Documentation preview:

@pmpailis pmpailis changed the title Removing tech-preview header and documentation for retrievers and RRF Removing tech-preview header and updating documentation for retrievers and RRF Oct 15, 2024
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Oct 15, 2024
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-search-relevance (Team:Search Relevance)

@elasticsearchmachine elasticsearchmachine added the Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch label Oct 15, 2024
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

LGTM docs-wise

Copy link
Member

@benwtrent benwtrent left a comment

Choose a reason for hiding this comment

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

I think this is good, but we need to be crystal clear about sub-searches & rrf rank. Those need to stay flagged as tech preview & we need to indicate that they will be removed.

[[rrf]]
=== Reciprocal rank fusion

preview::["This functionality is in technical preview and may be changed or removed in a future release. The syntax will likely change before GA. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features."]
Copy link
Member

Choose a reason for hiding this comment

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

We just need to make sure that we CLEARLY communicate that rank: rrf is still tech preview and will be removed. I am not sure what things link to this doc page, but we need to be absolutely clear about that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All references to docs have been removed when we introduced the rrf retriever here. Should we add a warning header that rank: rrf is a now-deprecated option?
I've also opened this PR to add deprecation headers when using rank: rrf and/or sub_searches

@pmpailis
Copy link
Contributor Author

@elasticmachine update branch

@pmpailis pmpailis merged commit a7e62f5 into elastic:main Oct 16, 2024
15 checks passed
pmpailis added a commit to pmpailis/elasticsearch that referenced this pull request Oct 16, 2024
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.x

elasticsearchmachine pushed a commit that referenced this pull request Oct 16, 2024
georgewallace pushed a commit to georgewallace/elasticsearch that referenced this pull request Oct 25, 2024
@pmpailis pmpailis deleted the updating_docs_for_rrf_ga branch May 27, 2025 03:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-backport Automatically create backport pull requests when merged >docs General docs changes release highlight :Search Relevance/Ranking Scoring, rescoring, rank evaluation. Team:Docs Meta label for docs team Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch v8.16.0 v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants