langchain 0.2.11__py3-none-any.whl → 0.2.13__py3-none-any.whl

langchain/chains/openai_functions/qa_with_structure.py

@@ -1,5 +1,6 @@
 from typing import Any, List, Optional, Type, Union, cast
 
+from langchain_core._api import deprecated
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.messages import HumanMessage, SystemMessage
 from langchain_core.output_parsers import BaseLLMOutputParser
@@ -25,6 +26,15 @@ class AnswerWithSources(BaseModel):
     )
 
 
+@deprecated(
+    since="0.2.13",
+    removal="1.0",
+    message=(
+        "This function is deprecated. Refer to this guide on retrieval and question "
+        "answering with structured responses: "
+        "https://python.langchain.com/v0.2/docs/how_to/qa_sources/#structure-sources-in-model-response"  # noqa: E501
+    ),
+)
 def create_qa_with_structure_chain(
     llm: BaseLanguageModel,
     schema: Union[dict, Type[BaseModel]],
@@ -95,6 +105,15 @@ def create_qa_with_structure_chain(
     return chain
 
 
+@deprecated(
+    since="0.2.13",
+    removal="1.0",
+    message=(
+        "This function is deprecated. Refer to this guide on retrieval and question "
+        "answering with sources: "
+        "https://python.langchain.com/v0.2/docs/how_to/qa_sources/#structure-sources-in-model-response"  # noqa: E501
+    ),
+)
 def create_qa_with_sources_chain(
     llm: BaseLanguageModel, verbose: bool = False, **kwargs: Any
 ) -> LLMChain:

langchain/chains/openai_functions/tagging.py

@@ -1,5 +1,6 @@
 from typing import Any, Optional
 
+from langchain_core._api import deprecated
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.output_parsers.openai_functions import (
     JsonOutputFunctionsParser,
@@ -29,6 +30,21 @@ Passage:
 """
 
 
+@deprecated(
+    since="0.2.13",
+    message=(
+        "LangChain has introduced a method called `with_structured_output` that "
+        "is available on ChatModels capable of tool calling. "
+        "See API reference for this function for replacement: "
+        "<https://api.python.langchain.com/en/latest/chains/langchain.chains.openai_functions.tagging.create_tagging_chain.html> "  # noqa: E501
+        "You can read more about `with_structured_output` here: "
+        "<https://python.langchain.com/v0.2/docs/how_to/structured_output/>. "
+        "If you notice other issues, please provide "
+        "feedback here: "
+        "<https://github.com/langchain-ai/langchain/discussions/18154>"
+    ),
+    removal="1.0",
+)
 def create_tagging_chain(
     schema: dict,
     llm: BaseLanguageModel,
@@ -38,6 +54,32 @@ def create_tagging_chain(
     """Create a chain that extracts information from a passage
      based on a schema.
 
+     This function is deprecated. Please use `with_structured_output` instead.
+     See example usage below:
+
+        .. code-block:: python
+
+            from typing_extensions import Annotated, TypedDict
+            from langchain_anthropic import ChatAnthropic
+
+            class Joke(TypedDict):
+                \"\"\"Tagged joke.\"\"\"
+
+                setup: Annotated[str, ..., "The setup of the joke"]
+                punchline: Annotated[str, ..., "The punchline of the joke"]
+
+            # Or any other chat model that supports tools.
+            # Please reference to to the documentation of structured_output
+            # to see an up to date list of which models support
+            # with_structured_output.
+            model = ChatAnthropic(model="claude-3-haiku-20240307", temperature=0)
+            structured_llm = model.with_structured_output(Joke)
+            structured_llm.invoke(
+                "Why did the cat cross the road? To get to the other "
+                "side... and then lay down in the middle of it!"
+            )
+    Read more here: https://python.langchain.com/v0.2/docs/how_to/structured_output/
+
     Args:
         schema: The schema of the entities to extract.
         llm: The language model to use.
@@ -59,6 +101,21 @@ def create_tagging_chain(
     return chain
 
 
+@deprecated(
+    since="0.2.13",
+    message=(
+        "LangChain has introduced a method called `with_structured_output` that "
+        "is available on ChatModels capable of tool calling. "
+        "See API reference for this function for replacement: "
+        "<https://api.python.langchain.com/en/latest/chains/langchain.chains.openai_functions.tagging.create_tagging_chain_pydantic.html> "  # noqa: E501
+        "You can read more about `with_structured_output` here: "
+        "<https://python.langchain.com/v0.2/docs/how_to/structured_output/>. "
+        "If you notice other issues, please provide "
+        "feedback here: "
+        "<https://github.com/langchain-ai/langchain/discussions/18154>"
+    ),
+    removal="1.0",
+)
 def create_tagging_chain_pydantic(
     pydantic_schema: Any,
     llm: BaseLanguageModel,
@@ -68,6 +125,30 @@ def create_tagging_chain_pydantic(
     """Create a chain that extracts information from a passage
      based on a pydantic schema.
 
+     This function is deprecated. Please use `with_structured_output` instead.
+     See example usage below:
+
+     .. code-block:: python
+
+            from langchain_core.pydantic_v1 import BaseModel, Field
+            from langchain_anthropic import ChatAnthropic
+
+            class Joke(BaseModel):
+                setup: str = Field(description="The setup of the joke")
+                punchline: str = Field(description="The punchline to the joke")
+
+            # Or any other chat model that supports tools.
+            # Please reference to to the documentation of structured_output
+            # to see an up to date list of which models support
+            # with_structured_output.
+            model = ChatAnthropic(model="claude-3-opus-20240229", temperature=0)
+            structured_llm = model.with_structured_output(Joke)
+            structured_llm.invoke(
+                "Why did the cat cross the road? To get to the other "
+                "side... and then lay down in the middle of it!"
+            )
+    Read more here: https://python.langchain.com/v0.2/docs/how_to/structured_output/
+
     Args:
         pydantic_schema: The pydantic schema of the entities to extract.
         llm: The language model to use.

langchain/chains/qa_with_sources/base.py

@@ -7,6 +7,7 @@ import re
 from abc import ABC, abstractmethod
 from typing import Any, Dict, List, Optional, Tuple
 
+from langchain_core._api import deprecated
 from langchain_core.callbacks import (
     AsyncCallbackManagerForChainRun,
     CallbackManagerForChainRun,
@@ -14,7 +15,7 @@ from langchain_core.callbacks import (
 from langchain_core.documents import Document
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.prompts import BasePromptTemplate
-from langchain_core.pydantic_v1 import Extra, root_validator
+from langchain_core.pydantic_v1 import root_validator
 
 from langchain.chains import ReduceDocumentsChain
 from langchain.chains.base import Chain
@@ -30,6 +31,15 @@ from langchain.chains.qa_with_sources.map_reduce_prompt import (
 )
 
 
+@deprecated(
+    since="0.2.13",
+    removal="1.0",
+    message=(
+        "This class is deprecated. Refer to this guide on retrieval and question "
+        "answering with sources: "
+        "https://python.langchain.com/v0.2/docs/how_to/qa_sources/"
+    ),
+)
 class BaseQAWithSourcesChain(Chain, ABC):
     """Question answering chain with sources over documents."""
 
@@ -88,10 +98,8 @@ class BaseQAWithSourcesChain(Chain, ABC):
         return cls(combine_documents_chain=combine_documents_chain, **kwargs)
 
     class Config:
-        """Configuration for this pydantic object."""
-
-        extra = Extra.forbid
         arbitrary_types_allowed = True
+        extra = "forbid"
 
     @property
     def input_keys(self) -> List[str]:
@@ -200,6 +208,15 @@ class BaseQAWithSourcesChain(Chain, ABC):
         return result
 
 
+@deprecated(
+    since="0.2.13",
+    removal="1.0",
+    message=(
+        "This class is deprecated. Refer to this guide on retrieval and question "
+        "answering with sources: "
+        "https://python.langchain.com/v0.2/docs/how_to/qa_sources/"
+    ),
+)
 class QAWithSourcesChain(BaseQAWithSourcesChain):
     """Question answering with sources over documents."""
 

langchain/chains/qa_with_sources/loading.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 from typing import Any, Mapping, Optional, Protocol
 
+from langchain_core._api import deprecated
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.prompts import BasePromptTemplate
 
@@ -151,6 +152,21 @@ def _load_refine_chain(
     )
 
 
+@deprecated(
+    since="0.2.13",
+    removal="1.0",
+    message=(
+        "This function is deprecated. Refer to this guide on retrieval and question "
+        "answering with sources: "
+        "https://python.langchain.com/v0.2/docs/how_to/qa_sources/"
+        "\nSee also the following migration guides for replacements "
+        "based on `chain_type`:\n"
+        "stuff: https://python.langchain.com/v0.2/docs/versions/migrating_chains/stuff_docs_chain\n"  # noqa: E501
+        "map_reduce: https://python.langchain.com/v0.2/docs/versions/migrating_chains/map_reduce_chain\n"  # noqa: E501
+        "refine: https://python.langchain.com/v0.2/docs/versions/migrating_chains/refine_chain\n"  # noqa: E501
+        "map_rerank: https://python.langchain.com/v0.2/docs/versions/migrating_chains/map_rerank_docs_chain\n"  # noqa: E501
+    ),
+)
 def load_qa_with_sources_chain(
     llm: BaseLanguageModel,
     chain_type: str = "stuff",

langchain/chains/query_constructor/base.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 import json
 from typing import Any, Callable, List, Optional, Sequence, Tuple, Union, cast
 
+from langchain_core._api import deprecated
 from langchain_core.exceptions import OutputParserException
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.output_parsers import BaseOutputParser
@@ -217,7 +218,7 @@ def get_query_constructor_prompt(
         enable_limit: Whether to enable the limit operator. Defaults to False.
         schema_prompt: Prompt for describing query schema. Should have string input
             variables allowed_comparators and allowed_operators.
-        **kwargs: Additional named params to pass to FewShotPromptTemplate init.
+        kwargs: Additional named params to pass to FewShotPromptTemplate init.
 
     Returns:
         A prompt template that can be used to construct queries.
@@ -257,6 +258,11 @@ def get_query_constructor_prompt(
     )
 
 
+@deprecated(
+    since="0.2.13",
+    alternative="load_query_constructor_runnable",
+    removal="1.0",
+)
 def load_query_constructor_chain(
     llm: BaseLanguageModel,
     document_contents: str,
@@ -339,7 +345,7 @@ def load_query_constructor_runnable(
             variables allowed_comparators and allowed_operators.
         fix_invalid: Whether to fix invalid filter directives by ignoring invalid
             operators, comparators and attributes.
-        **kwargs: Additional named params to pass to FewShotPromptTemplate init.
+        kwargs: Additional named params to pass to FewShotPromptTemplate init.
 
     Returns:
         A Runnable that can be used to construct queries.

langchain/chains/query_constructor/schema.py

@@ -9,7 +9,5 @@ class AttributeInfo(BaseModel):
     type: str
 
     class Config:
-        """Configuration for this pydantic object."""
-
         arbitrary_types_allowed = True
         frozen = True

langchain/chains/question_answering/chain.py

@@ -2,6 +2,7 @@
 
 from typing import Any, Mapping, Optional, Protocol
 
+from langchain_core._api import deprecated
 from langchain_core.callbacks import BaseCallbackManager, Callbacks
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.prompts import BasePromptTemplate
@@ -216,6 +217,20 @@ def _load_refine_chain(
     )
 
 
+@deprecated(
+    since="0.2.13",
+    removal="1.0",
+    message=(
+        "This class is deprecated. See the following migration guides for replacements "
+        "based on `chain_type`:\n"
+        "stuff: https://python.langchain.com/v0.2/docs/versions/migrating_chains/stuff_docs_chain\n"  # noqa: E501
+        "map_reduce: https://python.langchain.com/v0.2/docs/versions/migrating_chains/map_reduce_chain\n"  # noqa: E501
+        "refine: https://python.langchain.com/v0.2/docs/versions/migrating_chains/refine_chain\n"  # noqa: E501
+        "map_rerank: https://python.langchain.com/v0.2/docs/versions/migrating_chains/map_rerank_docs_chain\n"  # noqa: E501
+        "\nSee also guides on retrieval and question-answering here: "
+        "https://python.langchain.com/v0.2/docs/how_to/#qa-with-rag"
+    ),
+)
 def load_qa_chain(
     llm: BaseLanguageModel,
     chain_type: str = "stuff",

langchain/chains/retrieval_qa/base.py

@@ -16,7 +16,7 @@ from langchain_core.callbacks import (
 from langchain_core.documents import Document
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.prompts import PromptTemplate
-from langchain_core.pydantic_v1 import Extra, Field, root_validator
+from langchain_core.pydantic_v1 import Field, root_validator
 from langchain_core.retrievers import BaseRetriever
 from langchain_core.vectorstores import VectorStore
 
@@ -28,6 +28,15 @@ from langchain.chains.question_answering import load_qa_chain
 from langchain.chains.question_answering.stuff_prompt import PROMPT_SELECTOR
 
 
+@deprecated(
+    since="0.2.13",
+    removal="1.0",
+    message=(
+        "This class is deprecated. Use the `create_retrieval_chain` constructor "
+        "instead. See migration guide here: "
+        "https://python.langchain.com/v0.2/docs/versions/migrating_chains/retrieval_qa/"
+    ),
+)
 class BaseRetrievalQA(Chain):
     """Base class for question-answering chains."""
 
@@ -39,11 +48,9 @@ class BaseRetrievalQA(Chain):
     """Return the source documents or not."""
 
     class Config:
-        """Configuration for this pydantic object."""
-
-        extra = Extra.forbid
-        arbitrary_types_allowed = True
         allow_population_by_field_name = True
+        arbitrary_types_allowed = True
+        extra = "forbid"
 
     @property
     def input_keys(self) -> List[str]:
@@ -196,7 +203,15 @@ class BaseRetrievalQA(Chain):
             return {self.output_key: answer}
 
 
-@deprecated(since="0.1.17", alternative="create_retrieval_chain", removal="0.3.0")
+@deprecated(
+    since="0.1.17",
+    removal="1.0",
+    message=(
+        "This class is deprecated. Use the `create_retrieval_chain` constructor "
+        "instead. See migration guide here: "
+        "https://python.langchain.com/v0.2/docs/versions/migrating_chains/retrieval_qa/"
+    ),
+)
 class RetrievalQA(BaseRetrievalQA):
     """Chain for question-answering against an index.
 
@@ -273,6 +288,15 @@ class RetrievalQA(BaseRetrievalQA):
         return "retrieval_qa"
 
 
+@deprecated(
+    since="0.2.13",
+    removal="1.0",
+    message=(
+        "This class is deprecated. Use the `create_retrieval_chain` constructor "
+        "instead. See migration guide here: "
+        "https://python.langchain.com/v0.2/docs/versions/migrating_chains/retrieval_qa/"
+    ),
+)
 class VectorDBQA(BaseRetrievalQA):
     """Chain for question-answering against a vector database."""
 

langchain/chains/router/base.py

@@ -10,7 +10,6 @@ from langchain_core.callbacks import (
     CallbackManagerForChainRun,
     Callbacks,
 )
-from langchain_core.pydantic_v1 import Extra
 
 from langchain.chains.base import Chain
 
@@ -62,10 +61,8 @@ class MultiRouteChain(Chain):
     Defaults to False."""
 
     class Config:
-        """Configuration for this pydantic object."""
-
-        extra = Extra.forbid
         arbitrary_types_allowed = True
+        extra = "forbid"
 
     @property
     def input_keys(self) -> List[str]:

langchain/chains/router/embedding_router.py

@@ -8,7 +8,6 @@ from langchain_core.callbacks import (
 )
 from langchain_core.documents import Document
 from langchain_core.embeddings import Embeddings
-from langchain_core.pydantic_v1 import Extra
 from langchain_core.vectorstores import VectorStore
 
 from langchain.chains.router.base import RouterChain
@@ -21,10 +20,8 @@ class EmbeddingRouterChain(RouterChain):
     routing_keys: List[str] = ["query"]
 
     class Config:
-        """Configuration for this pydantic object."""
-
-        extra = Extra.forbid
         arbitrary_types_allowed = True
+        extra = "forbid"
 
     @property
     def input_keys(self) -> List[str]:

langchain/chains/router/llm_router.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 from typing import Any, Dict, List, Optional, Type, cast
 
+from langchain_core._api import deprecated
 from langchain_core.callbacks import (
     AsyncCallbackManagerForChainRun,
     CallbackManagerForChainRun,
@@ -19,8 +20,82 @@ from langchain.chains import LLMChain
 from langchain.chains.router.base import RouterChain
 
 
+@deprecated(
+    since="0.2.12",
+    removal="1.0",
+    message=(
+        "Use RunnableLambda to select from multiple prompt templates. See example "
+        "in API reference: "
+        "https://api.python.langchain.com/en/latest/chains/langchain.chains.router.llm_router.LLMRouterChain.html"  # noqa: E501
+    ),
+)
 class LLMRouterChain(RouterChain):
-    """A router chain that uses an LLM chain to perform routing."""
+    """A router chain that uses an LLM chain to perform routing.
+
+    This class is deprecated. See below for a replacement, which offers several
+    benefits, including streaming and batch support.
+
+    Below is an example implementation:
+
+        .. code-block:: python
+
+            from operator import itemgetter
+            from typing import Literal
+            from typing_extensions import TypedDict
+
+            from langchain_core.output_parsers import StrOutputParser
+            from langchain_core.prompts import ChatPromptTemplate
+            from langchain_core.runnables import RunnableLambda, RunnablePassthrough
+            from langchain_openai import ChatOpenAI
+
+            llm = ChatOpenAI(model="gpt-4o-mini")
+
+            prompt_1 = ChatPromptTemplate.from_messages(
+                [
+                    ("system", "You are an expert on animals."),
+                    ("human", "{query}"),
+                ]
+            )
+            prompt_2 = ChatPromptTemplate.from_messages(
+                [
+                    ("system", "You are an expert on vegetables."),
+                    ("human", "{query}"),
+                ]
+            )
+
+            chain_1 = prompt_1 | llm | StrOutputParser()
+            chain_2 = prompt_2 | llm | StrOutputParser()
+
+            route_system = "Route the user's query to either the animal or vegetable expert."
+            route_prompt = ChatPromptTemplate.from_messages(
+                [
+                    ("system", route_system),
+                    ("human", "{query}"),
+                ]
+            )
+
+
+            class RouteQuery(TypedDict):
+                \"\"\"Route query to destination.\"\"\"
+                destination: Literal["animal", "vegetable"]
+
+
+            route_chain = (
+                route_prompt
+                | llm.with_structured_output(RouteQuery)
+                | itemgetter("destination")
+            )
+
+            chain = {
+                "destination": route_chain,  # "animal" or "vegetable"
+                "query": lambda x: x["query"],  # pass through input query
+            } | RunnableLambda(
+                # if animal, chain_1. otherwise, chain_2.
+                lambda x: chain_1 if x["destination"] == "animal" else chain_2,
+            )
+
+            chain.invoke({"query": "what color are carrots"})
+    """  # noqa: E501
 
     llm_chain: LLMChain
     """LLM chain used to perform routing"""

langchain/chains/router/multi_prompt.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 from typing import Any, Dict, List, Optional
 
+from langchain_core._api import deprecated
 from langchain_core.language_models import BaseLanguageModel
 from langchain_core.prompts import PromptTemplate
 
@@ -15,8 +16,82 @@ from langchain.chains.router.llm_router import LLMRouterChain, RouterOutputParse
 from langchain.chains.router.multi_prompt_prompt import MULTI_PROMPT_ROUTER_TEMPLATE
 
 
+@deprecated(
+    since="0.2.12",
+    removal="1.0",
+    message=(
+        "Use RunnableLambda to select from multiple prompt templates. See example "
+        "in API reference: "
+        "https://api.python.langchain.com/en/latest/chains/langchain.chains.router.multi_prompt.MultiPromptChain.html"  # noqa: E501
+    ),
+)
 class MultiPromptChain(MultiRouteChain):
-    """A multi-route chain that uses an LLM router chain to choose amongst prompts."""
+    """A multi-route chain that uses an LLM router chain to choose amongst prompts.
+
+    This class is deprecated. See below for a replacement, which offers several
+    benefits, including streaming and batch support.
+
+    Below is an example implementation:
+
+        .. code-block:: python
+
+            from operator import itemgetter
+            from typing import Literal
+            from typing_extensions import TypedDict
+
+            from langchain_core.output_parsers import StrOutputParser
+            from langchain_core.prompts import ChatPromptTemplate
+            from langchain_core.runnables import RunnableLambda, RunnablePassthrough
+            from langchain_openai import ChatOpenAI
+
+            llm = ChatOpenAI(model="gpt-4o-mini")
+
+            prompt_1 = ChatPromptTemplate.from_messages(
+                [
+                    ("system", "You are an expert on animals."),
+                    ("human", "{query}"),
+                ]
+            )
+            prompt_2 = ChatPromptTemplate.from_messages(
+                [
+                    ("system", "You are an expert on vegetables."),
+                    ("human", "{query}"),
+                ]
+            )
+
+            chain_1 = prompt_1 | llm | StrOutputParser()
+            chain_2 = prompt_2 | llm | StrOutputParser()
+
+            route_system = "Route the user's query to either the animal or vegetable expert."
+            route_prompt = ChatPromptTemplate.from_messages(
+                [
+                    ("system", route_system),
+                    ("human", "{query}"),
+                ]
+            )
+
+
+            class RouteQuery(TypedDict):
+                \"\"\"Route query to destination.\"\"\"
+                destination: Literal["animal", "vegetable"]
+
+
+            route_chain = (
+                route_prompt
+                | llm.with_structured_output(RouteQuery)
+                | itemgetter("destination")
+            )
+
+            chain = {
+                "destination": route_chain,  # "animal" or "vegetable"
+                "query": lambda x: x["query"],  # pass through input query
+            } | RunnableLambda(
+                # if animal, chain_1. otherwise, chain_2.
+                lambda x: chain_1 if x["destination"] == "animal" else chain_2,
+            )
+
+            chain.invoke({"query": "what color are carrots"})
+    """  # noqa: E501
 
     @property
     def output_keys(self) -> List[str]:

langchain/chains/sequential.py

@@ -6,7 +6,7 @@ from langchain_core.callbacks import (
     AsyncCallbackManagerForChainRun,
     CallbackManagerForChainRun,
 )
-from langchain_core.pydantic_v1 import Extra, root_validator
+from langchain_core.pydantic_v1 import root_validator
 from langchain_core.utils.input import get_color_mapping
 
 from langchain.chains.base import Chain
@@ -21,10 +21,8 @@ class SequentialChain(Chain):
     return_all: bool = False
 
     class Config:
-        """Configuration for this pydantic object."""
-
-        extra = Extra.forbid
         arbitrary_types_allowed = True
+        extra = "forbid"
 
     @property
     def input_keys(self) -> List[str]:
@@ -132,10 +130,8 @@ class SimpleSequentialChain(Chain):
     output_key: str = "output"  #: :meta private:
 
     class Config:
-        """Configuration for this pydantic object."""
-
-        extra = Extra.forbid
         arbitrary_types_allowed = True
+        extra = "forbid"
 
     @property
     def input_keys(self) -> List[str]:

langchain/chains/structured_output/base.py

@@ -224,7 +224,7 @@ def create_structured_output_runnable(
             structured outputs or a single one. If True and model does not return any 
             structured outputs then chain output is None. If False and model does not 
             return any structured outputs then chain output is an empty list.
-        **kwargs: Additional named arguments.
+        kwargs: Additional named arguments.
 
     Returns:
         A runnable sequence that will return a structured output(s) matching the given