langchain 0.3.25__py3-none-any.whl → 0.3.27__py3-none-any.whl

langchain/retrievers/document_compressors/listwise_rerank.py

@@ -24,7 +24,10 @@ def _get_prompt_input(input_: dict) -> dict[str, Any]:
     context = ""
     for index, doc in enumerate(documents):
         context += f"Document ID: {index}\n```{doc.page_content}```\n\n"
-    context += f"Documents = [Document ID: 0, ..., Document ID: {len(documents) - 1}]"
+    document_range = "empty list"
+    if len(documents) > 0:
+        document_range = f"Document ID: 0, ..., Document ID: {len(documents) - 1}"
+    context += f"Documents = [{document_range}]"
     return {"query": input_["query"], "context": context}
 
 
@@ -70,8 +73,8 @@ class LLMListwiseRerank(BaseDocumentCompressor):
     """
 
     reranker: Runnable[dict, list[Document]]
-    """LLM-based reranker to use for filtering documents. Expected to take in a dict 
-        with 'documents: Sequence[Document]' and 'query: str' keys and output a 
+    """LLM-based reranker to use for filtering documents. Expected to take in a dict
+        with 'documents: Sequence[Document]' and 'query: str' keys and output a
         List[Document]."""
 
     top_n: int = 3
@@ -89,7 +92,8 @@ class LLMListwiseRerank(BaseDocumentCompressor):
     ) -> Sequence[Document]:
         """Filter down documents based on their relevance to the query."""
         results = self.reranker.invoke(
-            {"documents": documents, "query": query}, config={"callbacks": callbacks}
+            {"documents": documents, "query": query},
+            config={"callbacks": callbacks},
         )
         return results[: self.top_n]
 
@@ -114,9 +118,10 @@ class LLMListwiseRerank(BaseDocumentCompressor):
         """
 
         if llm.with_structured_output == BaseLanguageModel.with_structured_output:
-            raise ValueError(
+            msg = (
                 f"llm of type {type(llm)} does not implement `with_structured_output`."
             )
+            raise ValueError(msg)
 
         class RankDocuments(BaseModel):
             """Rank the documents by their relevance to the user question.
@@ -134,6 +139,6 @@ class LLMListwiseRerank(BaseDocumentCompressor):
         reranker = RunnablePassthrough.assign(
             ranking=RunnableLambda(_get_prompt_input)
             | _prompt
-            | llm.with_structured_output(RankDocuments)
+            | llm.with_structured_output(RankDocuments),
         ) | RunnableLambda(_parse_ranking)
         return cls(reranker=reranker, **kwargs)

langchain/retrievers/ensemble.py

@@ -28,6 +28,7 @@ from langchain_core.runnables.utils import (
     get_unique_config_specs,
 )
 from pydantic import model_validator
+from typing_extensions import override
 
 T = TypeVar("T")
 H = TypeVar("H", bound=Hashable)
@@ -86,8 +87,12 @@ class EnsembleRetriever(BaseRetriever):
             values["weights"] = [1 / n_retrievers] * n_retrievers
         return values
 
+    @override
     def invoke(
-        self, input: str, config: Optional[RunnableConfig] = None, **kwargs: Any
+        self,
+        input: str,
+        config: Optional[RunnableConfig] = None,
+        **kwargs: Any,
     ) -> list[Document]:
         from langchain_core.callbacks import CallbackManager
 
@@ -111,7 +116,7 @@ class EnsembleRetriever(BaseRetriever):
             result = self.rank_fusion(input, run_manager=run_manager, config=config)
         except Exception as e:
             run_manager.on_retriever_error(e)
-            raise e
+            raise
         else:
             run_manager.on_retriever_end(
                 result,
@@ -119,8 +124,12 @@ class EnsembleRetriever(BaseRetriever):
             )
             return result
 
+    @override
     async def ainvoke(
-        self, input: str, config: Optional[RunnableConfig] = None, **kwargs: Any
+        self,
+        input: str,
+        config: Optional[RunnableConfig] = None,
+        **kwargs: Any,
     ) -> list[Document]:
         from langchain_core.callbacks import AsyncCallbackManager
 
@@ -142,11 +151,13 @@ class EnsembleRetriever(BaseRetriever):
         )
         try:
             result = await self.arank_fusion(
-                input, run_manager=run_manager, config=config
+                input,
+                run_manager=run_manager,
+                config=config,
             )
         except Exception as e:
             await run_manager.on_retriever_error(e)
-            raise e
+            raise
         else:
             await run_manager.on_retriever_end(
                 result,
@@ -171,9 +182,7 @@ class EnsembleRetriever(BaseRetriever):
         """
 
         # Get fused result of the retrievers.
-        fused_documents = self.rank_fusion(query, run_manager)
-
-        return fused_documents
+        return self.rank_fusion(query, run_manager)
 
     async def _aget_relevant_documents(
         self,
@@ -192,9 +201,7 @@ class EnsembleRetriever(BaseRetriever):
         """
 
         # Get fused result of the retrievers.
-        fused_documents = await self.arank_fusion(query, run_manager)
-
-        return fused_documents
+        return await self.arank_fusion(query, run_manager)
 
     def rank_fusion(
         self,
@@ -219,7 +226,8 @@ class EnsembleRetriever(BaseRetriever):
             retriever.invoke(
                 query,
                 patch_config(
-                    config, callbacks=run_manager.get_child(tag=f"retriever_{i + 1}")
+                    config,
+                    callbacks=run_manager.get_child(tag=f"retriever_{i + 1}"),
                 ),
             )
             for i, retriever in enumerate(self.retrievers)
@@ -233,9 +241,7 @@ class EnsembleRetriever(BaseRetriever):
             ]
 
         # apply rank fusion
-        fused_documents = self.weighted_reciprocal_rank(retriever_docs)
-
-        return fused_documents
+        return self.weighted_reciprocal_rank(retriever_docs)
 
     async def arank_fusion(
         self,
@@ -266,7 +272,7 @@ class EnsembleRetriever(BaseRetriever):
                     ),
                 )
                 for i, retriever in enumerate(self.retrievers)
-            ]
+            ],
         )
 
         # Enforce that retrieved docs are Documents for each list in retriever_docs
@@ -277,12 +283,11 @@ class EnsembleRetriever(BaseRetriever):
             ]
 
         # apply rank fusion
-        fused_documents = self.weighted_reciprocal_rank(retriever_docs)
-
-        return fused_documents
+        return self.weighted_reciprocal_rank(retriever_docs)
 
     def weighted_reciprocal_rank(
-        self, doc_lists: list[list[Document]]
+        self,
+        doc_lists: list[list[Document]],
     ) -> list[Document]:
         """
         Perform weighted Reciprocal Rank Fusion on multiple rank lists.
@@ -297,9 +302,8 @@ class EnsembleRetriever(BaseRetriever):
                     scores in descending order.
         """
         if len(doc_lists) != len(self.weights):
-            raise ValueError(
-                "Number of rank lists must be equal to the number of weights."
-            )
+            msg = "Number of rank lists must be equal to the number of weights."
+            raise ValueError(msg)
 
         # Associate each doc's content with its RRF score for later sorting by it
         # Duplicated contents across retrievers are collapsed & scored cumulatively
@@ -316,7 +320,7 @@ class EnsembleRetriever(BaseRetriever):
 
         # Docs are deduplicated by their contents then sorted by their scores
         all_docs = chain.from_iterable(doc_lists)
-        sorted_docs = sorted(
+        return sorted(
             unique_by_key(
                 all_docs,
                 lambda doc: (
@@ -330,4 +334,3 @@ class EnsembleRetriever(BaseRetriever):
                 doc.page_content if self.id_key is None else doc.metadata[self.id_key]
             ],
         )
-        return sorted_docs

langchain/retrievers/google_cloud_documentai_warehouse.py

@@ -9,7 +9,7 @@ if TYPE_CHECKING:
 # Used to consolidate logic for raising deprecation warnings and
 # handling optional imports.
 DEPRECATED_LOOKUP = {
-    "GoogleDocumentAIWarehouseRetriever": "langchain_community.retrievers"
+    "GoogleDocumentAIWarehouseRetriever": "langchain_community.retrievers",
 }
 
 _import_attribute = create_importer(__package__, deprecated_lookups=DEPRECATED_LOOKUP)

langchain/retrievers/google_vertex_ai_search.py

@@ -27,7 +27,7 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
-    "GoogleVertexAISearchRetriever",
-    "GoogleVertexAIMultiTurnSearchRetriever",
     "GoogleCloudEnterpriseSearchRetriever",
+    "GoogleVertexAIMultiTurnSearchRetriever",
+    "GoogleVertexAISearchRetriever",
 ]

langchain/retrievers/kendra.py

@@ -49,18 +49,18 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
-    "clean_excerpt",
-    "combined_text",
-    "Highlight",
-    "TextWithHighLights",
-    "AdditionalResultAttributeValue",
     "AdditionalResultAttribute",
-    "DocumentAttributeValue",
+    "AdditionalResultAttributeValue",
+    "AmazonKendraRetriever",
     "DocumentAttribute",
-    "ResultItem",
-    "QueryResultItem",
-    "RetrieveResultItem",
+    "DocumentAttributeValue",
+    "Highlight",
     "QueryResult",
+    "QueryResultItem",
+    "ResultItem",
     "RetrieveResult",
-    "AmazonKendraRetriever",
+    "RetrieveResultItem",
+    "TextWithHighLights",
+    "clean_excerpt",
+    "combined_text",
 ]

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

@@ -31,12 +31,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}""",
 )
 
@@ -66,7 +66,7 @@ class MultiQueryRetriever(BaseRetriever):
         llm: BaseLanguageModel,
         prompt: BasePromptTemplate = DEFAULT_QUERY_PROMPT,
         parser_key: Optional[str] = None,
-        include_original: bool = False,
+        include_original: bool = False,  # noqa: FBT001,FBT002
     ) -> "MultiQueryRetriever":
         """Initialize from llm using default template.
 
@@ -110,7 +110,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 +123,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 +147,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 +176,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 +189,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 +213,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

@@ -49,12 +49,16 @@ class MultiVectorRetriever(BaseRetriever):
         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
 
     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 +69,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]
@@ -86,7 +92,10 @@ class MultiVectorRetriever(BaseRetriever):
         return [d for d in docs if d is not None]
 
     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 +106,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

@@ -66,7 +66,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 +74,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 +82,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 +114,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 +131,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 +144,14 @@ 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)
+        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,