Ë
    ñÏj©+  ã                  ó  — d Z ddlmZ ddlmZmZ ddlmZmZ ddl	m
Z
 ddlmZmZmZ ddlmZmZ ddlmZ dd	lmZmZmZmZ dd
lmZ ddlmZ erddlmZmZ eZ e!e   Z"ee e"f   Z#eee"f   Z$ G d„ ded¬«      Z% G d„ dee e"f   e«      Z&y)a5  **Retriever** class returns `Document` objects given a text **query**.

It is more general than a vector store. A retriever does not need to be able to
store documents, only to return (or retrieve) it. Vector stores can be used as
the backbone of a retriever, but there are other types of retrievers as well.
é    )Úannotations)ÚABCÚabstractmethod)ÚTYPE_CHECKINGÚAny)Ú
ConfigDict)ÚSelfÚ	TypedDictÚoverride)ÚAsyncCallbackManagerÚCallbackManager)ÚDocument)ÚRunnableÚRunnableConfigÚRunnableSerializableÚensure_config)Úrun_in_executor)Ú_signature_parameters)Ú#AsyncCallbackManagerForRetrieverRunÚCallbackManagerForRetrieverRunc                  ó@   — e Zd ZU dZded<   	 ded<   	 ded<   	 ded<   y)	ÚLangSmithRetrieverParamsz!LangSmith parameters for tracing.ÚstrÚls_retriever_namez
str | NoneÚls_vector_store_providerÚls_embedding_providerÚls_embedding_modelN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__Ú__annotations__© ó    úV/var/www/html/gaurav-v2/venv/lib/python3.12/site-packages/langchain_core/retrievers.pyr   r   '   s)   … Ù+àÓØà(Ó(Ø à%Ó%Øà"Ó"Ør$   r   F)Útotalc                  ó   ‡ — e Zd ZU dZ ed¬«      ZdZded<   dZded<   dZ	d	ed
<   	 dZ
ded<   	 edˆ fd„«       Zdd„Ze	 d	 	 	 	 	 	 	 dd„«       Ze	 d	 	 	 	 	 	 	 dd„«       Ze	 	 	 	 	 	 dd„«       Z	 	 	 	 	 	 dd„Zˆ xZS )ÚBaseRetrievera¾  Abstract base class for a document retrieval system.

    A retrieval system is defined as something that can take string queries and return
    the most 'relevant' documents from some source.

    Usage:

    A retriever follows the standard `Runnable` interface, and should be used via the
    standard `Runnable` methods of `invoke`, `ainvoke`, `batch`, `abatch`.

    Implementation:

    When implementing a custom retriever, the class should implement the
    `_get_relevant_documents` method to define the logic for retrieving documents.

    Optionally, an async native implementations can be provided by overriding the
    `_aget_relevant_documents` method.

    !!! example "Retriever that returns the first 5 documents from a list of documents"

        ```python
        from langchain_core.documents import Document
        from langchain_core.retrievers import BaseRetriever

        class SimpleRetriever(BaseRetriever):
            docs: list[Document]
            k: int = 5

            def _get_relevant_documents(self, query: str) -> list[Document]:
                """Return the first k documents from the list of documents"""
                return self.docs[:self.k]

            async def _aget_relevant_documents(self, query: str) -> list[Document]:
                """(Optional) async native implementation."""
                return self.docs[:self.k]
        ```

    !!! example "Simple retriever based on a scikit-learn vectorizer"

        ```python
        from sklearn.metrics.pairwise import cosine_similarity


        class TFIDFRetriever(BaseRetriever, BaseModel):
            vectorizer: Any
            docs: list[Document]
            tfidf_array: Any
            k: int = 4

            class Config:
                arbitrary_types_allowed = True

            def _get_relevant_documents(self, query: str) -> list[Document]:
                # Ip -- (n_docs,x), Op -- (n_docs,n_Feats)
                query_vec = self.vectorizer.transform([query])
                # Op -- (n_docs,1) -- Cosine Sim with each doc
                results = cosine_similarity(self.tfidf_array, query_vec).reshape((-1,))
                return [self.docs[i] for i in results.argsort()[-self.k :][::-1]]
        ```
    T)Úarbitrary_types_allowedFÚboolÚ_new_arg_supportedÚ_expects_other_argsNzlist[str] | NoneÚtagszdict[str, Any] | NoneÚmetadatac                óP  •— t        ‰| �  di |¤Ž t        | j                  «      }|j	                  d«      d u| _        | j
                  s.| j                  t        j                  k(  r	 	 	 	 	 	 dd„}|| _        t        t        |j                  «       «      h d£z
  «      dkD  | _        y )NÚrun_managerc              “  óL   K  — t        d | j                  |«      ƒ d {  –—† S 7 Œ­w©N)r   Ú_get_relevant_documents)ÚselfÚquerys     r%   Ú_aget_relevant_documentszABaseRetriever.__init_subclass__.<locals>._aget_relevant_documents›   s$   è ø€ ô -¨T°4×3OÑ3OÐQVÓW×WÐWÐWús   ‚$�"ž$>   r4   r5   r0   r   r#   )r4   r	   r5   r   Úreturnúlist[Document])ÚsuperÚ__init_subclass__r   r3   Úgetr+   r6   r(   ÚlenÚsetÚkeysr,   )ÚclsÚkwargsÚ
parametersr6   Ú	__class__s       €r%   r:   zBaseRetriever.__init_subclass__‘   s«   ø€ ä‰Ñ!Ñ+ FÒ+Ü*¨3×+FÑ+FÓGˆ
Ø!+§¡°Ó!>ÀdÐ!JˆÔà×&Ò&Ø×,Ñ,´×0VÑ0VÒVðXØðXØ#&ðXàóXð
 ,DˆCÔ(ô ”�J—O‘OÓ%Ó&Ò)IÑIÓJÈQÑNð 	Õr$   c                ó´   — | j                  «       }|j                  d«      r|dd }n|j                  d«      r|dd }|j                  «       }t	        |¬«      S )z Get standard params for tracing.Ú	Retrieveré	   Ni÷ÿÿÿ)r   )Úget_nameÚ
startswithÚendswithÚlowerr   )r4   Ú_kwargsÚdefault_retriever_names      r%   Ú_get_ls_paramszBaseRetriever._get_ls_params§   s_   € à!%§¡£ÐØ!×,Ñ,¨[Ô9Ø%;¸A¸BÐ%?Ñ"Ø#×,Ñ,¨[Ô9Ø%;¸C¸RÐ%@Ð"Ø!7×!=Ñ!=Ó!?Ðä'Ð:PÔQÐQr$   c           	     óª  — t        |«      }i |j                  d«      xs i ¥ | j                  di |¤Ž¥}t        j                  |j                  d«      d|j                  dd«      |j                  d«      | j
                  || j                  ¬«      }|j                  d||j                  d«      xs | j                  «       |j                  d	d«      ¬
«      }	 | j                  r|ni }| j                  r | j                  |fd|i|¤Ž}n | j                  |fi |¤Ž}|j                  |«       |S # t        $ r}	|j                  |	«       ‚ d}	~	ww xY w)a´  Invoke the retriever to get relevant documents.

        Main entry point for synchronous retriever invocations.

        Args:
            input: The query string.
            config: Configuration for the retriever.
            **kwargs: Additional arguments to pass to the retriever.

        Returns:
            List of relevant documents.

        Examples:
        ```python
        retriever.invoke("query")
        ```
        r.   Ú	callbacksNÚverboseFr-   ©rO   Úinheritable_tagsÚ
local_tagsÚinheritable_metadataÚlocal_metadataÚrun_nameÚrun_id©ÚnamerV   r0   r#   )r   r;   rL   r   Ú	configurer-   r.   Úon_retriever_startrF   Úpopr,   r+   r3   Úon_retriever_endÚ	ExceptionÚon_retriever_error©
r4   ÚinputÚconfigr@   rS   Úcallback_managerr0   Úkwargs_ÚresultÚes
             r%   ÚinvokezBaseRetriever.invoke²   sk  € ô* ˜vÓ&ˆð 
Ø�z‰z˜*Ó%Ò+¨ð 
à!ˆd×!Ñ!Ñ+ FÑ+ð 
Ðô +×4Ñ4Ø�J‰J�{Ó#ØØ—J‘J˜y¨%Ó0Ø#ŸZ™Z¨Ó/Ø—y‘yØ!5ØŸ=™=ô
Ðð '×9Ñ9ØØØ—‘˜JÓ'Ò:¨4¯=©=«?Ø—:‘:˜h¨Ó-ð	 :ó 
ˆð	Ø $× 8Ò 8‘f¸bˆGØ×&Ò&Ø5˜×5Ñ5ØñØ'2ðØ6=ñ‘ð 6˜×5Ñ5°eÑG¸wÑG�ð
 ×(Ñ(Øôð ˆMøô ò 	Ø×*Ñ*¨1Ô-Øûð	ús   ÃAD2 Ä2	EÄ;EÅEc           	   ‹  ó  K  — t        |«      }i |j                  d«      xs i ¥ | j                  di |¤Ž¥}t        j                  |j                  d«      d|j                  dd«      |j                  d«      | j
                  || j                  ¬«      }|j                  d||j                  d«      xs | j                  «       |j                  d	d«      ¬
«      ƒ d{  –—† }	 | j                  r|ni }| j                  r | j                  |fd|i|¤Žƒ d{  –—† }n | j                  |fi |¤Žƒ d{  –—† }|j                  |«      ƒ d{  –—†  |S 7 Œu7 Œ=7 Œ#7 Œ# t        $ r }	|j                  |	«      ƒ d{  –—†7   ‚ d}	~	ww xY w­w)aË  Asynchronously invoke the retriever to get relevant documents.

        Main entry point for asynchronous retriever invocations.

        Args:
            input: The query string.
            config: Configuration for the retriever.
            **kwargs: Additional arguments to pass to the retriever.

        Returns:
            List of relevant documents.

        Examples:
        ```python
        await retriever.ainvoke("query")
        ```
        r.   rN   NrO   Fr-   rP   rU   rV   rW   r0   r#   )r   r;   rL   r   rY   r-   r.   rZ   rF   r[   r,   r+   r6   r\   r]   r^   r_   s
             r%   ÚainvokezBaseRetriever.ainvokeì   s¤  è ø€ ô0 ˜vÓ&ˆð 
Ø�z‰z˜*Ó%Ò+¨ð 
à!ˆd×!Ñ!Ñ+ FÑ+ð 
Ðô 0×9Ñ9Ø�J‰J�{Ó#ØØ—J‘J˜y¨%Ó0Ø#ŸZ™Z¨Ó/Ø—y‘yØ!5ØŸ=™=ô
Ðð -×?Ñ?ØØØ—‘˜JÓ'Ò:¨4¯=©=«?Ø—:‘:˜h¨Ó-ð	 @ó 
÷ 
ˆð	Ø $× 8Ò 8‘f¸bˆGØ×&Ò&Ø<˜t×<Ñ<Øñ Ø'2ð Ø6=ñ ÷ ‘ð  =˜t×<Ñ<¸UÑNÀgÑN×N�ð
 ×.Ñ.Øó÷ ð ð ˆMð+
øðøð Oøð
ùô	 ò 	Ø×0Ñ0°Ó3×3Ñ3Øûð	üsx   ‚CFÃEÃFÃ$4E ÄEÄE Ä4EÄ5E Ä9FÅEÅFÅE ÅE ÅFÅ	FÅ%F Å9E<Å:F Æ FÆFc                ó   — y)zäGet documents relevant to a query.

        Args:
            query: String to find relevant documents for.
            run_manager: The callback handler to use.

        Returns:
            List of relevant documents.
        Nr#   ©r4   r5   r0   s      r%   r3   z%BaseRetriever._get_relevant_documents)  s   � r$   c             ƒ  ól   K  — t        d| j                  ||j                  «       ¬«      ƒ d{  –—† S 7 Œ­w)zðAsynchronously get documents relevant to a query.

        Args:
            query: String to find relevant documents for
            run_manager: The callback handler to use

        Returns:
            List of relevant documents
        N)r0   )r   r3   Úget_syncrj   s      r%   r6   z&BaseRetriever._aget_relevant_documents7  s:   è ø€ ô %ØØ×(Ñ(ØØ#×,Ñ,Ó.ô	
÷ 
ð 	
ð 
ús   ‚+4­2®4)r@   r   r7   ÚNone)rJ   r   r7   r   r2   )r`   r   ra   zRunnableConfig | Noner@   r   r7   r8   )r5   r   r0   r   r7   r8   )r5   r   r0   r   r7   r8   )r   r   r    r!   r   Úmodel_configr+   r"   r,   r-   r.   r   r:   rL   rf   rh   r   r3   r6   Ú__classcell__)rB   s   @r%   r(   r(   7   s-  ø… ñ;ñz Ø $ô€Lð  %Ð˜Ó$à %Ð˜Ó%à!€DÐ
Ó!ðð '+€HÐ#Ó*ðð ô
ó ð
ó*	Rð à:>ð7Øð7Ø"7ð7ØJMð7à	ò7ó ð7ðr ð )-ð:àð:ð &ð:ð ð	:ð
 
ò:ó ð:ðx ðØðØ*Hðà	òó ðð
Øð
Ø*Mð
à	÷
r$   r(   N)'r!   Ú
__future__r   Úabcr   r   Útypingr   r   Úpydanticr   Útyping_extensionsr	   r
   r   Ú langchain_core.callbacks.managerr   r   Úlangchain_core.documentsr   Úlangchain_core.runnablesr   r   r   r   Úlangchain_core.runnables.configr   Úlangchain_core.utils._signaturer   r   r   r   ÚRetrieverInputÚlistÚRetrieverOutputÚRetrieverLikeÚRetrieverOutputLiker   r(   r#   r$   r%   Ú<module>r      s–   ðñõ #ç #ß %å ß 7Ñ 7ç RÝ -÷ó õ <Ý Aá÷ð
 €Ø�x‘.€Ø˜¨Ð8Ñ9€Ø˜s OÐ3Ñ4Ð ô˜y°õ ô Q
Ð(¨¸Ð)HÑIÈ3õ Q
r$   