Ig>dZddlmZddlZddlmZmZddlmZddl m Z m Z m Z ddl mZddlmZdd lmZdd lmZdd lmZmZmZmZdd lmZe r dd lmZmZmZe Z!e"eZ#ee!e#fZ$ee e#fZ%GddedZ&Gddee!e#feZ'y)a**Retriever** class returns Documents 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. **Class hierarchy:** .. code-block:: BaseRetriever --> Retriever # Examples: ArxivRetriever, MergerRetriever **Main helpers:** .. code-block:: RetrieverInput, RetrieverOutput, RetrieverLike, RetrieverOutputLike, Document, Serializable, Callbacks, CallbackManagerForRetrieverRun, AsyncCallbackManagerForRetrieverRun ) annotationsN)ABCabstractmethod) signature) TYPE_CHECKINGAnyOptional) ConfigDict) TypedDict) deprecated)Document)RunnableRunnableConfigRunnableSerializable ensure_config)run_in_executor)#AsyncCallbackManagerForRetrieverRunCallbackManagerForRetrieverRun Callbacksc@eZdZUdZded< ded< ded< ded<y) LangSmithRetrieverParamsz!LangSmith parameters for tracing.strls_retriever_name Optional[str]ls_vector_store_providerls_embedding_providerls_embedding_modelN)__name__ __module__ __qualname____doc____annotations__V/var/www/html/answerous/venv/lib/python3.12/site-packages/langchain_core/retrievers.pyrr7s)+++ ((%%r$rF)totalcveZdZUdZedZdZded<dZded<dZ d ed < dZ d ed < dfd Z ddZ d ddZ d ddZe ddZ d dZedddddddd d!dZedddddddd d!dZxZS)" 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: A retriever that returns the first 5 documents from a list of documents .. code-block:: python from langchain_core import Document, BaseRetriever from typing import List 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: A simple retriever based on a scikit-learn vectorizer .. code-block:: 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_allowedFbool_new_arg_supported_expects_other_argsNOptional[list[str]]tagsOptional[dict[str, Any]]metadatac t|d i||jtjk7rDt j dt d|j}tj|_||_t|dra|jtjk7rDt j dt d|j}tj|_ ||_ t|jj}|jddu|_tt!|j#hdz dkD|_y) NzgRetrievers must implement abstract `_get_relevant_documents` method instead of `get_relevant_documents`) stacklevelaget_relevant_documentsziRetrievers must implement abstract `_aget_relevant_documents` method instead of `aget_relevant_documents` run_manager>selfqueryr5rr#)super__init_subclass__get_relevant_documentsr(warningswarnDeprecationWarning_get_relevant_documentshasattrr4_aget_relevant_documentsr parametersgetr+lensetkeysr,)clskwargsswapaswaprA __class__s r%r9zBaseRetriever.__init_subclass__s !+F+  % %)M)M M MM7"   --D44  &+/C ' C2 3++}/T/TT MM8"   //E55  ',1C (s::;FF !+ !>d!J JOO%&)II JQ N r$c |j}|jdr|dd}n|jdr|dd}|j}t |}|S)z Get standard params for tracing. Retriever Ni)r)get_name startswithendswithlowerr)r6rGdefault_retriever_name ls_paramss r%_get_ls_paramszBaseRetriever._get_ls_paramssf"& ! , ,[ 9%;AB%? " # , ,[ 9%;CR%@ "!7!=!=!?,?UV r$c ddlm}t|}i|jdxsi|jdi|}|j |jdd|jdd|jd|j ||j }|jd||jd xs|j|jd d } |jr|ni}|jr|j|fd |i|} n|j|fi|} |j| | S#t$r} |j!| | d} ~ wwxYw)aInvoke the retriever to get relevant documents. Main entry point for synchronous retriever invocations. Args: input: The query string. config: Configuration for the retriever. Defaults to None. kwargs: Additional arguments to pass to the retriever. Returns: List of relevant documents. Examples: .. code-block:: python retriever.invoke("query") r)CallbackManagerr0 callbacksNverboseFr.rXinheritable_tags local_tagsinheritable_metadatalocal_metadatarun_namerun_idnamer_r5r#) langchain_core.callbacks.managerrVrrBrT configurer.r0on_retriever_startrNpopr,r+r>on_retriever_end Exceptionon_retriever_error) r6inputconfigrGrVr\callback_managerr5_kwargsresultes r%invokezBaseRetriever.invokesv* Ev& zz*%+ !d!!+F+ +44 JJ{ # JJy%0#ZZ/yy!5==5 '99  J':4==?::h- :   $ 8 8fbG&&555'26=655eGwG  ( ( M   * *1 -G sAD44 E=EEc Kddlm}t|}i|jdxsi|jdi|}|j |jdd|jdd|jd|j ||j }|jd||jd xs|j|jd d d{} |jr|ni}|jr|j|fd |i|d{} n|j|fi|d{} |j| d{| S7u7=7#7 #t$r!} |j!| d{7| d} ~ wwxYww)aAsynchronously invoke the retriever to get relevant documents. Main entry point for asynchronous retriever invocations. Args: input: The query string. config: Configuration for the retriever. Defaults to None. kwargs: Additional arguments to pass to the retriever. Returns: List of relevant documents. Examples: .. code-block:: python await retriever.ainvoke("query") r)AsyncCallbackManagerr0rWNrXFr.rYr^r_r`r5r#)rbrqrrBrTrcr.r0rdrNrer,r+r@rfrgrh) r6rirjrGrqr\rkr5rlrmrns r%ainvokezBaseRetriever.ainvokes0 Jv& zz*%+ !d!!+F+ 099 JJ{ # JJy%0#ZZ/yy!5==: -??  J':4==?::h- @    $ 8 8fbG&&<FFF cy)zGet 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#r6r7r5s r%r>z%BaseRetriever._get_relevant_documentsDsr$clKtd|j||jd{S7w)zAsynchronously 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)r5)rr>get_syncrts r%r@z&BaseRetriever._aget_relevant_documentsQs:%   ( ( #,,.     s +424z0.1.46roz1.0)since alternativeremoval)rWr.r0r^c fi}|r||d<|r||d<|r||d<|r||d<|j||fi|S)a Retrieve documents relevant to a query. Users should favor using `.invoke` or `.batch` rather than `get_relevant_documents directly`. Args: query: string to find relevant documents for. callbacks: Callback manager or list of callbacks. Defaults to None. tags: Optional list of tags associated with the retriever. These tags will be associated with each call to this retriever, and passed as arguments to the handlers defined in `callbacks`. Defaults to None. metadata: Optional metadata associated with the retriever. This metadata will be associated with each call to this retriever, and passed as arguments to the handlers defined in `callbacks`. Defaults to None. run_name: Optional name for the run. Defaults to None. kwargs: Additional arguments to pass to the retriever. Returns: List of relevant documents. rWr.r0r^)ror6r7rWr.r0r^rGrjs r%r:z$BaseRetriever.get_relevant_documentscsUB"$ "+F;  !F6N !)F:  !)F: t{{5&3F33r$rrcKi}|r||d<|r||d<|r||d<|r||d<|j||fi|d{S7w)aAsynchronously get documents relevant to a query. Users should favor using `.ainvoke` or `.abatch` rather than `aget_relevant_documents directly`. Args: query: string to find relevant documents for. callbacks: Callback manager or list of callbacks. tags: Optional list of tags associated with the retriever. These tags will be associated with each call to this retriever, and passed as arguments to the handlers defined in `callbacks`. Defaults to None. metadata: Optional metadata associated with the retriever. This metadata will be associated with each call to this retriever, and passed as arguments to the handlers defined in `callbacks`. Defaults to None. run_name: Optional name for the run. Defaults to None. kwargs: Additional arguments to pass to the retriever. Returns: List of relevant documents. rWr.r0r^N)rrr{s r%r4z%BaseRetriever.aget_relevant_documentss_B"$ "+F;  !F6N !)F:  !)F: !T\\%:6::::s 6?=?)rGrreturnNone)rGrr}r)N)rirrjzOptional[RunnableConfig]rGrr}list[Document])r7rr5rr}r)r7rr5rr}r)r7rrWrr.r-r0r/r^rrGrr}r)rrr r!r model_configr+r"r,r.r0r9rTrorrrr>r@r r:r4 __classcell__)rJs@r%r(r(Ds:x $L %$ %% $D $ *.H&-$ L >B::"::MP: :~,0==)= =  =~    *H        *M  $hHeD $$(-1"&)4)4 )4 " )4 + )4 )4)4 )4E)4VhIuE $$(-1"&);); ); " ); + ); );); );F);r$r()(r! __future__rr;abcrrinspectrtypingrrr pydanticr typing_extensionsr langchain_core._apir langchain_core.documentsr langchain_core.runnablesrrrrlangchain_core.runnables.configrrbrrrrRetrieverInputlistRetrieverOutput RetrieverLikeRetrieverOutputLikerr(r#r$r%rs*##//'*- < x.89 sO34 y u;()HI3u;r$