|
@@ -536,13 +536,14 @@ Refer to <<semantic-reranking>> for a high level overview of semantic re-ranking
|
|
|
|
|
|
===== Prerequisites
|
|
|
|
|
|
-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 uses the <<inference-example-elastic-reranker,Elastic Rerank model>> and serves as the default if no `inference_id` is provided.
|
|
|
+This model is optimized for reranking based on text similarity. If you'd like to use a different model, you can set up a custom inference endpoint for the `rerank` task using the <<put-inference-api, Create {infer} API>>.
|
|
|
+The endpoint should be configured with a machine learning model capable of computing 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}}.
|
|
|
|
|
|
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 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.
|
|
|
* Use the <<infer-service-cohere,Cohere Rerank inference endpoint>> with the `rerank` task type.
|
|
|
* Use the <<infer-service-google-vertex-ai,Google Vertex AI inference endpoint>> with the `rerank` task type.
|
|
|
* Upload a model to {es} with {eland-docs}/machine-learning.html#ml-nlp-pytorch[Eland] using the `text_similarity` NLP task type.
|
|
@@ -582,9 +583,9 @@ The document field to be used for text similarity comparisons.
|
|
|
This field should contain the text that will be evaluated against the `inferenceText`.
|
|
|
|
|
|
`inference_id`::
|
|
|
-(Required, `string`)
|
|
|
+(Optional, `string`)
|
|
|
+
|
|
|
-Unique identifier of the inference endpoint created using the {infer} API.
|
|
|
+Unique identifier of the inference endpoint created using the {infer} API. If you don’t specify an inference endpoint, the `inference_id` field defaults to `.rerank-v1-elasticsearch`, a preconfigured endpoint for the elasticsearch `.rerank-v1` model.
|
|
|
|
|
|
`inference_text`::
|
|
|
(Required, `string`)
|