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

langchain/chains/combine_documents/map_rerank.py

@@ -11,7 +11,7 @@ from langchain_core.documents import Document
 from langchain_core.runnables.config import RunnableConfig
 from langchain_core.utils.pydantic import create_model
 from pydantic import BaseModel, ConfigDict, model_validator
-from typing_extensions import Self
+from typing_extensions import Self, override
 
 from langchain.chains.combine_documents.base import BaseCombineDocumentsChain
 from langchain.chains.llm import LLMChain
@@ -31,8 +31,8 @@ class MapRerankDocumentsChain(BaseCombineDocumentsChain):
     """Combining documents by mapping a chain over them, then reranking results.
 
     This algorithm calls an LLMChain on each input document. The LLMChain is expected
-    to have an OutputParser that parses the result into both an answer (`answer_key`)
-    and a score (`rank_key`). The answer with the highest score is then returned.
+    to have an OutputParser that parses the result into both an answer (``answer_key``)
+    and a score (``rank_key``). The answer with the highest score is then returned.
 
     Example:
         .. code-block:: python
@@ -69,6 +69,7 @@ class MapRerankDocumentsChain(BaseCombineDocumentsChain):
                 rank_key="score",
                 answer_key="answer",
             )
+
     """
 
     llm_chain: LLMChain
@@ -91,6 +92,7 @@ class MapRerankDocumentsChain(BaseCombineDocumentsChain):
         extra="forbid",
     )
 
+    @override
     def get_output_schema(
         self,
         config: Optional[RunnableConfig] = None,
@@ -228,7 +230,7 @@ class MapRerankDocumentsChain(BaseCombineDocumentsChain):
         docs: list[Document],
         results: Sequence[Union[str, list[str], dict[str, str]]],
     ) -> tuple[str, dict]:
-        typed_results = cast(list[dict], results)
+        typed_results = cast("list[dict]", results)
         sorted_res = sorted(
             zip(typed_results, docs),
             key=lambda x: -int(x[0][self.rank_key]),

langchain/chains/combine_documents/reduce.py

@@ -201,6 +201,7 @@ class ReduceDocumentsChain(BaseCombineDocumentsChain):
                 combine_documents_chain=combine_documents_chain,
                 collapse_documents_chain=collapse_documents_chain,
             )
+
     """
 
     combine_documents_chain: BaseCombineDocumentsChain

langchain/chains/combine_documents/refine.py

@@ -79,6 +79,7 @@ class RefineDocumentsChain(BaseCombineDocumentsChain):
                 document_variable_name=document_variable_name,
                 initial_response_name=initial_response_name,
             )
+
     """
 
     initial_llm_chain: LLMChain

langchain/chains/combine_documents/stuff.py

@@ -10,6 +10,7 @@ from langchain_core.output_parsers import BaseOutputParser, StrOutputParser
 from langchain_core.prompts import BasePromptTemplate, format_document
 from langchain_core.runnables import Runnable, RunnablePassthrough
 from pydantic import ConfigDict, Field, model_validator
+from typing_extensions import override
 
 from langchain.chains.combine_documents.base import (
     DEFAULT_DOCUMENT_PROMPT,
@@ -74,6 +75,7 @@ def create_stuff_documents_chain(
             ]
 
             chain.invoke({"context": docs})
+
     """  # noqa: E501
 
     _validate_prompt(prompt, document_variable_name)
@@ -141,6 +143,7 @@ class StuffDocumentsChain(BaseCombineDocumentsChain):
                 document_prompt=document_prompt,
                 document_variable_name=document_variable_name
             )
+
     """
 
     llm_chain: LLMChain
@@ -189,6 +192,7 @@ class StuffDocumentsChain(BaseCombineDocumentsChain):
         return values
 
     @property
+    @override
     def input_keys(self) -> list[str]:
         extra_keys = [
             k for k in self.llm_chain.input_keys if k != self.document_variable_name
@@ -239,7 +243,7 @@ class StuffDocumentsChain(BaseCombineDocumentsChain):
         """
         inputs = self._get_inputs(docs, **kwargs)
         prompt = self.llm_chain.prompt.format(**inputs)
-        return self.llm_chain._get_num_tokens(prompt)
+        return self.llm_chain._get_num_tokens(prompt)  # noqa: SLF001
 
     def combine_docs(
         self,

langchain/chains/constitutional_ai/base.py

@@ -187,6 +187,7 @@ class ConstitutionalChain(Chain):
             )
 
             constitutional_chain.run(question="What is the meaning of life?")
+
     """  # noqa: E501
 
     chain: LLMChain
@@ -200,6 +201,12 @@ class ConstitutionalChain(Chain):
         cls,
         names: Optional[list[str]] = None,
     ) -> list[ConstitutionalPrinciple]:
+        """Get constitutional principles by name.
+
+        Args:
+            names: List of names of constitutional principles to retrieve.
+                If None (default), all principles are returned.
+        """
         if names is None:
             return list(PRINCIPLES.values())
         return [PRINCIPLES[name] for name in names]

langchain/chains/conversation/base.py

@@ -4,7 +4,7 @@ from langchain_core._api import deprecated
 from langchain_core.memory import BaseMemory
 from langchain_core.prompts import BasePromptTemplate
 from pydantic import ConfigDict, Field, model_validator
-from typing_extensions import Self
+from typing_extensions import Self, override
 
 from langchain.chains.conversation.prompt import PROMPT
 from langchain.chains.llm import LLMChain
@@ -53,6 +53,7 @@ class ConversationChain(LLMChain):
                 "Hi I'm Bob.",
                 config={"configurable": {"session_id": "1"}},
             )  # session_id determines thread
+
     Memory objects can also be incorporated into the ``get_session_history`` callable:
 
         .. code-block:: python
@@ -96,6 +97,7 @@ class ConversationChain(LLMChain):
             from langchain_community.llms import OpenAI
 
             conversation = ConversationChain(llm=OpenAI())
+
     """
 
     memory: BaseMemory = Field(default_factory=ConversationBufferMemory)
@@ -112,6 +114,7 @@ class ConversationChain(LLMChain):
     )
 
     @classmethod
+    @override
     def is_lc_serializable(cls) -> bool:
         return False
 

langchain/chains/conversational_retrieval/base.py

@@ -22,6 +22,7 @@ from langchain_core.retrievers import BaseRetriever
 from langchain_core.runnables import RunnableConfig
 from langchain_core.vectorstores import VectorStore
 from pydantic import BaseModel, ConfigDict, Field, model_validator
+from typing_extensions import override
 
 from langchain.chains.base import Chain
 from langchain.chains.combine_documents.base import BaseCombineDocumentsChain
@@ -109,6 +110,7 @@ class BaseConversationalRetrievalChain(Chain):
         """Input keys."""
         return ["question", "chat_history"]
 
+    @override
     def get_input_schema(
         self,
         config: Optional[RunnableConfig] = None,
@@ -242,6 +244,7 @@ class BaseConversationalRetrievalChain(Chain):
             output["generated_question"] = new_question
         return output
 
+    @override
     def save(self, file_path: Union[Path, str]) -> None:
         if self.get_chat_history:
             msg = "Chain not saveable when `get_chat_history` is not None."
@@ -264,68 +267,67 @@ class ConversationalRetrievalChain(BaseConversationalRetrievalChain):
     `create_retrieval_chain`. Additional walkthroughs can be found at
     https://python.langchain.com/docs/use_cases/question_answering/chat_history
 
-        .. code-block:: python
-
-            from langchain.chains import (
-                create_history_aware_retriever,
-                create_retrieval_chain,
-            )
-            from langchain.chains.combine_documents import create_stuff_documents_chain
-            from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder
-            from langchain_openai import ChatOpenAI
+    .. code-block:: python
 
+        from langchain.chains import (
+            create_history_aware_retriever,
+            create_retrieval_chain,
+        )
+        from langchain.chains.combine_documents import create_stuff_documents_chain
+        from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder
+        from langchain_openai import ChatOpenAI
 
-            retriever = ...  # Your retriever
+        retriever = ...  # Your retriever
 
-            llm = ChatOpenAI()
+        llm = ChatOpenAI()
 
-            # Contextualize question
-            contextualize_q_system_prompt = (
-                "Given a chat history and the latest user question "
-                "which might reference context in the chat history, "
-                "formulate a standalone question which can be understood "
-                "without the chat history. Do NOT answer the question, just "
-                "reformulate it if needed and otherwise return it as is."
-            )
-            contextualize_q_prompt = ChatPromptTemplate.from_messages(
-                [
-                    ("system", contextualize_q_system_prompt),
-                    MessagesPlaceholder("chat_history"),
-                    ("human", "{input}"),
-                ]
-            )
-            history_aware_retriever = create_history_aware_retriever(
-                llm, retriever, contextualize_q_prompt
-            )
+        # Contextualize question
+        contextualize_q_system_prompt = (
+            "Given a chat history and the latest user question "
+            "which might reference context in the chat history, "
+            "formulate a standalone question which can be understood "
+            "without the chat history. Do NOT answer the question, just "
+            "reformulate it if needed and otherwise return it as is."
+        )
+        contextualize_q_prompt = ChatPromptTemplate.from_messages(
+            [
+                ("system", contextualize_q_system_prompt),
+                MessagesPlaceholder("chat_history"),
+                ("human", "{input}"),
+            ]
+        )
+        history_aware_retriever = create_history_aware_retriever(
+            llm, retriever, contextualize_q_prompt
+        )
 
-            # Answer question
-            qa_system_prompt = (
-                "You are an assistant for question-answering tasks. Use "
-                "the following pieces of retrieved context to answer the "
-                "question. If you don't know the answer, just say that you "
-                "don't know. Use three sentences maximum and keep the answer "
-                "concise."
-                "\n\n"
-                "{context}"
-            )
-            qa_prompt = ChatPromptTemplate.from_messages(
-                [
-                    ("system", qa_system_prompt),
-                    MessagesPlaceholder("chat_history"),
-                    ("human", "{input}"),
-                ]
-            )
-            # Below we use create_stuff_documents_chain to feed all retrieved context
-            # into the LLM. Note that we can also use StuffDocumentsChain and other
-            # instances of BaseCombineDocumentsChain.
-            question_answer_chain = create_stuff_documents_chain(llm, qa_prompt)
-            rag_chain = create_retrieval_chain(
-                history_aware_retriever, question_answer_chain
-            )
+        # Answer question
+        qa_system_prompt = (
+            "You are an assistant for question-answering tasks. Use "
+            "the following pieces of retrieved context to answer the "
+            "question. If you don't know the answer, just say that you "
+            "don't know. Use three sentences maximum and keep the answer "
+            "concise."
+            "\n\n"
+            "{context}"
+        )
+        qa_prompt = ChatPromptTemplate.from_messages(
+            [
+                ("system", qa_system_prompt),
+                MessagesPlaceholder("chat_history"),
+                ("human", "{input}"),
+            ]
+        )
+        # Below we use create_stuff_documents_chain to feed all retrieved context
+        # into the LLM. Note that we can also use StuffDocumentsChain and other
+        # instances of BaseCombineDocumentsChain.
+        question_answer_chain = create_stuff_documents_chain(llm, qa_prompt)
+        rag_chain = create_retrieval_chain(
+            history_aware_retriever, question_answer_chain
+        )
 
-            # Usage:
-            chat_history = []  # Collect chat history here (a sequence of messages)
-            rag_chain.invoke({"input": query, "chat_history": chat_history})
+        # Usage:
+        chat_history = []  # Collect chat history here (a sequence of messages)
+        rag_chain.invoke({"input": query, "chat_history": chat_history})
 
     This chain takes in chat history (a list of messages) and new questions,
     and then returns an answer to that question.
@@ -372,13 +374,16 @@ class ConversationalRetrievalChain(BaseConversationalRetrievalChain):
                 retriever=retriever,
                 question_generator=question_generator_chain,
             )
+
     """
 
     retriever: BaseRetriever
     """Retriever to use to fetch documents."""
     max_tokens_limit: Optional[int] = None
     """If set, enforces that the documents returned are less than this limit.
-    This is only enforced if `combine_docs_chain` is of type StuffDocumentsChain."""
+
+    This is only enforced if ``combine_docs_chain`` is of type StuffDocumentsChain.
+    """
 
     def _reduce_tokens_below_limit(self, docs: list[Document]) -> list[Document]:
         num_docs = len(docs)
@@ -388,7 +393,7 @@ class ConversationalRetrievalChain(BaseConversationalRetrievalChain):
             StuffDocumentsChain,
         ):
             tokens = [
-                self.combine_docs_chain.llm_chain._get_num_tokens(doc.page_content)
+                self.combine_docs_chain.llm_chain._get_num_tokens(doc.page_content)  # noqa: SLF001
                 for doc in docs
             ]
             token_count = sum(tokens[:num_docs])
@@ -398,6 +403,7 @@ class ConversationalRetrievalChain(BaseConversationalRetrievalChain):
 
         return docs[:num_docs]
 
+    @override
     def _get_docs(
         self,
         question: str,
@@ -412,6 +418,7 @@ class ConversationalRetrievalChain(BaseConversationalRetrievalChain):
         )
         return self._reduce_tokens_below_limit(docs)
 
+    @override
     async def _aget_docs(
         self,
         question: str,
@@ -500,7 +507,7 @@ class ChatVectorDBChain(BaseConversationalRetrievalChain):
 
     @model_validator(mode="before")
     @classmethod
-    def raise_deprecation(cls, values: dict) -> Any:
+    def _raise_deprecation(cls, values: dict) -> Any:
         warnings.warn(
             "`ChatVectorDBChain` is deprecated - "
             "please use `from langchain.chains import ConversationalRetrievalChain`",
@@ -508,6 +515,7 @@ class ChatVectorDBChain(BaseConversationalRetrievalChain):
         )
         return values
 
+    @override
     def _get_docs(
         self,
         question: str,

langchain/chains/elasticsearch_database/base.py

@@ -34,6 +34,7 @@ class ElasticsearchDatabaseChain(Chain):
 
             database = Elasticsearch("http://localhost:9200")
             db_chain = ElasticsearchDatabaseChain.from_llm(OpenAI(), database)
+
     """
 
     query_chain: Runnable
@@ -58,7 +59,7 @@ class ElasticsearchDatabaseChain(Chain):
     )
 
     @model_validator(mode="after")
-    def validate_indices(self) -> Self:
+    def _validate_indices(self) -> Self:
         if self.include_indices and self.ignore_indices:
             msg = "Cannot specify both 'include_indices' and 'ignore_indices'."
             raise ValueError(msg)

langchain/chains/flare/base.py

@@ -15,6 +15,7 @@ from langchain_core.prompts import BasePromptTemplate
 from langchain_core.retrievers import BaseRetriever
 from langchain_core.runnables import Runnable
 from pydantic import Field
+from typing_extensions import override
 
 from langchain.chains.base import Chain
 from langchain.chains.flare.prompts import (
@@ -44,6 +45,7 @@ class QuestionGeneratorChain(LLMChain):
     """Prompt template for the chain."""
 
     @classmethod
+    @override
     def is_lc_serializable(cls) -> bool:
         return False
 

langchain/chains/flare/prompts.py

@@ -1,5 +1,6 @@
 from langchain_core.output_parsers import BaseOutputParser
 from langchain_core.prompts import PromptTemplate
+from typing_extensions import override
 
 
 class FinishedOutputParser(BaseOutputParser[tuple[str, bool]]):
@@ -8,6 +9,7 @@ class FinishedOutputParser(BaseOutputParser[tuple[str, bool]]):
     finished_value: str = "FINISHED"
     """Value that indicates the output is finished."""
 
+    @override
     def parse(self, text: str) -> tuple[str, bool]:
         cleaned = text.strip()
         finished = self.finished_value in cleaned

langchain/chains/llm.py

@@ -32,6 +32,7 @@ from langchain_core.runnables import (
 from langchain_core.runnables.configurable import DynamicRunnable
 from langchain_core.utils.input import get_colored_text
 from pydantic import ConfigDict, Field
+from typing_extensions import override
 
 from langchain.chains.base import Chain
 
@@ -73,9 +74,11 @@ class LLMChain(Chain):
                 input_variables=["adjective"], template=prompt_template
             )
             llm = LLMChain(llm=OpenAI(), prompt=prompt)
+
     """
 
     @classmethod
+    @override
     def is_lc_serializable(self) -> bool:
         return True
 
@@ -143,7 +146,7 @@ class LLMChain(Chain):
                 **self.llm_kwargs,
             )
         results = self.llm.bind(stop=stop, **self.llm_kwargs).batch(
-            cast(list, prompts),
+            cast("list", prompts),
             {"callbacks": callbacks},
         )
         generations: list[list[Generation]] = []
@@ -170,7 +173,7 @@ class LLMChain(Chain):
                 **self.llm_kwargs,
             )
         results = await self.llm.bind(stop=stop, **self.llm_kwargs).abatch(
-            cast(list, prompts),
+            cast("list", prompts),
             {"callbacks": callbacks},
         )
         generations: list[list[Generation]] = []
@@ -321,6 +324,7 @@ class LLMChain(Chain):
             .. code-block:: python
 
                 completion = llm.predict(adjective="funny")
+
         """
         return self(kwargs, callbacks=callbacks)[self.output_key]
 
@@ -338,6 +342,7 @@ class LLMChain(Chain):
             .. code-block:: python
 
                 completion = llm.predict(adjective="funny")
+
         """
         return (await self.acall(kwargs, callbacks=callbacks))[self.output_key]
 

langchain/chains/llm_bash/__init__.py

@@ -1,4 +1,4 @@
-def __getattr__(name: str = "") -> None:
+def __getattr__(_: str = "") -> None:
     """Raise an error on import since is deprecated."""
     msg = (
         "This module has been moved to langchain-experimental. "

langchain/chains/llm_checker/base.py

@@ -82,6 +82,7 @@ class LLMCheckerChain(Chain):
             from langchain.chains import LLMCheckerChain
             llm = OpenAI(temperature=0.7)
             checker_chain = LLMCheckerChain.from_llm(llm)
+
     """
 
     question_to_checked_assertions_chain: SequentialChain
@@ -106,7 +107,7 @@ class LLMCheckerChain(Chain):
 
     @model_validator(mode="before")
     @classmethod
-    def raise_deprecation(cls, values: dict) -> Any:
+    def _raise_deprecation(cls, values: dict) -> Any:
         if "llm" in values:
             warnings.warn(
                 "Directly instantiating an LLMCheckerChain with an llm is deprecated. "
@@ -179,6 +180,16 @@ class LLMCheckerChain(Chain):
         revised_answer_prompt: PromptTemplate = REVISED_ANSWER_PROMPT,
         **kwargs: Any,
     ) -> LLMCheckerChain:
+        """Create an LLMCheckerChain from a language model.
+
+        Args:
+            llm: a language model
+            create_draft_answer_prompt: prompt to create a draft answer
+            list_assertions_prompt: prompt to list assertions
+            check_assertions_prompt: prompt to check assertions
+            revised_answer_prompt: prompt to revise the answer
+            **kwargs: additional arguments
+        """
         question_to_checked_assertions_chain = (
             _load_question_to_checked_assertions_chain(
                 llm,

langchain/chains/llm_math/base.py

@@ -146,6 +146,7 @@ class LLMMathChain(Chain):
             from langchain.chains import LLMMathChain
             from langchain_community.llms import OpenAI
             llm_math = LLMMathChain.from_llm(OpenAI())
+
     """  # noqa: E501
 
     llm_chain: LLMChain
@@ -163,7 +164,7 @@ class LLMMathChain(Chain):
 
     @model_validator(mode="before")
     @classmethod
-    def raise_deprecation(cls, values: dict) -> Any:
+    def _raise_deprecation(cls, values: dict) -> Any:
         try:
             import numexpr  # noqa: F401
         except ImportError as e:
@@ -307,5 +308,12 @@ class LLMMathChain(Chain):
         prompt: BasePromptTemplate = PROMPT,
         **kwargs: Any,
     ) -> LLMMathChain:
+        """Create a LLMMathChain from a language model.
+
+        Args:
+            llm: a language model
+            prompt: a prompt template
+            **kwargs: additional arguments
+        """
         llm_chain = LLMChain(llm=llm, prompt=prompt)
         return cls(llm_chain=llm_chain, **kwargs)

langchain/chains/llm_summarization_checker/base.py

@@ -85,6 +85,7 @@ class LLMSummarizationCheckerChain(Chain):
             from langchain.chains import LLMSummarizationCheckerChain
             llm = OpenAI(temperature=0.0)
             checker_chain = LLMSummarizationCheckerChain.from_llm(llm)
+
     """
 
     sequential_chain: SequentialChain
@@ -112,7 +113,7 @@ class LLMSummarizationCheckerChain(Chain):
 
     @model_validator(mode="before")
     @classmethod
-    def raise_deprecation(cls, values: dict) -> Any:
+    def _raise_deprecation(cls, values: dict) -> Any:
         if "llm" in values:
             warnings.warn(
                 "Directly instantiating an LLMSummarizationCheckerChain with an llm is "
@@ -194,6 +195,17 @@ class LLMSummarizationCheckerChain(Chain):
         verbose: bool = False,  # noqa: FBT001,FBT002
         **kwargs: Any,
     ) -> LLMSummarizationCheckerChain:
+        """Create a LLMSummarizationCheckerChain from a language model.
+
+        Args:
+            llm: a language model
+            create_assertions_prompt: prompt to create assertions
+            check_assertions_prompt: prompt to check assertions
+            revised_summary_prompt: prompt to revise summary
+            are_all_true_prompt: prompt to check if all assertions are true
+            verbose: whether to print verbose output
+            **kwargs: additional arguments
+        """
         chain = _load_sequential_chain(
             llm,
             create_assertions_prompt,

langchain/chains/llm_symbolic_math/__init__.py

@@ -1,4 +1,4 @@
-def __getattr__(name: str = "") -> None:
+def __getattr__(_: str = "") -> None:
     """Raise an error on import since is deprecated."""
     msg = (
         "This module has been moved to langchain-experimental. "

langchain/chains/loading.py

@@ -39,7 +39,8 @@ try:
     from langchain_community.llms.loading import load_llm, load_llm_from_config
 except ImportError:
 
-    def load_llm(*args: Any, **kwargs: Any) -> None:
+    def load_llm(*_: Any, **__: Any) -> None:
+        """Import error for load_llm."""
         msg = (
             "To use this load_llm functionality you must install the "
             "langchain_community package. "
@@ -47,7 +48,8 @@ except ImportError:
         )
         raise ImportError(msg)
 
-    def load_llm_from_config(*args: Any, **kwargs: Any) -> None:
+    def load_llm_from_config(*_: Any, **__: Any) -> None:
+        """Import error for load_llm_from_config."""
         msg = (
             "To use this load_llm_from_config functionality you must install the "
             "langchain_community package. "

langchain/chains/moderation.py

@@ -8,6 +8,7 @@ from langchain_core.callbacks import (
 )
 from langchain_core.utils import check_package_version, get_from_dict_or_env
 from pydantic import Field, model_validator
+from typing_extensions import override
 
 from langchain.chains.base import Chain
 
@@ -26,6 +27,7 @@ class OpenAIModerationChain(Chain):
 
             from langchain.chains import OpenAIModerationChain
             moderation = OpenAIModerationChain()
+
     """
 
     client: Any = None  #: :meta private:
@@ -105,6 +107,7 @@ class OpenAIModerationChain(Chain):
             return error_str
         return text
 
+    @override
     def _call(
         self,
         inputs: dict[str, Any],

langchain/chains/natbot/base.py

@@ -47,6 +47,7 @@ class NatBotChain(Chain):
 
             from langchain.chains import NatBotChain
             natbot = NatBotChain.from_default("Buy me a new hat.")
+
     """
 
     llm_chain: Runnable
@@ -66,7 +67,7 @@ class NatBotChain(Chain):
 
     @model_validator(mode="before")
     @classmethod
-    def raise_deprecation(cls, values: dict) -> Any:
+    def _raise_deprecation(cls, values: dict) -> Any:
         if "llm" in values:
             warnings.warn(
                 "Directly instantiating an NatBotChain with an llm is deprecated. "
@@ -151,6 +152,7 @@ class NatBotChain(Chain):
 
                 browser_content = "...."
                 llm_command = natbot.run("www.google.com", browser_content)
+
         """
         _inputs = {
             self.input_url_key: url,