Skip to content

Commit

Permalink
[DOCS] Link to Elastic Rerank model landing page (#118574)
Browse files Browse the repository at this point in the history
- Add link to Python notebook
- Fix heading level
  • Loading branch information
leemthompo authored Dec 13, 2024
1 parent 21b7afd commit 528593b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
7 changes: 6 additions & 1 deletion docs/reference/inference/service-elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,12 @@ For further details, refer to the {ml-docs}/ml-nlp-elser.html[ELSER model docume
[[inference-example-elastic-reranker]]
==== Elastic Rerank via the `elasticsearch` service

The following example shows how to create an {infer} endpoint called `my-elastic-rerank` to perform a `rerank` task type using the built-in Elastic Rerank cross-encoder model.
The following example shows how to create an {infer} endpoint called `my-elastic-rerank` to perform a `rerank` task type using the built-in {ml-docs}/ml-nlp-rerank.html[Elastic Rerank] cross-encoder model.

[TIP]
====
Refer to this https://github.com/elastic/elasticsearch-labs/blob/main/notebooks/search/12-semantic-reranking-elastic-rerank.ipynb[Python notebook] for an end-to-end example using Elastic Rerank.
====

The API request below will automatically download the Elastic Rerank model if it isn't already downloaded and then deploy the model.
Once deployed, the model can be used for semantic re-ranking with a <<text-similarity-reranker-retriever-example-elastic-rerank,`text_similarity_reranker` retriever>>.
Expand Down
7 changes: 6 additions & 1 deletion docs/reference/search/retriever.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,12 @@ If the child retriever already specifies any filters, then this top-level filter
[[text-similarity-reranker-retriever-example-elastic-rerank]]
==== Example: Elastic Rerank

This examples demonstrates how to deploy the Elastic Rerank model and use it to re-rank search results using the `text_similarity_reranker` retriever.
[TIP]
====
Refer to this https://github.com/elastic/elasticsearch-labs/blob/main/notebooks/search/12-semantic-reranking-elastic-rerank.ipynb[Python notebook] for an end-to-end example using Elastic Rerank.
====

This example demonstrates how to deploy the {ml-docs}/ml-nlp-rerank.html[Elastic Rerank] model and use it to re-rank search results using the `text_similarity_reranker` retriever.

Follow these steps:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
[[retrievers-examples]]
=== Retrievers examples

Learn how to combine different retrievers in these hands-on examples.

=== Retrievers examples

[discrete]
[[retrievers-examples-setup]]
==== Add example data
Expand Down

0 comments on commit 528593b

Please sign in to comment.