From d31527101789d67ed37f3969454d12488195bc2c Mon Sep 17 00:00:00 2001
From: Joan Fontanals <joan.fontanals.martinez@jina.ai>
Date: Thu, 29 Feb 2024 16:55:44 +0100
Subject: [PATCH] docs: add reference to jina rerank module (#11507)
---
.../examples/node_postprocessor/JinaRerank.ipynb | 2 +-
.../node_postprocessors/node_postprocessors.md | 16 ++++++++++++++++
2 files changed, 17 insertions(+), 1 deletion(-)
diff --git a/docs/examples/node_postprocessor/JinaRerank.ipynb b/docs/examples/node_postprocessor/JinaRerank.ipynb
index 5925382fc8..ce07b72652 100644
--- a/docs/examples/node_postprocessor/JinaRerank.ipynb
+++ b/docs/examples/node_postprocessor/JinaRerank.ipynb
@@ -5,7 +5,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
- "<a href=\"https://colab.research.google.com/github/run-llama/llama_index/blob/main/docs/examples/node_postprocessor/CohereRerank.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
+ "<a href=\"https://colab.research.google.com/github/run-llama/llama_index/blob/main/docs/examples/node_postprocessor/JinaRerank.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
]
},
{
diff --git a/docs/module_guides/querying/node_postprocessors/node_postprocessors.md b/docs/module_guides/querying/node_postprocessors/node_postprocessors.md
index 86d78d2379..03e6cff91f 100644
--- a/docs/module_guides/querying/node_postprocessors/node_postprocessors.md
+++ b/docs/module_guides/querying/node_postprocessors/node_postprocessors.md
@@ -127,6 +127,22 @@ postprocessor.postprocess_nodes(nodes)
Full notebook guide is available [her for Gatsby](/examples/node_postprocessor/LLMReranker-Gatsby.ipynb) and [here for Lyft 10K documents](/examples/node_postprocessor/LLMReranker-Lyft-10k.ipynb).
+## JinaRerank
+
+Uses the "Cohere ReRank" functionality to re-order nodes, and returns the top N nodes.
+
+```python
+from llama_index.postprocessor.jinaai_rerank import JinaRerank
+
+postprocessor = JinaRerank(
+ top_n=2, model="jina-reranker-v1-base-en", api_key="YOUR JINA API KEY"
+)
+
+postprocessor.postprocess_nodes(nodes)
+```
+
+Full notebook guide is available [here](/examples/node_postprocessor/JinaRerank.ipynb).
+
## FixedRecencyPostprocessor
This postproccesor returns the top K nodes sorted by date. This assumes there is a `date` field to parse in the metadata of each node.
--
GitLab