Updating text_similarity_reranker documentation #126175
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
kderusso
reviewed
Apr 4, 2025
| ### Prerequisites [_prerequisites_15] | ||
|
|
||
| To use `text_similarity_reranker` you must first set up an inference endpoint for the `rerank` task using the [Create {{infer}} API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put). The endpoint should be set up with a machine learning model that can compute text similarity. Refer to [the Elastic NLP model reference](docs-content://explore-analyze/machine-learning/nlp/ml-nlp-model-ref.md#ml-nlp-model-ref-text-similarity) for a list of third-party text similarity models supported by {{es}}. | ||
| To use `text_similarity_reranker` you can use the preconfigured `.rerank-v1-elasticsearch` inference endpoint, which is the default if no `inference_id` is provided. Alternatively, you can set up a custom inference endpoint for the `rerank` task using the [Create {{infer}} API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put). The endpoint should be set up with a machine learning model that can compute text similarity. Refer to [the Elastic NLP model reference](docs-content://explore-analyze/machine-learning/nlp/ml-nlp-model-ref.md#ml-nlp-model-ref-text-similarity) for a list of third-party text similarity models supported by {{es}}. |
There was a problem hiding this comment.
We should link to our docs on Elastic rerank here
There was a problem hiding this comment.
Did you mean the Elastic Rerank model page link?
If yes, How about this one?
To use `text_similarity_reranker` you can use the preconfigured `.rerank-v1-elasticsearch` inference endpoint created based on [Elastic Rerank](https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elasticsearch.html#inference-example-elastic-reranker)), which is the default if no `inference_id` is provided.
There was a problem hiding this comment.
Nvm, you probably meant this documentation link?
https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-rerank.html
There was a problem hiding this comment.
I like your link to our model, let's find a way to add both links?
There was a problem hiding this comment.
Updated the documentation to include both link. Please let me know what do you think
|
Pinging @elastic/es-docs (Team:Docs) |
Mikep86
reviewed
Apr 7, 2025
|
@elasticmachine update branch |
Samiul-TheSoccerFan
added
the
auto-backport
💚 Backport successful
|
Samiul-TheSoccerFan
added a commit
to Samiul-TheSoccerFan/elasticsearch
that referenced
this pull request
Apr 16, 2025
* Updating text_similarity_reranker documentation * Updating docs to include urls * remove extra THE from the text --------- Co-authored-by: Elastic Machine <[email protected]>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Apr 16, 2025
* Updating text_similarity_reranker documentation * Updating docs to include urls * remove extra THE from the text --------- Co-authored-by: Elastic Machine <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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 RerankGA, updating the documentation to address that theinference_idfield is notrequiredanymore.