Q ibddlZddlmZmZmZmZmZmZddlm Z ddl m Z Gdde Z dS)N)AnyDictListOptionalTupleUnion) PrivateAttr) BaseRerankerc eZdZUdZeZeed<eZeed< dde de e e d e d e d e ef fd Zd e efd Zde dee ee efe e ffdZedee ee efe e fde edee ee effdZde dee ee efe e fdeee ee efe efe ee efffdZde dee ee efe e fdeee ee efe efe ee efffdZxZS)VoyageAIRerankera# The VoyageAIReranker class uses VoyageAI's API to rerank documents based on an input query. This reranker is designed to interact with VoyageAI's /rerank API, requiring an API key for authentication. The key can be provided directly in the `api_config` dictionary or through the `VOYAGE_API_KEY` environment variable. User must obtain an API key from VoyageAI's website (https://dash.voyageai.com/). Additionally, the `voyageai` python client must be installed with `pip install voyageai`. .. code-block:: python from redisvl.utils.rerank import VoyageAIReranker # set up the VoyageAI reranker with some configuration reranker = VoyageAIReranker(rank_by=["content"], limit=2) # rerank raw search results based on user input/query results = reranker.rank( query="your input query text here", docs=[ {"content": "document 1"}, {"content": "document 2"}, {"content": "document 3"} ] ) _client_aclientNTmodelrank_bylimit return_score api_configc nt|||||j|fi|dS)a Initialize the VoyageAIReranker with specified model, ranking criteria, and API configuration. Parameters: model (str): The identifier for the VoyageAI model used for reranking. rank_by (Optional[List[str]]): Optional list of keys specifying the attributes in the documents that should be considered for ranking. None means ranking will rely on the model's default behavior. limit (int): The maximum number of results to return after reranking. Must be a positive integer. return_score (bool): Whether to return scores alongside the reranked results. api_config (Optional[Dict], optional): Dictionary containing the API key. Defaults to None. Raises: ImportError: If the voyageai library is not installed. ValueError: If the API key is not provided. )rrrrN)super__init___initialize_clients)selfrrrrrkwargs __class__s C:\Users\Dell Inspiron 16\Desktop\tws\AgrotaPowerBi\back-agrota-powerbi\mcp-client-agrota\venv\Lib\site-packages\redisvl/utils/rerank/voyageai.pyrzVoyageAIReranker.__init__)sR< L     ! 66v66666c  ddlm}m}n#t$rtdwxYw|r|dnt jd}|std|dd|i||_|dd|i||_ dS) zk Setup the VoyageAI clients using the provided API key or an environment variable. r) AsyncClientClientzoVoyageAI reranker requires the voyageai library. Please install with `pip install voyageai`api_keyVOYAGE_API_KEYzfVoyageAI API key is required. Provide it in api_config or set the VOYAGE_API_KEY environment variable.N) voyageairr ImportErrorgetosgetenv ValueErrorr r)rrrrr r!s rrz$VoyageAIReranker._initialize_clientsLs   4 4 4 4 4 4 4 4 4   @  *4 TJNN9 % % %CS9T9T  [ v88g888 # >>G>v>> s %querydocsc r|d|j}|d|j}|d}t|tst dt d|Dr d|D}n d|D}|||j|d}|||d<||fS) zo Prepare and validate reranking config based on provided input and optional overrides. rr truncationz6Docs to rerank should either be a list of str or dict.c3HK|]}t|tod|vVdS)contentN) isinstancedict.0docs r z/VoyageAIReranker._preprocess..ts6JJcz#t$$9c)9JJJJJJrcjg|]0}t|trd|vt|d1S)r/)r0r1strr2s r z0VoyageAIReranker._preprocess..usMc4((.7#-=-=C N##-=-=-=rc,g|]}t|Sr#)r7r2s rr8z0VoyageAIReranker._preprocess..{s...#SXX...r)r* documentsrtop_k)r&rrr0listr)allr) rr*r+rrrr-textsreranker_kwargss r _preprocesszVoyageAIReranker._preprocessfs 7DJ//zz.$2CDD ZZ -- $%% WUVV V JJTJJJ J J /EE /....EZ     !,6OL ) ,,rrankingsreturncgg}}|jD]<}||j|||j=||fS)zm Post-process the initial list of documents to include ranking scores, if specified. )resultsappendrelevance_scoreindex)r+rA reranked_docsscoresitems r _postprocesszVoyageAIReranker._postprocesss]!#Bv $ 3 3D MM$. / / /  dj!1 2 2 2 2f$$rc |j||fi|\}}|jjdi|}|||\}}|r||fS|S) Rerank documents based on the provided query using the VoyageAI rerank API. This method processes the user's query and the provided documents to rerank them in a manner that is potentially more relevant to the query's context. Parameters: query (str): The user's search query. docs (Union[List[Dict[str, Any]], List[str]]): The list of documents to be ranked, either as dictionaries or strings. Returns: Union[Tuple[Union[List[Dict[str, Any]], List[str]], float], List[Dict[str, Any]]]: The reranked list of documents and optionally associated scores. r#)r@r rerankrK rr*r+rr?rrArHrIs rrankzVoyageAIReranker.ranksr$)9(8(O(O(O(O%&4<&9999 $ 1 1$ A A v  ) &( (rcK|j||fi|\}}|jjdi|d{V}|||\}}|r||fS|S)rMNr#)r@rrNrKrOs rarankzVoyageAIReranker.aranks$)9(8(O(O(O(O%--@@@@@@@@@@ $ 1 1$ A A v  ) &( (r)NrTN)__name__ __module__ __qualname____doc__r r r__annotations__rr7rrintboolrrrrr@ staticmethodrfloatrKrPrR __classcell__)rs@rr r s8;==GS   KMMHc!!! (,!%) !7!7!7$s)$!7 !7  !7 TN !7!7!7!7!7!7F?htn????4 - - %d4S>&:DI&E F - - - -D %Dc3h($s)34 %s) % tCy$u+% & % % %\ % %d4S>&:DI&E F uT$sCx.)4;67d38n9MM N2 %d4S>&:DI&E F uT$sCx.)4;67d38n9MM Nrr ) r'typingrrrrrrpydanticr redisvl.utils.rerank.baser r r#rrr`s :::::::::::::::: 222222~~~~~|~~~~~r