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

langchain/chains/natbot/crawler.py

@@ -61,6 +61,7 @@ class Crawler:
     """
 
     def __init__(self) -> None:
+        """Initialize the crawler."""
         try:
             from playwright.sync_api import sync_playwright
         except ImportError as e:
@@ -78,11 +79,22 @@ class Crawler:
         self.client: CDPSession
 
     def go_to_page(self, url: str) -> None:
+        """Navigate to the given URL.
+
+        Args:
+            url: The URL to navigate to. If it does not contain a scheme, it will be
+                prefixed with "http://".
+        """
         self.page.goto(url=url if "://" in url else "http://" + url)
         self.client = self.page.context.new_cdp_session(self.page)
         self.page_element_buffer = {}
 
     def scroll(self, direction: str) -> None:
+        """Scroll the page in the given direction.
+
+        Args:
+            direction: The direction to scroll in, either "up" or "down".
+        """
         if direction == "up":
             self.page.evaluate(
                 "(document.scrollingElement || document.body).scrollTop = (document.scrollingElement || document.body).scrollTop - window.innerHeight;"  # noqa: E501
@@ -93,6 +105,11 @@ class Crawler:
             )
 
     def click(self, id_: Union[str, int]) -> None:
+        """Click on an element with the given id.
+
+        Args:
+            id_: The id of the element to click on.
+        """
         # Inject javascript into the page which removes the target= attribute from links
         js = """
 		links = document.getElementsByTagName("a");
@@ -112,13 +129,25 @@ class Crawler:
             print("Could not find element")  # noqa: T201
 
     def type(self, id_: Union[str, int], text: str) -> None:
+        """Type text into an element with the given id.
+
+        Args:
+            id_: The id of the element to type into.
+            text: The text to type into the element.
+        """
         self.click(id_)
         self.page.keyboard.type(text)
 
     def enter(self) -> None:
+        """Press the Enter key."""
         self.page.keyboard.press("Enter")
 
     def crawl(self) -> list[str]:
+        """Crawl the current page.
+
+        Returns:
+            A list of the elements in the viewport.
+        """
         page = self.page
         page_element_buffer = self.page_element_buffer
         start = time.time()

langchain/chains/openai_functions/base.py

@@ -121,6 +121,7 @@ def create_openai_fn_chain(
                 chain = create_openai_fn_chain([RecordPerson, RecordDog], llm, prompt)
                 chain.run("Harry was a chubby brown beagle who loved chicken")
                 # -> RecordDog(name="Harry", color="brown", fav_food="chicken")
+
     """  # noqa: E501
     if not functions:
         msg = "Need to pass in at least one function. Received zero."
@@ -203,6 +204,7 @@ def create_structured_output_chain(
                 chain = create_structured_output_chain(Dog, llm, prompt)
                 chain.run("Harry was a chubby brown beagle who loved chicken")
                 # -> Dog(name="Harry", color="brown", fav_food="chicken")
+
     """  # noqa: E501
     if isinstance(output_schema, dict):
         function: Any = {

langchain/chains/openai_functions/citation_fuzzy_match.py

@@ -45,6 +45,14 @@ class FactWithEvidence(BaseModel):
             yield from s.spans()
 
     def get_spans(self, context: str) -> Iterator[str]:
+        """Get spans of the substring quote in the context.
+
+        Args:
+            context: The context in which to find the spans of the substring quote.
+
+        Returns:
+            An iterator over the spans of the substring quote in the context.
+        """
         for quote in self.substring_quote:
             yield from self._get_span(quote, context)
 
@@ -86,6 +94,7 @@ def create_citation_fuzzy_match_runnable(llm: BaseChatModel) -> Runnable:
 
     Returns:
         Runnable that can be used to answer questions with citations.
+
     """
     if llm.bind_tools is BaseChatModel.bind_tools:
         msg = "Language model must implement bind_tools to use this function."

langchain/chains/openai_functions/openapi.py

@@ -13,6 +13,7 @@ from langchain_core.output_parsers.openai_functions import JsonOutputFunctionsPa
 from langchain_core.prompts import BasePromptTemplate, ChatPromptTemplate
 from langchain_core.utils.input import get_colored_text
 from requests import Response
+from typing_extensions import override
 
 from langchain.chains.base import Chain
 from langchain.chains.llm import LLMChain
@@ -202,10 +203,12 @@ class SimpleRequestChain(Chain):
     """Key to use for the input of the request."""
 
     @property
+    @override
     def input_keys(self) -> list[str]:
         return [self.input_key]
 
     @property
+    @override
     def output_keys(self) -> list[str]:
         return [self.output_key]
 
@@ -342,6 +345,7 @@ def get_openapi_chain(
             `ChatOpenAI(model="gpt-3.5-turbo-0613")`.
         prompt: Main prompt template to use.
         request_chain: Chain for taking the functions output and executing the request.
+
     """  # noqa: E501
     try:
         from langchain_community.utilities.openapi import OpenAPISpec

langchain/chains/openai_functions/qa_with_structure.py

@@ -76,11 +76,11 @@ def create_qa_with_structure_chain(
         raise ValueError(msg)
     if isinstance(schema, type) and is_basemodel_subclass(schema):
         if hasattr(schema, "model_json_schema"):
-            schema_dict = cast(dict, schema.model_json_schema())
+            schema_dict = cast("dict", schema.model_json_schema())
         else:
-            schema_dict = cast(dict, schema.schema())
+            schema_dict = cast("dict", schema.schema())
     else:
-        schema_dict = cast(dict, schema)
+        schema_dict = cast("dict", schema)
     function = {
         "name": schema_dict["title"],
         "description": schema_dict["description"],

langchain/chains/openai_functions/tagging.py

@@ -86,6 +86,7 @@ def create_tagging_chain(
 
     Returns:
         Chain (LLMChain) that can be used to extract information from a passage.
+
     """
     function = _get_tagging_function(schema)
     prompt = prompt or ChatPromptTemplate.from_template(_TAGGING_TEMPLATE)
@@ -154,6 +155,7 @@ def create_tagging_chain_pydantic(
 
     Returns:
         Chain (LLMChain) that can be used to extract information from a passage.
+
     """
     if hasattr(pydantic_schema, "model_json_schema"):
         openai_schema = pydantic_schema.model_json_schema()

langchain/chains/qa_generation/base.py

@@ -9,6 +9,7 @@ from langchain_core.language_models import BaseLanguageModel
 from langchain_core.prompts import BasePromptTemplate
 from langchain_text_splitters import RecursiveCharacterTextSplitter, TextSplitter
 from pydantic import Field
+from typing_extensions import override
 
 from langchain.chains.base import Chain
 from langchain.chains.llm import LLMChain
@@ -61,6 +62,7 @@ class QAGenerationChain(Chain):
                     split_text | RunnableEach(bound=prompt | llm | JsonOutputParser())
                 )
             )
+
     """
 
     llm_chain: LLMChain
@@ -103,10 +105,12 @@ class QAGenerationChain(Chain):
         raise NotImplementedError
 
     @property
+    @override
     def input_keys(self) -> list[str]:
         return [self.input_key]
 
     @property
+    @override
     def output_keys(self) -> list[str]:
         return [self.output_key]
 

langchain/chains/qa_with_sources/base.py

@@ -16,6 +16,7 @@ from langchain_core.documents import Document
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.prompts import BasePromptTemplate
 from pydantic import ConfigDict, model_validator
+from typing_extensions import override
 
 from langchain.chains import ReduceDocumentsChain
 from langchain.chains.base import Chain
@@ -240,6 +241,7 @@ class QAWithSourcesChain(BaseQAWithSourcesChain):
         """
         return [self.input_docs_key, self.question_key]
 
+    @override
     def _get_docs(
         self,
         inputs: dict[str, Any],
@@ -249,6 +251,7 @@ class QAWithSourcesChain(BaseQAWithSourcesChain):
         """Get docs to run questioning over."""
         return inputs.pop(self.input_docs_key)
 
+    @override
     async def _aget_docs(
         self,
         inputs: dict[str, Any],

langchain/chains/qa_with_sources/retrieval.py

@@ -33,7 +33,7 @@ class RetrievalQAWithSourcesChain(BaseQAWithSourcesChain):
             StuffDocumentsChain,
         ):
             tokens = [
-                self.combine_documents_chain.llm_chain._get_num_tokens(doc.page_content)
+                self.combine_documents_chain.llm_chain._get_num_tokens(doc.page_content)  # noqa: SLF001
                 for doc in docs
             ]
             token_count = sum(tokens[:num_docs])

langchain/chains/qa_with_sources/vector_db.py

@@ -10,6 +10,7 @@ from langchain_core.callbacks import (
 from langchain_core.documents import Document
 from langchain_core.vectorstores import VectorStore
 from pydantic import Field, model_validator
+from typing_extensions import override
 
 from langchain.chains.combine_documents.stuff import StuffDocumentsChain
 from langchain.chains.qa_with_sources.base import BaseQAWithSourcesChain
@@ -38,7 +39,7 @@ class VectorDBQAWithSourcesChain(BaseQAWithSourcesChain):
             StuffDocumentsChain,
         ):
             tokens = [
-                self.combine_documents_chain.llm_chain._get_num_tokens(doc.page_content)
+                self.combine_documents_chain.llm_chain._get_num_tokens(doc.page_content)  # noqa: SLF001
                 for doc in docs
             ]
             token_count = sum(tokens[:num_docs])
@@ -48,6 +49,7 @@ class VectorDBQAWithSourcesChain(BaseQAWithSourcesChain):
 
         return docs[:num_docs]
 
+    @override
     def _get_docs(
         self,
         inputs: dict[str, Any],
@@ -73,7 +75,7 @@ class VectorDBQAWithSourcesChain(BaseQAWithSourcesChain):
 
     @model_validator(mode="before")
     @classmethod
-    def raise_deprecation(cls, values: dict) -> Any:
+    def _raise_deprecation(cls, values: dict) -> Any:
         warnings.warn(
             "`VectorDBQAWithSourcesChain` is deprecated - "
             "please use `from langchain.chains import RetrievalQAWithSourcesChain`",

langchain/chains/query_constructor/base.py

@@ -22,6 +22,7 @@ from langchain_core.structured_query import (
     Operator,
     StructuredQuery,
 )
+from typing_extensions import override
 
 from langchain.chains.llm import LLMChain
 from langchain.chains.query_constructor.parser import get_parser
@@ -46,6 +47,7 @@ class StructuredQueryOutputParser(BaseOutputParser[StructuredQuery]):
     ast_parse: Callable
     """Callable that parses dict into internal representation of query language."""
 
+    @override
     def parse(self, text: str) -> StructuredQuery:
         try:
             expected_keys = ["query", "filter"]
@@ -89,7 +91,7 @@ class StructuredQueryOutputParser(BaseOutputParser[StructuredQuery]):
 
             def ast_parse(raw_filter: str) -> Optional[FilterDirective]:
                 filter_directive = cast(
-                    Optional[FilterDirective],
+                    "Optional[FilterDirective]",
                     get_parser().parse(raw_filter),
                 )
                 return fix_filter_directive(
@@ -142,7 +144,7 @@ def fix_filter_directive(
             return None
         args = [
             cast(
-                FilterDirective,
+                "FilterDirective",
                 fix_filter_directive(
                     arg,
                     allowed_comparators=allowed_comparators,

langchain/chains/query_constructor/parser.py

@@ -11,7 +11,7 @@ try:
     from lark import Lark, Transformer, v_args
 except ImportError:
 
-    def v_args(*args: Any, **kwargs: Any) -> Any:  # type: ignore[misc]
+    def v_args(*_: Any, **__: Any) -> Any:  # type: ignore[misc]
         """Dummy decorator for when lark is not installed."""
         return lambda _: None
 
@@ -83,15 +83,35 @@ class QueryTransformer(Transformer):
         allowed_attributes: Optional[Sequence[str]] = None,
         **kwargs: Any,
     ):
+        """Initialize the QueryTransformer.
+
+        Args:
+            allowed_comparators: Optional sequence of allowed comparators.
+            allowed_operators: Optional sequence of allowed operators.
+            allowed_attributes: Optional sequence of allowed attributes for comparators.
+            **kwargs: Additional keyword arguments.
+        """
         super().__init__(*args, **kwargs)
         self.allowed_comparators = allowed_comparators
         self.allowed_operators = allowed_operators
         self.allowed_attributes = allowed_attributes
 
     def program(self, *items: Any) -> tuple:
+        """Transform the items into a tuple."""
         return items
 
     def func_call(self, func_name: Any, args: list) -> FilterDirective:
+        """Transform a function name and args into a FilterDirective.
+
+        Args:
+            func_name: The name of the function.
+            args: The arguments passed to the function.
+        Returns:
+            FilterDirective: The filter directive.
+        Raises:
+            ValueError: If the function is a comparator and the first arg is not in the
+            allowed attributes.
+        """
         func = self._match_func_name(str(func_name))
         if isinstance(func, Comparator):
             if self.allowed_attributes and args[0] not in self.allowed_attributes:
@@ -135,26 +155,55 @@ class QueryTransformer(Transformer):
         raise ValueError(msg)
 
     def args(self, *items: Any) -> tuple:
+        """Transforms items into a tuple.
+
+        Args:
+            items: The items to transform.
+        """
         return items
 
     def false(self) -> bool:
+        """Returns false."""
         return False
 
     def true(self) -> bool:
+        """Returns true."""
         return True
 
     def list(self, item: Any) -> list:
+        """Transforms an item into a list.
+
+        Args:
+            item: The item to transform.
+        """
         if item is None:
             return []
         return list(item)
 
     def int(self, item: Any) -> int:
+        """Transforms an item into an int.
+
+        Args:
+            item: The item to transform.
+        """
         return int(item)
 
     def float(self, item: Any) -> float:
+        """Transforms an item into a float.
+
+        Args:
+            item: The item to transform.
+        """
         return float(item)
 
     def date(self, item: Any) -> ISO8601Date:
+        """Transforms an item into a ISO8601Date object.
+
+        Args:
+            item: The item to transform.
+        Raises:
+            ValueError: If the item is not in ISO 8601 date format.
+        """
         item = str(item).strip("\"'")
         try:
             datetime.datetime.strptime(item, "%Y-%m-%d")  # noqa: DTZ007
@@ -167,6 +216,13 @@ class QueryTransformer(Transformer):
         return {"date": item, "type": "date"}
 
     def datetime(self, item: Any) -> ISO8601DateTime:
+        """Transforms an item into a ISO8601DateTime object.
+
+        Args:
+            item: The item to transform.
+        Raises:
+            ValueError: If the item is not in ISO 8601 datetime format.
+        """
         item = str(item).strip("\"'")
         try:
             # Parse full ISO 8601 datetime format
@@ -180,7 +236,13 @@ class QueryTransformer(Transformer):
         return {"datetime": item, "type": "datetime"}
 
     def string(self, item: Any) -> str:
-        # Remove escaped quotes
+        """Transforms an item into a string.
+
+        Removes escaped quotes.
+
+        Args:
+            item: The item to transform.
+        """
         return str(item).strip("\"'")
 
 

langchain/chains/retrieval_qa/base.py

@@ -18,6 +18,7 @@ from langchain_core.prompts import PromptTemplate
 from langchain_core.retrievers import BaseRetriever
 from langchain_core.vectorstores import VectorStore
 from pydantic import ConfigDict, Field, model_validator
+from typing_extensions import override
 
 from langchain.chains.base import Chain
 from langchain.chains.combine_documents.base import BaseCombineDocumentsChain
@@ -146,6 +147,7 @@ class BaseRetrievalQA(Chain):
 
         res = indexqa({'query': 'This is my query'})
         answer, docs = res['result'], res['source_documents']
+
         """
         _run_manager = run_manager or CallbackManagerForChainRun.get_noop_manager()
         question = inputs[self.input_key]
@@ -190,6 +192,7 @@ class BaseRetrievalQA(Chain):
 
         res = indexqa({'query': 'This is my query'})
         answer, docs = res['result'], res['source_documents']
+
         """
         _run_manager = run_manager or AsyncCallbackManagerForChainRun.get_noop_manager()
         question = inputs[self.input_key]
@@ -330,6 +333,7 @@ class VectorDBQA(BaseRetrievalQA):
                 raise ValueError(msg)
         return values
 
+    @override
     def _get_docs(
         self,
         question: str,

langchain/chains/router/base.py

@@ -12,11 +12,14 @@ from langchain_core.callbacks import (
     Callbacks,
 )
 from pydantic import ConfigDict
+from typing_extensions import override
 
 from langchain.chains.base import Chain
 
 
 class Route(NamedTuple):
+    """A route to a destination chain."""
+
     destination: Optional[str]
     next_inputs: dict[str, Any]
 
@@ -25,12 +28,12 @@ class RouterChain(Chain, ABC):
     """Chain that outputs the name of a destination chain and the inputs to it."""
 
     @property
+    @override
     def output_keys(self) -> list[str]:
         return ["destination", "next_inputs"]
 
     def route(self, inputs: dict[str, Any], callbacks: Callbacks = None) -> Route:
-        """
-        Route inputs to a destination chain.
+        """Route inputs to a destination chain.
 
         Args:
             inputs: inputs to the chain
@@ -47,6 +50,15 @@ class RouterChain(Chain, ABC):
         inputs: dict[str, Any],
         callbacks: Callbacks = None,
     ) -> Route:
+        """Route inputs to a destination chain.
+
+        Args:
+            inputs: inputs to the chain
+            callbacks: callbacks to use for the chain
+
+        Returns:
+            a Route object
+        """
         result = await self.acall(inputs, callbacks=callbacks)
         return Route(result["destination"], result["next_inputs"])
 

langchain/chains/router/embedding_router.py

@@ -11,6 +11,7 @@ from langchain_core.documents import Document
 from langchain_core.embeddings import Embeddings
 from langchain_core.vectorstores import VectorStore
 from pydantic import ConfigDict
+from typing_extensions import override
 
 from langchain.chains.router.base import RouterChain
 
@@ -34,6 +35,7 @@ class EmbeddingRouterChain(RouterChain):
         """
         return self.routing_keys
 
+    @override
     def _call(
         self,
         inputs: dict[str, Any],
@@ -43,6 +45,7 @@ class EmbeddingRouterChain(RouterChain):
         results = self.vectorstore.similarity_search(_input, k=1)
         return {"next_inputs": inputs, "destination": results[0].metadata["name"]}
 
+    @override
     async def _acall(
         self,
         inputs: dict[str, Any],

langchain/chains/router/llm_router.py

@@ -15,7 +15,7 @@ from langchain_core.output_parsers import BaseOutputParser
 from langchain_core.prompts import BasePromptTemplate
 from langchain_core.utils.json import parse_and_check_json_markdown
 from pydantic import model_validator
-from typing_extensions import Self
+from typing_extensions import Self, override
 
 from langchain.chains import LLMChain
 from langchain.chains.router.base import RouterChain
@@ -96,13 +96,14 @@ class LLMRouterChain(RouterChain):
             )
 
             chain.invoke({"query": "what color are carrots"})
+
     """  # noqa: E501
 
     llm_chain: LLMChain
     """LLM chain used to perform routing"""
 
     @model_validator(mode="after")
-    def validate_prompt(self) -> Self:
+    def _validate_prompt(self) -> Self:
         prompt = self.llm_chain.prompt
         if prompt.output_parser is None:
             msg = (
@@ -137,7 +138,7 @@ class LLMRouterChain(RouterChain):
 
         prediction = self.llm_chain.predict(callbacks=callbacks, **inputs)
         return cast(
-            dict[str, Any],
+            "dict[str, Any]",
             self.llm_chain.prompt.output_parser.parse(prediction),
         )
 
@@ -149,7 +150,7 @@ class LLMRouterChain(RouterChain):
         _run_manager = run_manager or CallbackManagerForChainRun.get_noop_manager()
         callbacks = _run_manager.get_child()
         return cast(
-            dict[str, Any],
+            "dict[str, Any]",
             await self.llm_chain.apredict_and_parse(callbacks=callbacks, **inputs),
         )
 
@@ -172,6 +173,7 @@ class RouterOutputParser(BaseOutputParser[dict[str, str]]):
     next_inputs_type: type = str
     next_inputs_inner_key: str = "input"
 
+    @override
     def parse(self, text: str) -> dict[str, Any]:
         try:
             expected_keys = ["destination", "next_inputs"]

langchain/chains/router/multi_prompt.py

@@ -7,6 +7,7 @@ from typing import Any, Optional
 from langchain_core._api import deprecated
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.prompts import PromptTemplate
+from typing_extensions import override
 
 from langchain.chains import ConversationChain
 from langchain.chains.base import Chain
@@ -139,9 +140,11 @@ class MultiPromptChain(MultiRouteChain):
             result = await app.ainvoke({"query": "what color are carrots"})
             print(result["destination"])
             print(result["answer"])
+
     """  # noqa: E501
 
     @property
+    @override
     def output_keys(self) -> list[str]:
         return ["text"]
 

langchain/chains/router/multi_retrieval_qa.py

@@ -8,6 +8,7 @@ from typing import Any, Optional
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.prompts import PromptTemplate
 from langchain_core.retrievers import BaseRetriever
+from typing_extensions import override
 
 from langchain.chains import ConversationChain
 from langchain.chains.base import Chain
@@ -32,6 +33,7 @@ class MultiRetrievalQAChain(MultiRouteChain):
     """Default chain to use when router doesn't map input to one of the destinations."""
 
     @property
+    @override
     def output_keys(self) -> list[str]:
         return ["result"]
 
@@ -47,6 +49,22 @@ class MultiRetrievalQAChain(MultiRouteChain):
         default_chain_llm: Optional[BaseLanguageModel] = None,
         **kwargs: Any,
     ) -> MultiRetrievalQAChain:
+        """Create a multi retrieval qa chain from an LLM and a default chain.
+
+        Args:
+            llm: The language model to use.
+            retriever_infos: Dictionaries containing retriever information.
+            default_retriever: Optional default retriever to use if no default chain
+                is provided.
+            default_prompt: Optional prompt template to use for the default retriever.
+            default_chain: Optional default chain to use when router doesn't map input
+                to one of the destinations.
+            default_chain_llm: Optional language model to use if no default chain and
+                no default retriever are provided.
+            **kwargs: Additional keyword arguments to pass to the chain.
+        Returns:
+            An instance of the multi retrieval qa chain.
+        """
         if default_prompt and not default_retriever:
             msg = (
                 "`default_retriever` must be specified if `default_prompt` is "

langchain/chains/sql_database/query.py

@@ -113,6 +113,7 @@ def create_sql_query_chain(
 
             Question: {input}'''
             prompt = PromptTemplate.from_template(template)
+
     """  # noqa: E501
     if prompt is not None:
         prompt_to_use = prompt

langchain/chains/structured_output/base.py

@@ -132,6 +132,7 @@ def create_openai_fn_runnable(
                 structured_llm = create_openai_fn_runnable([RecordPerson, RecordDog], llm)
                 structured_llm.invoke("Harry was a chubby brown beagle who loved chicken)
                 # -> RecordDog(name="Harry", color="brown", fav_food="chicken")
+
     """  # noqa: E501
     if not functions:
         msg = "Need to pass in at least one function. Received zero."
@@ -390,6 +391,7 @@ def create_structured_output_runnable(
                 )
                 chain = prompt | structured_llm
                 chain.invoke({"input": "Harry was a chubby brown beagle who loved chicken"})
+
     """  # noqa: E501
     # for backwards compatibility
     force_function_usage = kwargs.get(