langchain 0.3.26__py3-none-any.whl → 0.4.0.dev0__py3-none-any.whl

langchain/retrievers/llama_index.py

@@ -25,6 +25,6 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
-    "LlamaIndexRetriever",
     "LlamaIndexGraphRetriever",
+    "LlamaIndexRetriever",
 ]

langchain/retrievers/merger_retriever.py

@@ -31,9 +31,7 @@ class MergerRetriever(BaseRetriever):
         """
 
         # Merge the results of the retrievers.
-        merged_documents = self.merge_documents(query, run_manager)
-
-        return merged_documents
+        return self.merge_documents(query, run_manager)
 
     async def _aget_relevant_documents(
         self,
@@ -52,12 +50,12 @@ class MergerRetriever(BaseRetriever):
         """
 
         # Merge the results of the retrievers.
-        merged_documents = await self.amerge_documents(query, run_manager)
-
-        return merged_documents
+        return await self.amerge_documents(query, run_manager)
 
     def merge_documents(
-        self, query: str, run_manager: CallbackManagerForRetrieverRun
+        self,
+        query: str,
+        run_manager: CallbackManagerForRetrieverRun,
     ) -> list[Document]:
         """
         Merge the results of the retrievers.
@@ -82,14 +80,16 @@ class MergerRetriever(BaseRetriever):
         merged_documents = []
         max_docs = max(map(len, retriever_docs), default=0)
         for i in range(max_docs):
-            for retriever, doc in zip(self.retrievers, retriever_docs):
+            for _retriever, doc in zip(self.retrievers, retriever_docs):
                 if i < len(doc):
                     merged_documents.append(doc[i])
 
         return merged_documents
 
     async def amerge_documents(
-        self, query: str, run_manager: AsyncCallbackManagerForRetrieverRun
+        self,
+        query: str,
+        run_manager: AsyncCallbackManagerForRetrieverRun,
     ) -> list[Document]:
         """
         Asynchronously merge the results of the retrievers.
@@ -109,14 +109,14 @@ class MergerRetriever(BaseRetriever):
                     config={"callbacks": run_manager.get_child(f"retriever_{i + 1}")},
                 )
                 for i, retriever in enumerate(self.retrievers)
-            )
+            ),
         )
 
         # Merge the results of the retrievers.
         merged_documents = []
         max_docs = max(map(len, retriever_docs), default=0)
         for i in range(max_docs):
-            for retriever, doc in zip(self.retrievers, retriever_docs):
+            for _retriever, doc in zip(self.retrievers, retriever_docs):
                 if i < len(doc):
                     merged_documents.append(doc[i])
 

langchain/retrievers/milvus.py

@@ -23,6 +23,6 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
-    "MilvusRetriever",
     "MilvusRetreiver",
+    "MilvusRetriever",
 ]

langchain/retrievers/multi_query.py

@@ -14,6 +14,7 @@ from langchain_core.prompts import BasePromptTemplate
 from langchain_core.prompts.prompt import PromptTemplate
 from langchain_core.retrievers import BaseRetriever
 from langchain_core.runnables import Runnable
+from typing_extensions import override
 
 from langchain.chains.llm import LLMChain
 
@@ -23,6 +24,7 @@ logger = logging.getLogger(__name__)
 class LineListOutputParser(BaseOutputParser[list[str]]):
     """Output parser for a list of lines."""
 
+    @override
     def parse(self, text: str) -> list[str]:
         lines = text.strip().split("\n")
         return list(filter(None, lines))  # Remove empty lines
@@ -31,12 +33,12 @@ class LineListOutputParser(BaseOutputParser[list[str]]):
 # Default prompt
 DEFAULT_QUERY_PROMPT = PromptTemplate(
     input_variables=["question"],
-    template="""You are an AI language model assistant. Your task is 
-    to generate 3 different versions of the given user 
-    question to retrieve relevant documents from a vector  database. 
-    By generating multiple perspectives on the user question, 
-    your goal is to help the user overcome some of the limitations 
-    of distance-based similarity search. Provide these alternative 
+    template="""You are an AI language model assistant. Your task is
+    to generate 3 different versions of the given user
+    question to retrieve relevant documents from a vector  database.
+    By generating multiple perspectives on the user question,
+    your goal is to help the user overcome some of the limitations
+    of distance-based similarity search. Provide these alternative
     questions separated by newlines. Original question: {question}""",
 )
 
@@ -65,8 +67,8 @@ class MultiQueryRetriever(BaseRetriever):
         retriever: BaseRetriever,
         llm: BaseLanguageModel,
         prompt: BasePromptTemplate = DEFAULT_QUERY_PROMPT,
-        parser_key: Optional[str] = None,
-        include_original: bool = False,
+        parser_key: Optional[str] = None,  # noqa: ARG003
+        include_original: bool = False,  # noqa: FBT001,FBT002
     ) -> "MultiQueryRetriever":
         """Initialize from llm using default template.
 
@@ -110,7 +112,9 @@ class MultiQueryRetriever(BaseRetriever):
         return self.unique_union(documents)
 
     async def agenerate_queries(
-        self, question: str, run_manager: AsyncCallbackManagerForRetrieverRun
+        self,
+        question: str,
+        run_manager: AsyncCallbackManagerForRetrieverRun,
     ) -> list[str]:
         """Generate queries based upon user input.
 
@@ -121,18 +125,18 @@ class MultiQueryRetriever(BaseRetriever):
             List of LLM generated queries that are similar to the user input
         """
         response = await self.llm_chain.ainvoke(
-            {"question": question}, config={"callbacks": run_manager.get_child()}
+            {"question": question},
+            config={"callbacks": run_manager.get_child()},
         )
-        if isinstance(self.llm_chain, LLMChain):
-            lines = response["text"]
-        else:
-            lines = response
+        lines = response["text"] if isinstance(self.llm_chain, LLMChain) else response
         if self.verbose:
-            logger.info(f"Generated queries: {lines}")
+            logger.info("Generated queries: %s", lines)
         return lines
 
     async def aretrieve_documents(
-        self, queries: list[str], run_manager: AsyncCallbackManagerForRetrieverRun
+        self,
+        queries: list[str],
+        run_manager: AsyncCallbackManagerForRetrieverRun,
     ) -> list[Document]:
         """Run all LLM generated queries.
 
@@ -145,10 +149,11 @@ class MultiQueryRetriever(BaseRetriever):
         document_lists = await asyncio.gather(
             *(
                 self.retriever.ainvoke(
-                    query, config={"callbacks": run_manager.get_child()}
+                    query,
+                    config={"callbacks": run_manager.get_child()},
                 )
                 for query in queries
-            )
+            ),
         )
         return [doc for docs in document_lists for doc in docs]
 
@@ -173,7 +178,9 @@ class MultiQueryRetriever(BaseRetriever):
         return self.unique_union(documents)
 
     def generate_queries(
-        self, question: str, run_manager: CallbackManagerForRetrieverRun
+        self,
+        question: str,
+        run_manager: CallbackManagerForRetrieverRun,
     ) -> list[str]:
         """Generate queries based upon user input.
 
@@ -184,18 +191,18 @@ class MultiQueryRetriever(BaseRetriever):
             List of LLM generated queries that are similar to the user input
         """
         response = self.llm_chain.invoke(
-            {"question": question}, config={"callbacks": run_manager.get_child()}
+            {"question": question},
+            config={"callbacks": run_manager.get_child()},
         )
-        if isinstance(self.llm_chain, LLMChain):
-            lines = response["text"]
-        else:
-            lines = response
+        lines = response["text"] if isinstance(self.llm_chain, LLMChain) else response
         if self.verbose:
-            logger.info(f"Generated queries: {lines}")
+            logger.info("Generated queries: %s", lines)
         return lines
 
     def retrieve_documents(
-        self, queries: list[str], run_manager: CallbackManagerForRetrieverRun
+        self,
+        queries: list[str],
+        run_manager: CallbackManagerForRetrieverRun,
     ) -> list[Document]:
         """Run all LLM generated queries.
 
@@ -208,7 +215,8 @@ class MultiQueryRetriever(BaseRetriever):
         documents = []
         for query in queries:
             docs = self.retriever.invoke(
-                query, config={"callbacks": run_manager.get_child()}
+                query,
+                config={"callbacks": run_manager.get_child()},
             )
             documents.extend(docs)
         return documents

langchain/retrievers/multi_vector.py

@@ -10,6 +10,7 @@ from langchain_core.retrievers import BaseRetriever
 from langchain_core.stores import BaseStore, ByteStore
 from langchain_core.vectorstores import VectorStore
 from pydantic import Field, model_validator
+from typing_extensions import override
 
 from langchain.storage._lc_store import create_kv_docstore
 
@@ -43,18 +44,23 @@ class MultiVectorRetriever(BaseRetriever):
 
     @model_validator(mode="before")
     @classmethod
-    def shim_docstore(cls, values: dict) -> Any:
+    def _shim_docstore(cls, values: dict) -> Any:
         byte_store = values.get("byte_store")
         docstore = values.get("docstore")
         if byte_store is not None:
             docstore = create_kv_docstore(byte_store)
         elif docstore is None:
-            raise Exception("You must pass a `byte_store` parameter.")
+            msg = "You must pass a `byte_store` parameter."
+            raise ValueError(msg)
         values["docstore"] = docstore
         return values
 
+    @override
     def _get_relevant_documents(
-        self, query: str, *, run_manager: CallbackManagerForRetrieverRun
+        self,
+        query: str,
+        *,
+        run_manager: CallbackManagerForRetrieverRun,
     ) -> list[Document]:
         """Get documents relevant to a query.
         Args:
@@ -65,12 +71,14 @@ class MultiVectorRetriever(BaseRetriever):
         """
         if self.search_type == SearchType.mmr:
             sub_docs = self.vectorstore.max_marginal_relevance_search(
-                query, **self.search_kwargs
+                query,
+                **self.search_kwargs,
             )
         elif self.search_type == SearchType.similarity_score_threshold:
             sub_docs_and_similarities = (
                 self.vectorstore.similarity_search_with_relevance_scores(
-                    query, **self.search_kwargs
+                    query,
+                    **self.search_kwargs,
                 )
             )
             sub_docs = [sub_doc for sub_doc, _ in sub_docs_and_similarities]
@@ -85,8 +93,12 @@ class MultiVectorRetriever(BaseRetriever):
         docs = self.docstore.mget(ids)
         return [d for d in docs if d is not None]
 
+    @override
     async def _aget_relevant_documents(
-        self, query: str, *, run_manager: AsyncCallbackManagerForRetrieverRun
+        self,
+        query: str,
+        *,
+        run_manager: AsyncCallbackManagerForRetrieverRun,
     ) -> list[Document]:
         """Asynchronously get documents relevant to a query.
         Args:
@@ -97,18 +109,21 @@ class MultiVectorRetriever(BaseRetriever):
         """
         if self.search_type == SearchType.mmr:
             sub_docs = await self.vectorstore.amax_marginal_relevance_search(
-                query, **self.search_kwargs
+                query,
+                **self.search_kwargs,
             )
         elif self.search_type == SearchType.similarity_score_threshold:
             sub_docs_and_similarities = (
                 await self.vectorstore.asimilarity_search_with_relevance_scores(
-                    query, **self.search_kwargs
+                    query,
+                    **self.search_kwargs,
                 )
             )
             sub_docs = [sub_doc for sub_doc, _ in sub_docs_and_similarities]
         else:
             sub_docs = await self.vectorstore.asimilarity_search(
-                query, **self.search_kwargs
+                query,
+                **self.search_kwargs,
             )
 
         # We do this to maintain the order of the ids that are returned

langchain/retrievers/parent_document_retriever.py

@@ -54,6 +54,7 @@ class ParentDocumentRetriever(MultiVectorRetriever):
                 child_splitter=child_splitter,
                 parent_splitter=parent_splitter,
             )
+
     """  # noqa: E501
 
     child_splitter: TextSplitter
@@ -66,7 +67,7 @@ class ParentDocumentRetriever(MultiVectorRetriever):
     If none, then the parent documents will be the raw documents passed in."""
 
     child_metadata_fields: Optional[Sequence[str]] = None
-    """Metadata fields to leave in child documents. If None, leave all parent document 
+    """Metadata fields to leave in child documents. If None, leave all parent document
         metadata.
     """
 
@@ -74,6 +75,7 @@ class ParentDocumentRetriever(MultiVectorRetriever):
         self,
         documents: list[Document],
         ids: Optional[list[str]] = None,
+        *,
         add_to_docstore: bool = True,
     ) -> tuple[list[Document], list[tuple[str, Document]]]:
         if self.parent_splitter is not None:
@@ -81,15 +83,15 @@ class ParentDocumentRetriever(MultiVectorRetriever):
         if ids is None:
             doc_ids = [str(uuid.uuid4()) for _ in documents]
             if not add_to_docstore:
-                raise ValueError(
-                    "If ids are not passed in, `add_to_docstore` MUST be True"
-                )
+                msg = "If ids are not passed in, `add_to_docstore` MUST be True"
+                raise ValueError(msg)
         else:
             if len(documents) != len(ids):
-                raise ValueError(
+                msg = (
                     "Got uneven list of documents and ids. "
                     "If `ids` is provided, should be same length as `documents`."
                 )
+                raise ValueError(msg)
             doc_ids = ids
 
         docs = []
@@ -113,7 +115,7 @@ class ParentDocumentRetriever(MultiVectorRetriever):
         self,
         documents: list[Document],
         ids: Optional[list[str]] = None,
-        add_to_docstore: bool = True,
+        add_to_docstore: bool = True,  # noqa: FBT001,FBT002
         **kwargs: Any,
     ) -> None:
         """Adds documents to the docstore and vectorstores.
@@ -130,7 +132,11 @@ class ParentDocumentRetriever(MultiVectorRetriever):
                 to set this to False if the documents are already in the docstore
                 and you don't want to re-add them.
         """
-        docs, full_docs = self._split_docs_for_adding(documents, ids, add_to_docstore)
+        docs, full_docs = self._split_docs_for_adding(
+            documents,
+            ids,
+            add_to_docstore=add_to_docstore,
+        )
         self.vectorstore.add_documents(docs, **kwargs)
         if add_to_docstore:
             self.docstore.mset(full_docs)
@@ -139,10 +145,28 @@ class ParentDocumentRetriever(MultiVectorRetriever):
         self,
         documents: list[Document],
         ids: Optional[list[str]] = None,
-        add_to_docstore: bool = True,
+        add_to_docstore: bool = True,  # noqa: FBT001,FBT002
         **kwargs: Any,
     ) -> None:
-        docs, full_docs = self._split_docs_for_adding(documents, ids, add_to_docstore)
+        """Adds documents to the docstore and vectorstores.
+
+        Args:
+            documents: List of documents to add
+            ids: Optional list of ids for documents. If provided should be the same
+                length as the list of documents. Can be provided if parent documents
+                are already in the document store and you don't want to re-add
+                to the docstore. If not provided, random UUIDs will be used as
+                ids.
+            add_to_docstore: Boolean of whether to add documents to docstore.
+                This can be false if and only if `ids` are provided. You may want
+                to set this to False if the documents are already in the docstore
+                and you don't want to re-add them.
+        """
+        docs, full_docs = self._split_docs_for_adding(
+            documents,
+            ids,
+            add_to_docstore=add_to_docstore,
+        )
         await self.vectorstore.aadd_documents(docs, **kwargs)
         if add_to_docstore:
             await self.docstore.amset(full_docs)

langchain/retrievers/re_phraser.py

@@ -71,13 +71,14 @@ class RePhraseQueryRetriever(BaseRetriever):
             Relevant documents for re-phrased question
         """
         re_phrased_question = self.llm_chain.invoke(
-            query, {"callbacks": run_manager.get_child()}
+            query,
+            {"callbacks": run_manager.get_child()},
         )
-        logger.info(f"Re-phrased question: {re_phrased_question}")
-        docs = self.retriever.invoke(
-            re_phrased_question, config={"callbacks": run_manager.get_child()}
+        logger.info("Re-phrased question: %s", re_phrased_question)
+        return self.retriever.invoke(
+            re_phrased_question,
+            config={"callbacks": run_manager.get_child()},
         )
-        return docs
 
     async def _aget_relevant_documents(
         self,