Updating documentation for text_similarity_reranker for 8.x #126971
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Documentation preview: |
Samiul-TheSoccerFan
added
>docs
Samiul-TheSoccerFan
added
Team:Search Relevance
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/search-eng (Team:SearchOrg) |
|
Pinging @elastic/search-relevance (Team:Search - Relevance) |
leemthompo
reviewed
Apr 17, 2025
|
|
||
| You have the following options: | ||
|
|
||
| * Use the the built-in <<inference-example-elastic-reranker,Elastic Rerank>> cross-encoder model via the inference API's {es} service. | ||
| * Use the built-in <<inference-example-elastic-reranker,Elastic Rerank>> cross-encoder model via the inference API’s {{es}} service. For an example of creating an endpoint using the Elastic Rerank model, refer to <<https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elasticsearch.html#inference-example-elastic-reranker, this guide>>. |
There was a problem hiding this comment.
Suggested change
| * Use the built-in <<inference-example-elastic-reranker,Elastic Rerank>> cross-encoder model via the inference API’s {{es}} service. For an example of creating an endpoint using the Elastic Rerank model, refer to <<https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elasticsearch.html#inference-example-elastic-reranker, this guide>>. | |
| Use the built-in Elastic Rerank cross-encoder model via the inference API's {es} service. See <<inference-example-elastic-reranker, this example>> for creating an endpoint using the Elastic Rerank model. |
There was a problem hiding this comment.
- We already had that link, so I removed the first one
- The new link syntax was incorrect
leemthompo
reviewed
Apr 17, 2025
| @@ -87,11 +85,11 @@ To use semantic re-ranking in {es}, you need to: | |||
|
|
|||
| . *Select and configure a re-ranking model*. | |||
| You have the following options: | |||
| .. Use the <<inference-example-elastic-reranker,Elastic Rerank>> cross-encoder model via the inference API's {es} service. | |||
| .. Use the <<inference-example-elastic-reranker,Elastic Rerank>> cross-encoder model via a preconfigured `.rerank-v1-elasticsearch` or by creating a custom deployment using the inference API's {es} service. | |||
There was a problem hiding this comment.
Suggested change
| .. Use the <<inference-example-elastic-reranker,Elastic Rerank>> cross-encoder model via a preconfigured `.rerank-v1-elasticsearch` or by creating a custom deployment using the inference API's {es} service. | |
| .. Use the <<inference-example-elastic-reranker,Elastic Rerank>> model through a preconfigured `.rerank-v1-elasticsearch` endpoint or create a custom one using the inference API's {es} service. |
leemthompo
reviewed
Apr 17, 2025
| To use `text_similarity_reranker` you must first set up an inference endpoint for the `rerank` task using the <<put-inference-api, Create {infer} API>>. | ||
| The endpoint should be set up with a machine learning model that can compute text similarity. | ||
| Refer to {ml-docs}/ml-nlp-model-ref.html#ml-nlp-model-ref-text-similarity[the Elastic NLP model reference] for a list of third-party text similarity models supported by {es}. | ||
| To use `text_similarity_reranker`, you can rely on the preconfigured `.rerank-v1-elasticsearch` inference endpoint, which is based on <<inference-example-elastic-reranker,Elastic Rerank>> and serves as the default if no `inference_id` is provided. |
There was a problem hiding this comment.
Suggested change
| To use `text_similarity_reranker`, you can rely on the preconfigured `.rerank-v1-elasticsearch` inference endpoint, which is based on <<inference-example-elastic-reranker,Elastic Rerank>> and serves as the default if no `inference_id` is provided. | |
| To use `text_similarity_reranker`, you can rely on the preconfigured `.rerank-v1-elasticsearch` inference endpoint, which uses the <<inference-example-elastic-reranker,Elastic Rerank model>> and serves as the default if no `inference_id` is provided. |
leemthompo
reviewed
Apr 17, 2025
There was a problem hiding this comment.
Few changes needed, but otherwise looks good! Remember we need to update the 9.x equivalents too nowadays:
https://www.elastic.co/docs/solutions/search/ranking/semantic-reranking
https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers
|
@leemthompo I already had a PR for |
Samiul-TheSoccerFan
added a commit
to Samiul-TheSoccerFan/elasticsearch
that referenced
this pull request
Apr 17, 2025
…126971) * Updating documentation of text_similarity_reranker for 8.x * updating documentation to remove duplicate and redundant wording
💚 Backport successful
|
elasticsearchmachine
pushed a commit
that referenced
this pull request
Apr 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As part of Semantic Rerank GA, updating the documentation to address that the inference_id field is not required anymore.