Q ibddlZddlmZmZmZmZmZmZddlm Z ddl m Z Gdde Z dS)N)AnyDictListOptionalTupleUnion) PrivateAttr) BaseRerankerc eZdZUdZeZeed<eZeed< dde d e e e d e d e d e ef fd Zd e efdZde 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)CohereRerankera The CohereReranker class uses Cohere's API to rerank documents based on an input query. This reranker is designed to interact with Cohere's /rerank API, requiring an API key for authentication. The key can be provided directly in the `api_config` dictionary or through the `COHERE_API_KEY` environment variable. User must obtain an API key from Cohere's website (https://dashboard.cohere.com/). Additionally, the `cohere` python client must be installed with `pip install cohere`. .. code-block:: python from redisvl.utils.rerank import CohereReranker # set up the Cohere reranker with some configuration reranker = CohereReranker(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_aclientrerank-english-v3.0NTmodelrank_bylimit return_score api_configc nt|||||j|fi|dS)a Initialize the CohereReranker with specified model, ranking criteria, and API configuration. Parameters: model (str): The identifier for the Cohere model used for reranking. Defaults to 'rerank-english-v3.0'. 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 cohere 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/cohere.pyrzCohereReranker.__init__)sR> L     ! 66v66666c  ddlm}m}n#t$rtdwxYw|r|dnt jd}|std|d |dd||_|d |dd||_ d S) zi Setup the Cohere clients using the provided API key or an environment variable. r) AsyncClientClientziCohere reranker requires the cohere library. Please install with `pip install cohere`api_keyCOHERE_API_KEYzdCohere API key is required. Provide it in api_config or set the COHERE_API_KEY environment variable.redisvl)r" client_nameN) coherer r! ImportErrorgetosgetenv ValueErrorr r)rrrr r!r"s rrz"CohereReranker._initialize_clientsMs   2 2 2 2 2 2 2 2 2   >  *4 TJNN9 % % %CS9T9T  [ vOg9OOOO # UGUUfUU s %querydocsc |d|j}|d|j}|d}|d|jpg}t |t r|gn|}|j||||d}td|Dr|r||d<ntd||fS) zo Prepare and validate reranking config based on provided input and optional overrides. rrmax_chunks_per_docr)rr-top_n documentsr0c3@K|]}t|tVdS)N) isinstancedict).0docs r z-CohereReranker._preprocess..|s,55z#t$$555555r rank_fieldszLIf reranking dictionary-like docs, you must provide a list of rank_by fields) r)rrrr4strrallr,) rr-r.rrrr0rreranker_kwargss r _preprocesszCohereReranker._preprocessgs 7DJ//zz.$2CDD #ZZ(<==**Y 55;)'377D7))WZ"4    55555 5 5  18 .. @  ,,rrankingsreturncgg}}|jD]<}||j|||j=||fS)zm Post-process the initial list of documents to include ranking scores, if specified. )resultsappendrelevance_scoreindex)r.r> reranked_docsscoresitems r _postprocesszCohereReranker._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 Cohere 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 rerankrH rr-r.rr<rr>rErFs rrankzCohereReranker.ranksr$)9(8(O(O(O(O%&4<&9999 $ 1 1$ A A v  ) &( (rcK|j||fi|\}}|jjdi|d{V}|||\}}|r||fS|S)rJNr&)r=rrKrHrLs rarankzCohereReranker.aranks$)9(8(O(O(O(O%--@@@@@@@@@@ $ 1 1$ A A v  ) &( (r)rNrTN)__name__ __module__ __qualname____doc__r r r__annotations__rr:rrintboolrrrrr= staticmethodrfloatrHrMrO __classcell__)rs@rr r s8;==GS   KMMHc!!!+'+!%) "7"7"7$s)$"7 "7  "7 TN "7"7"7"7"7"7HVhtnVVVV4-- %d4S>&:DI&E F----@ %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