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

langchain/prompts/prompt.py

@@ -3,4 +3,4 @@ from langchain_core.prompts.prompt import PromptTemplate
 # For backwards compatibility.
 Prompt = PromptTemplate
 
-__all__ = ["PromptTemplate", "Prompt"]
+__all__ = ["Prompt", "PromptTemplate"]

langchain/retrievers/__init__.py

@@ -148,8 +148,8 @@ __all__ = [
     "GoogleDocumentAIWarehouseRetriever",
     "GoogleVertexAIMultiTurnSearchRetriever",
     "GoogleVertexAISearchRetriever",
-    "KayAiRetriever",
     "KNNRetriever",
+    "KayAiRetriever",
     "LlamaIndexGraphRetriever",
     "LlamaIndexRetriever",
     "MergerRetriever",
@@ -157,22 +157,22 @@ __all__ = [
     "MilvusRetriever",
     "MultiQueryRetriever",
     "MultiVectorRetriever",
+    "NeuralDBRetriever",
     "OutlineRetriever",
     "ParentDocumentRetriever",
     "PineconeHybridSearchRetriever",
     "PubMedRetriever",
-    "RemoteLangChainRetriever",
     "RePhraseQueryRetriever",
-    "SelfQueryRetriever",
+    "RemoteLangChainRetriever",
     "SVMRetriever",
-    "TavilySearchAPIRetriever",
+    "SelfQueryRetriever",
     "TFIDFRetriever",
+    "TavilySearchAPIRetriever",
     "TimeWeightedVectorStoreRetriever",
     "VespaRetriever",
     "WeaviateHybridSearchRetriever",
     "WebResearchRetriever",
     "WikipediaRetriever",
     "ZepRetriever",
-    "NeuralDBRetriever",
     "ZillizRetriever",
 ]

langchain/retrievers/bedrock.py

@@ -27,7 +27,7 @@ def __getattr__(name: str) -> Any:
 
 
 __all__ = [
-    "VectorSearchConfig",
-    "RetrievalConfig",
     "AmazonKnowledgeBasesRetriever",
+    "RetrievalConfig",
+    "VectorSearchConfig",
 ]

langchain/retrievers/bm25.py

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

langchain/retrievers/contextual_compression.py

@@ -38,15 +38,18 @@ class ContextualCompressionRetriever(BaseRetriever):
             Sequence of relevant documents
         """
         docs = self.base_retriever.invoke(
-            query, config={"callbacks": run_manager.get_child()}, **kwargs
+            query,
+            config={"callbacks": run_manager.get_child()},
+            **kwargs,
         )
         if docs:
             compressed_docs = self.base_compressor.compress_documents(
-                docs, query, callbacks=run_manager.get_child()
+                docs,
+                query,
+                callbacks=run_manager.get_child(),
             )
             return list(compressed_docs)
-        else:
-            return []
+        return []
 
     async def _aget_relevant_documents(
         self,
@@ -64,12 +67,15 @@ class ContextualCompressionRetriever(BaseRetriever):
             List of relevant documents
         """
         docs = await self.base_retriever.ainvoke(
-            query, config={"callbacks": run_manager.get_child()}, **kwargs
+            query,
+            config={"callbacks": run_manager.get_child()},
+            **kwargs,
         )
         if docs:
             compressed_docs = await self.base_compressor.acompress_documents(
-                docs, query, callbacks=run_manager.get_child()
+                docs,
+                query,
+                callbacks=run_manager.get_child(),
             )
             return list(compressed_docs)
-        else:
-            return []
+        return []

langchain/retrievers/docarray.py

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

langchain/retrievers/document_compressors/__init__.py

@@ -28,16 +28,17 @@ def __getattr__(name: str) -> Any:
     if name in _module_lookup:
         module = importlib.import_module(_module_lookup[name])
         return getattr(module, name)
-    raise AttributeError(f"module {__name__} has no attribute {name}")
+    msg = f"module {__name__} has no attribute {name}"
+    raise AttributeError(msg)
 
 
 __all__ = [
+    "CohereRerank",
+    "CrossEncoderReranker",
     "DocumentCompressorPipeline",
     "EmbeddingsFilter",
     "FlashrankRerank",
-    "LLMListwiseRerank",
     "LLMChainExtractor",
     "LLMChainFilter",
-    "CohereRerank",
-    "CrossEncoderReranker",
+    "LLMListwiseRerank",
 ]

langchain/retrievers/document_compressors/base.py

@@ -32,20 +32,23 @@ class DocumentCompressorPipeline(BaseDocumentCompressor):
             if isinstance(_transformer, BaseDocumentCompressor):
                 accepts_callbacks = (
                     signature(_transformer.compress_documents).parameters.get(
-                        "callbacks"
+                        "callbacks",
                     )
                     is not None
                 )
                 if accepts_callbacks:
                     documents = _transformer.compress_documents(
-                        documents, query, callbacks=callbacks
+                        documents,
+                        query,
+                        callbacks=callbacks,
                     )
                 else:
                     documents = _transformer.compress_documents(documents, query)
             elif isinstance(_transformer, BaseDocumentTransformer):
                 documents = _transformer.transform_documents(documents)
             else:
-                raise ValueError(f"Got unexpected transformer type: {_transformer}")
+                msg = f"Got unexpected transformer type: {_transformer}"
+                raise ValueError(msg)  # noqa: TRY004
         return documents
 
     async def acompress_documents(
@@ -59,18 +62,21 @@ class DocumentCompressorPipeline(BaseDocumentCompressor):
             if isinstance(_transformer, BaseDocumentCompressor):
                 accepts_callbacks = (
                     signature(_transformer.acompress_documents).parameters.get(
-                        "callbacks"
+                        "callbacks",
                     )
                     is not None
                 )
                 if accepts_callbacks:
                     documents = await _transformer.acompress_documents(
-                        documents, query, callbacks=callbacks
+                        documents,
+                        query,
+                        callbacks=callbacks,
                     )
                 else:
                     documents = await _transformer.acompress_documents(documents, query)
             elif isinstance(_transformer, BaseDocumentTransformer):
                 documents = await _transformer.atransform_documents(documents)
             else:
-                raise ValueError(f"Got unexpected transformer type: {_transformer}")
+                msg = f"Got unexpected transformer type: {_transformer}"
+                raise ValueError(msg)  # noqa: TRY004
         return documents

langchain/retrievers/document_compressors/chain_extract.py

@@ -80,7 +80,7 @@ class LLMChainExtractor(BaseDocumentCompressor):
             if len(output) == 0:
                 continue
             compressed_docs.append(
-                Document(page_content=cast(str, output), metadata=doc.metadata)
+                Document(page_content=cast(str, output), metadata=doc.metadata),
             )
         return compressed_docs
 
@@ -98,7 +98,7 @@ class LLMChainExtractor(BaseDocumentCompressor):
             if len(outputs[i]) == 0:
                 continue
             compressed_docs.append(
-                Document(page_content=outputs[i], metadata=doc.metadata)
+                Document(page_content=outputs[i], metadata=doc.metadata),
             )
         return compressed_docs
 

langchain/retrievers/document_compressors/chain_extract_prompt.py

@@ -1,5 +1,4 @@
-# flake8: noqa
-prompt_template = """Given the following question and context, extract any part of the context *AS IS* that is relevant to answer the question. If none of the context is relevant return {no_output_str}. 
+prompt_template = """Given the following question and context, extract any part of the context *AS IS* that is relevant to answer the question. If none of the context is relevant return {no_output_str}.
 
 Remember, *DO NOT* edit the extracted parts of the context.
 
@@ -8,4 +7,4 @@ Remember, *DO NOT* edit the extracted parts of the context.
 >>>
 {{context}}
 >>>
-Extracted relevant parts:"""
+Extracted relevant parts:"""  # noqa: E501

langchain/retrievers/document_compressors/chain_filter.py

@@ -36,7 +36,7 @@ class LLMChainFilter(BaseDocumentCompressor):
     """Filter that drops documents that aren't relevant to the query."""
 
     llm_chain: Runnable
-    """LLM wrapper to use for filtering documents. 
+    """LLM wrapper to use for filtering documents.
     The chain prompt is expected to have a BooleanOutputParser."""
 
     get_input: Callable[[str, Document], dict] = default_get_input
@@ -58,7 +58,8 @@ class LLMChainFilter(BaseDocumentCompressor):
         config = RunnableConfig(callbacks=callbacks)
         outputs = zip(
             self.llm_chain.batch(
-                [self.get_input(query, doc) for doc in documents], config=config
+                [self.get_input(query, doc) for doc in documents],
+                config=config,
             ),
             documents,
         )
@@ -69,9 +70,8 @@ class LLMChainFilter(BaseDocumentCompressor):
                 output = output_[self.llm_chain.output_key]
                 if self.llm_chain.prompt.output_parser is not None:
                     include_doc = self.llm_chain.prompt.output_parser.parse(output)
-            else:
-                if isinstance(output_, bool):
-                    include_doc = output_
+            elif isinstance(output_, bool):
+                include_doc = output_
             if include_doc:
                 filtered_docs.append(doc)
 
@@ -89,7 +89,8 @@ class LLMChainFilter(BaseDocumentCompressor):
         config = RunnableConfig(callbacks=callbacks)
         outputs = zip(
             await self.llm_chain.abatch(
-                [self.get_input(query, doc) for doc in documents], config=config
+                [self.get_input(query, doc) for doc in documents],
+                config=config,
             ),
             documents,
         )
@@ -99,9 +100,8 @@ class LLMChainFilter(BaseDocumentCompressor):
                 output = output_[self.llm_chain.output_key]
                 if self.llm_chain.prompt.output_parser is not None:
                     include_doc = self.llm_chain.prompt.output_parser.parse(output)
-            else:
-                if isinstance(output_, bool):
-                    include_doc = output_
+            elif isinstance(output_, bool):
+                include_doc = output_
             if include_doc:
                 filtered_docs.append(doc)
 

langchain/retrievers/document_compressors/chain_filter_prompt.py

@@ -1,4 +1,3 @@
-# flake8: noqa
 prompt_template = """Given the following question and context, return YES if the context is relevant to the question and NO if it isn't.
 
 > Question: {question}
@@ -6,4 +5,4 @@ prompt_template = """Given the following question and context, return YES if the
 >>>
 {context}
 >>>
-> Relevant (YES / NO):"""
+> Relevant (YES / NO):"""  # noqa: E501

langchain/retrievers/document_compressors/cohere_rerank.py

@@ -12,7 +12,9 @@ from pydantic import ConfigDict, model_validator
 
 
 @deprecated(
-    since="0.0.30", removal="1.0", alternative_import="langchain_cohere.CohereRerank"
+    since="0.0.30",
+    removal="1.0",
+    alternative_import="langchain_cohere.CohereRerank",
 )
 class CohereRerank(BaseDocumentCompressor):
     """Document compressor that uses `Cohere Rerank API`."""
@@ -24,7 +26,7 @@ class CohereRerank(BaseDocumentCompressor):
     model: str = "rerank-english-v2.0"
     """Model to use for reranking."""
     cohere_api_key: Optional[str] = None
-    """Cohere API key. Must be specified directly or via environment variable 
+    """Cohere API key. Must be specified directly or via environment variable
         COHERE_API_KEY."""
     user_agent: str = "langchain"
     """Identifier for the application making the request."""
@@ -41,13 +43,16 @@ class CohereRerank(BaseDocumentCompressor):
         if not values.get("client"):
             try:
                 import cohere
-            except ImportError:
-                raise ImportError(
+            except ImportError as e:
+                msg = (
                     "Could not import cohere python package. "
                     "Please install it with `pip install cohere`."
                 )
+                raise ImportError(msg) from e
             cohere_api_key = get_from_dict_or_env(
-                values, "cohere_api_key", "COHERE_API_KEY"
+                values,
+                "cohere_api_key",
+                "COHERE_API_KEY",
             )
             client_name = values.get("user_agent", "langchain")
             values["client"] = cohere.Client(cohere_api_key, client_name=client_name)
@@ -87,16 +92,11 @@ class CohereRerank(BaseDocumentCompressor):
             max_chunks_per_doc=max_chunks_per_doc,
         )
         if hasattr(results, "results"):
-            results = getattr(results, "results")
-        result_dicts = []
-        for res in results:
-            result_dicts.append(
-                {
-                    "index": res.index,
-                    "relevance_score": res.relevance_score,
-                }
-            )
-        return result_dicts
+            results = results.results
+        return [
+            {"index": res.index, "relevance_score": res.relevance_score}
+            for res in results
+        ]
 
     def compress_documents(
         self,

langchain/retrievers/document_compressors/embeddings_filter.py

@@ -11,11 +11,12 @@ from pydantic import ConfigDict, Field
 def _get_similarity_function() -> Callable:
     try:
         from langchain_community.utils.math import cosine_similarity
-    except ImportError:
-        raise ImportError(
+    except ImportError as e:
+        msg = (
             "To use please install langchain-community "
             "with `pip install langchain-community`."
         )
+        raise ImportError(msg) from e
     return cosine_similarity
 
 
@@ -45,7 +46,8 @@ class EmbeddingsFilter(BaseDocumentCompressor):
     def validate_params(cls, values: dict) -> dict:
         """Validate similarity parameters."""
         if values["k"] is None and values["similarity_threshold"] is None:
-            raise ValueError("Must specify one of `k` or `similarity_threshold`.")
+            msg = "Must specify one of `k` or `similarity_threshold`."
+            raise ValueError(msg)
         return values
 
     def compress_documents(
@@ -60,21 +62,22 @@ class EmbeddingsFilter(BaseDocumentCompressor):
                 _get_embeddings_from_stateful_docs,
                 get_stateful_documents,
             )
-        except ImportError:
-            raise ImportError(
+        except ImportError as e:
+            msg = (
                 "To use please install langchain-community "
                 "with `pip install langchain-community`."
             )
+            raise ImportError(msg) from e
 
         try:
             import numpy as np
         except ImportError as e:
-            raise ImportError(
-                "Could not import numpy, please install with `pip install numpy`."
-            ) from e
+            msg = "Could not import numpy, please install with `pip install numpy`."
+            raise ImportError(msg) from e
         stateful_documents = get_stateful_documents(documents)
         embedded_documents = _get_embeddings_from_stateful_docs(
-            self.embeddings, stateful_documents
+            self.embeddings,
+            stateful_documents,
         )
         embedded_query = self.embeddings.embed_query(query)
         similarity = self.similarity_fn([embedded_query], embedded_documents)[0]
@@ -83,7 +86,7 @@ class EmbeddingsFilter(BaseDocumentCompressor):
             included_idxs = np.argsort(similarity)[::-1][: self.k]
         if self.similarity_threshold is not None:
             similar_enough = np.where(
-                similarity[included_idxs] > self.similarity_threshold
+                similarity[included_idxs] > self.similarity_threshold,
             )
             included_idxs = included_idxs[similar_enough]
         for i in included_idxs:
@@ -102,21 +105,22 @@ class EmbeddingsFilter(BaseDocumentCompressor):
                 _aget_embeddings_from_stateful_docs,
                 get_stateful_documents,
             )
-        except ImportError:
-            raise ImportError(
+        except ImportError as e:
+            msg = (
                 "To use please install langchain-community "
                 "with `pip install langchain-community`."
             )
+            raise ImportError(msg) from e
 
         try:
             import numpy as np
         except ImportError as e:
-            raise ImportError(
-                "Could not import numpy, please install with `pip install numpy`."
-            ) from e
+            msg = "Could not import numpy, please install with `pip install numpy`."
+            raise ImportError(msg) from e
         stateful_documents = get_stateful_documents(documents)
         embedded_documents = await _aget_embeddings_from_stateful_docs(
-            self.embeddings, stateful_documents
+            self.embeddings,
+            stateful_documents,
         )
         embedded_query = await self.embeddings.aembed_query(query)
         similarity = self.similarity_fn([embedded_query], embedded_documents)[0]
@@ -125,7 +129,7 @@ class EmbeddingsFilter(BaseDocumentCompressor):
             included_idxs = np.argsort(similarity)[::-1][: self.k]
         if self.similarity_threshold is not None:
             similar_enough = np.where(
-                similarity[included_idxs] > self.similarity_threshold
+                similarity[included_idxs] > self.similarity_threshold,
             )
             included_idxs = included_idxs[similar_enough]
         for i in included_idxs:

langchain/retrievers/document_compressors/flashrank_rerank.py

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

langchain/retrievers/document_compressors/listwise_rerank.py

@@ -73,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
@@ -92,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]
 
@@ -117,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.
@@ -137,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)