import os
from typing import List, Tuple, Optional
import aiohttp
from autorag.nodes.passagereranker.base import passage_reranker_node
from autorag.utils.util import get_event_loop, process_batch
JINA_API_URL = "https://api.jina.ai/v1/rerank"
[docs]
@passage_reranker_node
def jina_reranker(
queries: List[str],
contents_list: List[List[str]],
scores_list: List[List[float]],
ids_list: List[List[str]],
top_k: int,
api_key: Optional[str] = None,
model: str = "jina-reranker-v1-base-en",
batch: int = 8,
) -> Tuple[List[List[str]], List[List[str]], List[List[float]]]:
"""
Rerank a list of contents with Jina rerank models.
You can get the API key from https://jina.ai/reranker and set it in the environment variable JINAAI_API_KEY.
:param queries: The list of queries to use for reranking
:param contents_list: The list of lists of contents to rerank
:param scores_list: The list of lists of scores retrieved from the initial ranking
:param ids_list: The list of lists of ids retrieved from the initial ranking
:param top_k: The number of passages to be retrieved
:param api_key: The API key for Jina rerank.
You can set it in the environment variable JINAAI_API_KEY.
Or, you can directly set it on the config YAML file using this parameter.
Default is env variable "JINAAI_API_KEY".
:param model: The model name for Cohere rerank.
You can choose between "jina-reranker-v1-base-en" and "jina-colbert-v1-en".
Default is "jina-reranker-v1-base-en".
:param batch: The number of queries to be processed in a batch
:return: Tuple of lists containing the reranked contents, ids, and scores
"""
if api_key is None:
api_key = os.getenv("JINAAI_API_KEY", None)
if api_key is None:
raise ValueError(
"API key is not provided."
"You can set it as an argument or as an environment variable 'JINAAI_API_KEY'"
)
tasks = [
jina_reranker_pure(
query, contents, scores, ids, top_k=top_k, api_key=api_key, model=model
)
for query, contents, scores, ids in zip(
queries, contents_list, scores_list, ids_list
)
]
loop = get_event_loop()
results = loop.run_until_complete(process_batch(tasks, batch))
content_result, id_result, score_result = zip(*results)
return list(content_result), list(id_result), list(score_result)
[docs]
async def jina_reranker_pure(
query: str,
contents: List[str],
scores: List[float],
ids: List[str],
top_k: int,
api_key: str,
model: str = "jina-reranker-v1-base-en",
) -> Tuple[List[str], List[str], List[float]]:
session = aiohttp.ClientSession()
session.headers.update(
{"Authorization": f"Bearer {api_key}", "Accept-Encoding": "identity"}
)
async with session.post(
JINA_API_URL,
json={
"query": query,
"documents": contents,
"model": model,
"top_n": top_k,
},
) as resp:
resp_json = await resp.json()
if "results" not in resp_json:
raise RuntimeError(f"Invalid response from Jina API: {resp_json['detail']}")
results = resp_json["results"]
indices = list(map(lambda x: x["index"], results))
score_result = list(map(lambda x: x["relevance_score"], results))
id_result = list(map(lambda x: ids[x], indices))
content_result = list(map(lambda x: contents[x], indices))
await session.close()
return content_result, id_result, score_result