mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-07 20:32:59 +00:00
549ca51a8a
This PR: - Adds missing license headers - Integrates with answerdotai Rerankers package - Updates ColbertReranker to subclass answerdotai package. This is done to keep backwards compatibility as some users might be used to importing ColbertReranker directly - Set `trust_remote_code` to ` True` by default in CrossEncoder and sentence-transformer based rerankers
136 lines
4.3 KiB
Python
136 lines
4.3 KiB
Python
# Copyright (c) 2023. LanceDB Developers
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import os
|
|
import requests
|
|
from functools import cached_property
|
|
from typing import Union
|
|
|
|
import pyarrow as pa
|
|
|
|
from .base import Reranker
|
|
|
|
API_URL = "https://api.jina.ai/v1/rerank"
|
|
|
|
|
|
class JinaReranker(Reranker):
|
|
"""
|
|
Reranks the results using the Jina Rerank API.
|
|
https://jina.ai/rerank
|
|
|
|
Parameters
|
|
----------
|
|
model_name : str, default "jina-reranker-v2-base-multilingual"
|
|
The name of the cross reanker model to use
|
|
column : str, default "text"
|
|
The name of the column to use as input to the cross encoder model.
|
|
top_n : str, default None
|
|
The number of results to return. If None, will return all results.
|
|
api_key : str, default None
|
|
The api key to access Jina API. If you pass None, you can set JINA_API_KEY
|
|
environment variable
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
model_name: str = "jina-reranker-v2-base-multilingual",
|
|
column: str = "text",
|
|
top_n: Union[int, None] = None,
|
|
return_score="relevance",
|
|
api_key: Union[str, None] = None,
|
|
):
|
|
super().__init__(return_score)
|
|
self.model_name = model_name
|
|
self.column = column
|
|
self.top_n = top_n
|
|
self.api_key = api_key
|
|
|
|
@cached_property
|
|
def _client(self):
|
|
if os.environ.get("JINA_API_KEY") is None and self.api_key is None:
|
|
raise ValueError(
|
|
"JINA_API_KEY not set. Either set it in your environment or \
|
|
pass it as `api_key` argument to the JinaReranker."
|
|
)
|
|
self.api_key = self.api_key or os.environ.get("JINA_API_KEY")
|
|
self._session = requests.Session()
|
|
self._session.headers.update(
|
|
{"Authorization": f"Bearer {self.api_key}", "Accept-Encoding": "identity"}
|
|
)
|
|
return self._session
|
|
|
|
def _rerank(self, result_set: pa.Table, query: str):
|
|
docs = result_set[self.column].to_pylist()
|
|
response = self._client.post( # type: ignore
|
|
API_URL,
|
|
json={
|
|
"query": query,
|
|
"documents": docs,
|
|
"model": self.model_name,
|
|
"top_n": self.top_n,
|
|
},
|
|
).json()
|
|
if "results" not in response:
|
|
raise RuntimeError(response["detail"])
|
|
|
|
results = response["results"]
|
|
|
|
indices, scores = list(
|
|
zip(*[(result["index"], result["relevance_score"]) for result in results])
|
|
) # tuples
|
|
result_set = result_set.take(list(indices))
|
|
# add the scores
|
|
result_set = result_set.append_column(
|
|
"_relevance_score", pa.array(scores, type=pa.float32())
|
|
)
|
|
|
|
return result_set
|
|
|
|
def rerank_hybrid(
|
|
self,
|
|
query: str,
|
|
vector_results: pa.Table,
|
|
fts_results: pa.Table,
|
|
):
|
|
combined_results = self.merge_results(vector_results, fts_results)
|
|
combined_results = self._rerank(combined_results, query)
|
|
if self.score == "relevance":
|
|
combined_results = self._keep_relevance_score(combined_results)
|
|
elif self.score == "all":
|
|
raise NotImplementedError(
|
|
"return_score='all' not implemented for JinaReranker"
|
|
)
|
|
return combined_results
|
|
|
|
def rerank_vector(
|
|
self,
|
|
query: str,
|
|
vector_results: pa.Table,
|
|
):
|
|
result_set = self._rerank(vector_results, query)
|
|
if self.score == "relevance":
|
|
result_set = result_set.drop_columns(["_distance"])
|
|
|
|
return result_set
|
|
|
|
def rerank_fts(
|
|
self,
|
|
query: str,
|
|
fts_results: pa.Table,
|
|
):
|
|
result_set = self._rerank(fts_results, query)
|
|
if self.score == "relevance":
|
|
result_set = result_set.drop_columns(["_score"])
|
|
|
|
return result_set
|