langchain 0.4.0.dev0__py3-none-any.whl → 1.0.0a1__py3-none-any.whl

langchain/__init__.py

@@ -1,453 +1,26 @@
-"""Main entrypoint into package."""
+"""Main entrypoint into LangChain."""
 
-import warnings
-from importlib import metadata
-from typing import Any, Optional
+from typing import Any
 
-from langchain_core._api.deprecation import surface_langchain_deprecation_warnings
+__version__ = "1.0.0a1"
 
-try:
-    __version__ = metadata.version(__package__)
-except metadata.PackageNotFoundError:
-    # Case where package metadata is not available.
-    __version__ = ""
-del metadata  # optional, avoids polluting the results of dir(__package__)
 
+def __getattr__(name: str) -> Any:  # noqa: ANN401
+    """Get an attribute from the package.
 
-def _warn_on_import(name: str, replacement: Optional[str] = None) -> None:
-    """Warn on import of deprecated module."""
-    from langchain._api.interactive_env import is_interactive_env
-
-    if is_interactive_env():
-        # No warnings for interactive environments.
-        # This is done to avoid polluting the output of interactive environments
-        # where users rely on auto-complete and may trigger this warning
-        # even if they are not using any deprecated modules
-        return
-
-    if replacement:
-        warnings.warn(
-            f"Importing {name} from langchain root module is no longer supported. "
-            f"Please use {replacement} instead.",
-            stacklevel=3,
-        )
-    else:
-        warnings.warn(
-            f"Importing {name} from langchain root module is no longer supported.",
-            stacklevel=3,
-        )
-
-
-# Surfaces Deprecation and Pending Deprecation warnings from langchain.
-surface_langchain_deprecation_warnings()
-
-
-def __getattr__(name: str) -> Any:
-    if name == "MRKLChain":
-        from langchain.agents import MRKLChain
-
-        _warn_on_import(name, replacement="langchain.agents.MRKLChain")
-
-        return MRKLChain
-    if name == "ReActChain":
-        from langchain.agents import ReActChain
-
-        _warn_on_import(name, replacement="langchain.agents.ReActChain")
-
-        return ReActChain
-    if name == "SelfAskWithSearchChain":
-        from langchain.agents import SelfAskWithSearchChain
-
-        _warn_on_import(name, replacement="langchain.agents.SelfAskWithSearchChain")
-
-        return SelfAskWithSearchChain
-    if name == "ConversationChain":
-        from langchain.chains import ConversationChain
-
-        _warn_on_import(name, replacement="langchain.chains.ConversationChain")
-
-        return ConversationChain
-    if name == "LLMBashChain":
-        msg = (
-            "This module has been moved to langchain-experimental. "
-            "For more details: "
-            "https://github.com/langchain-ai/langchain/discussions/11352."
-            "To access this code, install it with `pip install langchain-experimental`."
-            "`from langchain_experimental.llm_bash.base "
-            "import LLMBashChain`"
-        )
-        raise ImportError(msg)
-
-    if name == "LLMChain":
-        from langchain.chains import LLMChain
-
-        _warn_on_import(name, replacement="langchain.chains.LLMChain")
-
-        return LLMChain
-    if name == "LLMCheckerChain":
-        from langchain.chains import LLMCheckerChain
-
-        _warn_on_import(name, replacement="langchain.chains.LLMCheckerChain")
-
-        return LLMCheckerChain
-    if name == "LLMMathChain":
-        from langchain.chains import LLMMathChain
-
-        _warn_on_import(name, replacement="langchain.chains.LLMMathChain")
-
-        return LLMMathChain
-    if name == "QAWithSourcesChain":
-        from langchain.chains import QAWithSourcesChain
-
-        _warn_on_import(name, replacement="langchain.chains.QAWithSourcesChain")
-
-        return QAWithSourcesChain
-    if name == "VectorDBQA":
-        from langchain.chains import VectorDBQA
-
-        _warn_on_import(name, replacement="langchain.chains.VectorDBQA")
-
-        return VectorDBQA
-    if name == "VectorDBQAWithSourcesChain":
-        from langchain.chains import VectorDBQAWithSourcesChain
-
-        _warn_on_import(name, replacement="langchain.chains.VectorDBQAWithSourcesChain")
-
-        return VectorDBQAWithSourcesChain
-    if name == "InMemoryDocstore":
-        from langchain_community.docstore import InMemoryDocstore
-
-        _warn_on_import(name, replacement="langchain.docstore.InMemoryDocstore")
-
-        return InMemoryDocstore
-    if name == "Wikipedia":
-        from langchain_community.docstore import Wikipedia
-
-        _warn_on_import(name, replacement="langchain.docstore.Wikipedia")
-
-        return Wikipedia
-    if name == "Anthropic":
-        from langchain_community.llms import Anthropic
-
-        _warn_on_import(name, replacement="langchain_community.llms.Anthropic")
-
-        return Anthropic
-    if name == "Banana":
-        from langchain_community.llms import Banana
-
-        _warn_on_import(name, replacement="langchain_community.llms.Banana")
-
-        return Banana
-    if name == "CerebriumAI":
-        from langchain_community.llms import CerebriumAI
-
-        _warn_on_import(name, replacement="langchain_community.llms.CerebriumAI")
-
-        return CerebriumAI
-    if name == "Cohere":
-        from langchain_community.llms import Cohere
-
-        _warn_on_import(name, replacement="langchain_community.llms.Cohere")
-
-        return Cohere
-    if name == "ForefrontAI":
-        from langchain_community.llms import ForefrontAI
-
-        _warn_on_import(name, replacement="langchain_community.llms.ForefrontAI")
-
-        return ForefrontAI
-    if name == "GooseAI":
-        from langchain_community.llms import GooseAI
-
-        _warn_on_import(name, replacement="langchain_community.llms.GooseAI")
-
-        return GooseAI
-    if name == "HuggingFaceHub":
-        from langchain_community.llms import HuggingFaceHub
-
-        _warn_on_import(name, replacement="langchain_community.llms.HuggingFaceHub")
-
-        return HuggingFaceHub
-    if name == "HuggingFaceTextGenInference":
-        from langchain_community.llms import HuggingFaceTextGenInference
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.llms.HuggingFaceTextGenInference",
-        )
-
-        return HuggingFaceTextGenInference
-    if name == "LlamaCpp":
-        from langchain_community.llms import LlamaCpp
-
-        _warn_on_import(name, replacement="langchain_community.llms.LlamaCpp")
-
-        return LlamaCpp
-    if name == "Modal":
-        from langchain_community.llms import Modal
-
-        _warn_on_import(name, replacement="langchain_community.llms.Modal")
-
-        return Modal
-    if name == "OpenAI":
-        from langchain_community.llms import OpenAI
-
-        _warn_on_import(name, replacement="langchain_community.llms.OpenAI")
-
-        return OpenAI
-    if name == "Petals":
-        from langchain_community.llms import Petals
-
-        _warn_on_import(name, replacement="langchain_community.llms.Petals")
-
-        return Petals
-    if name == "PipelineAI":
-        from langchain_community.llms import PipelineAI
-
-        _warn_on_import(name, replacement="langchain_community.llms.PipelineAI")
-
-        return PipelineAI
-    if name == "SagemakerEndpoint":
-        from langchain_community.llms import SagemakerEndpoint
-
-        _warn_on_import(name, replacement="langchain_community.llms.SagemakerEndpoint")
-
-        return SagemakerEndpoint
-    if name == "StochasticAI":
-        from langchain_community.llms import StochasticAI
-
-        _warn_on_import(name, replacement="langchain_community.llms.StochasticAI")
-
-        return StochasticAI
-    if name == "Writer":
-        from langchain_community.llms import Writer
-
-        _warn_on_import(name, replacement="langchain_community.llms.Writer")
-
-        return Writer
-    if name == "HuggingFacePipeline":
-        from langchain_community.llms.huggingface_pipeline import HuggingFacePipeline
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.llms.huggingface_pipeline.HuggingFacePipeline",
-        )
-
-        return HuggingFacePipeline
-    if name == "FewShotPromptTemplate":
-        from langchain_core.prompts import FewShotPromptTemplate
-
-        _warn_on_import(
-            name,
-            replacement="langchain_core.prompts.FewShotPromptTemplate",
-        )
-
-        return FewShotPromptTemplate
-    if name == "Prompt":
-        from langchain_core.prompts import PromptTemplate
-
-        _warn_on_import(name, replacement="langchain_core.prompts.PromptTemplate")
-
-        # it's renamed as prompt template anyways
-        # this is just for backwards compat
-        return PromptTemplate
-    if name == "PromptTemplate":
-        from langchain_core.prompts import PromptTemplate
-
-        _warn_on_import(name, replacement="langchain_core.prompts.PromptTemplate")
-
-        return PromptTemplate
-    if name == "BasePromptTemplate":
-        from langchain_core.prompts import BasePromptTemplate
-
-        _warn_on_import(name, replacement="langchain_core.prompts.BasePromptTemplate")
-
-        return BasePromptTemplate
-    if name == "ArxivAPIWrapper":
-        from langchain_community.utilities import ArxivAPIWrapper
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.utilities.ArxivAPIWrapper",
-        )
-
-        return ArxivAPIWrapper
-    if name == "GoldenQueryAPIWrapper":
-        from langchain_community.utilities import GoldenQueryAPIWrapper
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.utilities.GoldenQueryAPIWrapper",
-        )
-
-        return GoldenQueryAPIWrapper
-    if name == "GoogleSearchAPIWrapper":
-        from langchain_community.utilities import GoogleSearchAPIWrapper
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.utilities.GoogleSearchAPIWrapper",
-        )
-
-        return GoogleSearchAPIWrapper
-    if name == "GoogleSerperAPIWrapper":
-        from langchain_community.utilities import GoogleSerperAPIWrapper
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.utilities.GoogleSerperAPIWrapper",
-        )
-
-        return GoogleSerperAPIWrapper
-    if name == "PowerBIDataset":
-        from langchain_community.utilities import PowerBIDataset
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.utilities.PowerBIDataset",
-        )
-
-        return PowerBIDataset
-    if name == "SearxSearchWrapper":
-        from langchain_community.utilities import SearxSearchWrapper
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.utilities.SearxSearchWrapper",
-        )
-
-        return SearxSearchWrapper
-    if name == "WikipediaAPIWrapper":
-        from langchain_community.utilities import WikipediaAPIWrapper
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.utilities.WikipediaAPIWrapper",
-        )
-
-        return WikipediaAPIWrapper
-    if name == "WolframAlphaAPIWrapper":
-        from langchain_community.utilities import WolframAlphaAPIWrapper
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.utilities.WolframAlphaAPIWrapper",
-        )
-
-        return WolframAlphaAPIWrapper
-    if name == "SQLDatabase":
-        from langchain_community.utilities import SQLDatabase
-
-        _warn_on_import(name, replacement="langchain_community.utilities.SQLDatabase")
-
-        return SQLDatabase
-    if name == "FAISS":
-        from langchain_community.vectorstores import FAISS
-
-        _warn_on_import(name, replacement="langchain_community.vectorstores.FAISS")
-
-        return FAISS
-    if name == "ElasticVectorSearch":
-        from langchain_community.vectorstores import ElasticVectorSearch
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.vectorstores.ElasticVectorSearch",
-        )
-
-        return ElasticVectorSearch
-    # For backwards compatibility
-    if name in {"SerpAPIChain", "SerpAPIWrapper"}:
-        from langchain_community.utilities import SerpAPIWrapper
-
-        _warn_on_import(
-            name,
-            replacement="langchain_community.utilities.SerpAPIWrapper",
-        )
-
-        return SerpAPIWrapper
+    TODO: will be removed in a future alpha version.
+    """
     if name == "verbose":
         from langchain.globals import _verbose
 
-        _warn_on_import(
-            name,
-            replacement=(
-                "langchain.globals.set_verbose() / langchain.globals.get_verbose()"
-            ),
-        )
-
         return _verbose
     if name == "debug":
         from langchain.globals import _debug
 
-        _warn_on_import(
-            name,
-            replacement=(
-                "langchain.globals.set_debug() / langchain.globals.get_debug()"
-            ),
-        )
-
         return _debug
     if name == "llm_cache":
         from langchain.globals import _llm_cache
 
-        _warn_on_import(
-            name,
-            replacement=(
-                "langchain.globals.set_llm_cache() / langchain.globals.get_llm_cache()"
-            ),
-        )
-
         return _llm_cache
     msg = f"Could not find: {name}"
     raise AttributeError(msg)
-
-
-__all__ = [
-    "FAISS",
-    "Anthropic",
-    "ArxivAPIWrapper",
-    "Banana",
-    "BasePromptTemplate",
-    "CerebriumAI",
-    "Cohere",
-    "ConversationChain",
-    "ElasticVectorSearch",
-    "FewShotPromptTemplate",
-    "ForefrontAI",
-    "GoldenQueryAPIWrapper",
-    "GoogleSearchAPIWrapper",
-    "GoogleSerperAPIWrapper",
-    "GooseAI",
-    "HuggingFaceHub",
-    "HuggingFacePipeline",
-    "HuggingFaceTextGenInference",
-    "InMemoryDocstore",
-    "LLMChain",
-    "LLMCheckerChain",
-    "LLMMathChain",
-    "LlamaCpp",
-    "MRKLChain",
-    "Modal",
-    "OpenAI",
-    "Petals",
-    "PipelineAI",
-    "PowerBIDataset",
-    "Prompt",
-    "PromptTemplate",
-    "QAWithSourcesChain",
-    "ReActChain",
-    "SQLDatabase",
-    "SagemakerEndpoint",
-    "SearxSearchWrapper",
-    "SelfAskWithSearchChain",
-    "SerpAPIChain",
-    "SerpAPIWrapper",
-    "StochasticAI",
-    "VectorDBQA",
-    "VectorDBQAWithSourcesChain",
-    "Wikipedia",
-    "WikipediaAPIWrapper",
-    "WolframAlphaAPIWrapper",
-    "Writer",
-]

langchain/_internal/_documents.py

@@ -0,0 +1,35 @@
+"""Internal document utilities."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from langchain_core.documents import Document
+
+
+def format_document_xml(doc: Document) -> str:
+    """Format a document as XML-like structure for LLM consumption.
+
+    Args:
+        doc: Document to format
+
+    Returns:
+        Document wrapped in XML tags:
+            <document>
+                <id>...</id>
+                <content>...</content>
+                <metadata>...</metadata>
+            </document>
+
+    .. note::
+        Does not generate valid XML or escape special characters. Intended for
+        semi-structured LLM input only.
+
+    """
+    id_str = f"<id>{doc.id}</id>" if doc.id is not None else "<id></id>"
+    metadata_str = ""
+    if doc.metadata:
+        metadata_items = [f"{k}: {v!s}" for k, v in doc.metadata.items()]
+        metadata_str = f"<metadata>{', '.join(metadata_items)}</metadata>"
+    return f"<document>{id_str}<content>{doc.page_content}</content>{metadata_str}</document>"

langchain/_internal/_lazy_import.py

@@ -0,0 +1,36 @@
+"""Lazy import utilities."""
+
+from importlib import import_module
+from typing import Union
+
+
+def import_attr(
+    attr_name: str,
+    module_name: Union[str, None],
+    package: Union[str, None],
+) -> object:
+    """Import an attribute from a module located in a package.
+
+    This utility function is used in custom __getattr__ methods within __init__.py
+    files to dynamically import attributes.
+
+    Args:
+        attr_name: The name of the attribute to import.
+        module_name: The name of the module to import from. If None, the attribute
+            is imported from the package itself.
+        package: The name of the package where the module is located.
+    """
+    if module_name == "__module__" or module_name is None:
+        try:
+            result = import_module(f".{attr_name}", package=package)
+        except ModuleNotFoundError:
+            msg = f"module '{package!r}' has no attribute {attr_name!r}"
+            raise AttributeError(msg) from None
+    else:
+        try:
+            module = import_module(f".{module_name}", package=package)
+        except ModuleNotFoundError as err:
+            msg = f"module '{package!r}.{module_name!r}' not found ({err})"
+            raise ImportError(msg) from None
+        result = getattr(module, attr_name)
+    return result

langchain/_internal/_prompts.py

@@ -0,0 +1,165 @@
+"""Internal prompt resolution utilities.
+
+This module provides utilities for resolving different types of prompt specifications
+into standardized message formats for language models. It supports both synchronous
+and asynchronous prompt resolution with automatic detection of callable types.
+
+The module is designed to handle common prompt patterns across LangChain components,
+particularly for summarization chains and other document processing workflows.
+
+"""
+
+from __future__ import annotations
+
+import inspect
+from typing import TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    from collections.abc import Awaitable, Callable
+
+    from langchain_core.messages import MessageLikeRepresentation
+    from langgraph.runtime import Runtime
+
+    from langchain._internal._typing import ContextT, StateT
+
+
+def resolve_prompt(
+    prompt: Union[
+        str,
+        None,
+        Callable[[StateT, Runtime[ContextT]], list[MessageLikeRepresentation]],
+    ],
+    state: StateT,
+    runtime: Runtime[ContextT],
+    default_user_content: str,
+    default_system_content: str,
+) -> list[MessageLikeRepresentation]:
+    """Resolve a prompt specification into a list of messages.
+
+    Handles prompt resolution across different strategies. Supports callable functions,
+    string system messages, and None for default behavior.
+
+    Args:
+        prompt: The prompt specification to resolve. Can be:
+            - Callable: Function taking (state, runtime) returning message list.
+            - str: A system message string.
+            - None: Use the provided default system message.
+        state: Current state, passed to callable prompts.
+        runtime: LangGraph runtime instance, passed to callable prompts.
+        default_user_content: User content to include (e.g., document text).
+        default_system_content: Default system message when prompt is None.
+
+    Returns:
+        List of message dictionaries for language models, typically containing
+        a system message and user message with content.
+
+    Raises:
+        TypeError: If prompt type is not str, None, or callable.
+
+    Example:
+        ```python
+        def custom_prompt(state, runtime):
+            return [{"role": "system", "content": "Custom"}]
+
+        messages = resolve_prompt(custom_prompt, state, runtime, "content", "default")
+        messages = resolve_prompt("Custom system", state, runtime, "content", "default")
+        messages = resolve_prompt(None, state, runtime, "content", "Default")
+        ```
+
+    .. note::
+        Callable prompts have full control over message structure and content parameter
+        is ignored. String/None prompts create standard system + user structure.
+
+    """
+    if callable(prompt):
+        return prompt(state, runtime)
+    if isinstance(prompt, str):
+        system_msg = prompt
+    elif prompt is None:
+        system_msg = default_system_content
+    else:
+        msg = f"Invalid prompt type: {type(prompt)}. Expected str, None, or callable."
+        raise TypeError(msg)
+
+    return [
+        {"role": "system", "content": system_msg},
+        {"role": "user", "content": default_user_content},
+    ]
+
+
+async def aresolve_prompt(
+    prompt: Union[
+        str,
+        None,
+        Callable[[StateT, Runtime[ContextT]], list[MessageLikeRepresentation]],
+        Callable[[StateT, Runtime[ContextT]], Awaitable[list[MessageLikeRepresentation]]],
+    ],
+    state: StateT,
+    runtime: Runtime[ContextT],
+    default_user_content: str,
+    default_system_content: str,
+) -> list[MessageLikeRepresentation]:
+    """Async version of resolve_prompt supporting both sync and async callables.
+
+    Handles prompt resolution across different strategies. Supports sync/async callable
+    functions, string system messages, and None for default behavior.
+
+    Args:
+        prompt: The prompt specification to resolve. Can be:
+            - Callable (sync): Function taking (state, runtime) returning message list.
+            - Callable (async): Async function taking (state, runtime) returning
+              awaitable message list.
+            - str: A system message string.
+            - None: Use the provided default system message.
+        state: Current state, passed to callable prompts.
+        runtime: LangGraph runtime instance, passed to callable prompts.
+        default_user_content: User content to include (e.g., document text).
+        default_system_content: Default system message when prompt is None.
+
+    Returns:
+        List of message dictionaries for language models, typically containing
+        a system message and user message with content.
+
+    Raises:
+        TypeError: If prompt type is not str, None, or callable.
+
+    Example:
+        ```python
+        async def async_prompt(state, runtime):
+            return [{"role": "system", "content": "Async"}]
+
+        def sync_prompt(state, runtime):
+            return [{"role": "system", "content": "Sync"}]
+
+        messages = await aresolve_prompt(
+            async_prompt, state, runtime, "content", "default"
+        )
+        messages = await aresolve_prompt(
+            sync_prompt, state, runtime, "content", "default"
+        )
+        messages = await aresolve_prompt("Custom", state, runtime, "content", "default")
+        ```
+
+    .. note::
+        Callable prompts have full control over message structure and content parameter
+        is ignored. Automatically detects and handles async callables.
+
+    """
+    if callable(prompt):
+        result = prompt(state, runtime)
+        # Check if the result is awaitable (async function)
+        if inspect.isawaitable(result):
+            return await result
+        return result
+    if isinstance(prompt, str):
+        system_msg = prompt
+    elif prompt is None:
+        system_msg = default_system_content
+    else:
+        msg = f"Invalid prompt type: {type(prompt)}. Expected str, None, or callable."
+        raise TypeError(msg)
+
+    return [
+        {"role": "system", "content": system_msg},
+        {"role": "user", "content": default_user_content},
+    ]