langchain-core 0.4.0.dev0__py3-none-any.whl → 1.0.0__py3-none-any.whl

langchain_core/load/dump.py

@@ -6,6 +6,8 @@ from typing import Any
 from pydantic import BaseModel
 
 from langchain_core.load.serializable import Serializable, to_json_not_implemented
+from langchain_core.messages import AIMessage
+from langchain_core.outputs import ChatGeneration
 
 
 def default(obj: Any) -> Any:
@@ -23,9 +25,6 @@ def default(obj: Any) -> Any:
 
 
 def _dump_pydantic_models(obj: Any) -> Any:
-    from langchain_core.messages import AIMessage
-    from langchain_core.outputs import ChatGeneration
-
     if (
         isinstance(obj, ChatGeneration)
         and isinstance(obj.message, AIMessage)
@@ -43,10 +42,9 @@ def dumps(obj: Any, *, pretty: bool = False, **kwargs: Any) -> str:
 
     Args:
         obj: The object to dump.
-        pretty: Whether to pretty print the json. If true, the json will be
-            indented with 2 spaces (if no indent is provided as part of kwargs).
-            Default is False.
-        kwargs: Additional arguments to pass to json.dumps
+        pretty: Whether to pretty print the json. If `True`, the json will be
+            indented with 2 spaces (if no indent is provided as part of `kwargs`).
+        **kwargs: Additional arguments to pass to `json.dumps`
 
     Returns:
         A json string representation of the object.
@@ -73,10 +71,9 @@ def dumps(obj: Any, *, pretty: bool = False, **kwargs: Any) -> str:
 def dumpd(obj: Any) -> Any:
     """Return a dict representation of an object.
 
-    Note:
-        Unfortunately this function is not as efficient as it could be
-        because it first dumps the object to a json string and then loads it
-        back into a dictionary.
+    !!! note
+        Unfortunately this function is not as efficient as it could be because it first
+        dumps the object to a json string and then loads it back into a dictionary.
 
     Args:
         obj: The object to dump.

langchain_core/load/load.py

@@ -3,7 +3,7 @@
 import importlib
 import json
 import os
-from typing import Any, Optional
+from typing import Any
 
 from langchain_core._api import beta
 from langchain_core.load.mapping import (
@@ -50,12 +50,11 @@ class Reviver:
 
     def __init__(
         self,
-        secrets_map: Optional[dict[str, str]] = None,
-        valid_namespaces: Optional[list[str]] = None,
+        secrets_map: dict[str, str] | None = None,
+        valid_namespaces: list[str] | None = None,
         secrets_from_env: bool = True,  # noqa: FBT001,FBT002
-        additional_import_mappings: Optional[
-            dict[tuple[str, ...], tuple[str, ...]]
-        ] = None,
+        additional_import_mappings: dict[tuple[str, ...], tuple[str, ...]]
+        | None = None,
         *,
         ignore_unserializable_fields: bool = False,
     ) -> None:
@@ -64,16 +63,13 @@ class Reviver:
         Args:
             secrets_map: A map of secrets to load. If a secret is not found in
                 the map, it will be loaded from the environment if `secrets_from_env`
-                is True. Defaults to None.
+                is True.
             valid_namespaces: A list of additional namespaces (modules)
-                to allow to be deserialized. Defaults to None.
+                to allow to be deserialized.
             secrets_from_env: Whether to load secrets from the environment.
-                Defaults to True.
             additional_import_mappings: A dictionary of additional namespace mappings
                 You can use this to override default mappings or add new mappings.
-                Defaults to None.
             ignore_unserializable_fields: Whether to ignore unserializable fields.
-                Defaults to False.
         """
         self.secrets_from_env = secrets_from_env
         self.secrets_map = secrets_map or {}
@@ -95,7 +91,21 @@ class Reviver:
         self.ignore_unserializable_fields = ignore_unserializable_fields
 
     def __call__(self, value: dict[str, Any]) -> Any:
-        """Revive the value."""
+        """Revive the value.
+
+        Args:
+            value: The value to revive.
+
+        Returns:
+            The revived value.
+
+        Raises:
+            ValueError: If the namespace is invalid.
+            ValueError: If trying to deserialize something that cannot
+                be deserialized in the current version of langchain-core.
+            NotImplementedError: If the object is not implemented and
+                `ignore_unserializable_fields` is False.
+        """
         if (
             value.get("lc") == 1
             and value.get("type") == "secret"
@@ -173,10 +183,10 @@ class Reviver:
 def loads(
     text: str,
     *,
-    secrets_map: Optional[dict[str, str]] = None,
-    valid_namespaces: Optional[list[str]] = None,
+    secrets_map: dict[str, str] | None = None,
+    valid_namespaces: list[str] | None = None,
     secrets_from_env: bool = True,
-    additional_import_mappings: Optional[dict[tuple[str, ...], tuple[str, ...]]] = None,
+    additional_import_mappings: dict[tuple[str, ...], tuple[str, ...]] | None = None,
     ignore_unserializable_fields: bool = False,
 ) -> Any:
     """Revive a LangChain class from a JSON string.
@@ -187,16 +197,13 @@ def loads(
         text: The string to load.
         secrets_map: A map of secrets to load. If a secret is not found in
             the map, it will be loaded from the environment if `secrets_from_env`
-            is True. Defaults to None.
+            is True.
         valid_namespaces: A list of additional namespaces (modules)
-            to allow to be deserialized. Defaults to None.
+            to allow to be deserialized.
         secrets_from_env: Whether to load secrets from the environment.
-            Defaults to True.
         additional_import_mappings: A dictionary of additional namespace mappings
             You can use this to override default mappings or add new mappings.
-            Defaults to None.
         ignore_unserializable_fields: Whether to ignore unserializable fields.
-            Defaults to False.
 
     Returns:
         Revived LangChain objects.
@@ -217,10 +224,10 @@ def loads(
 def load(
     obj: Any,
     *,
-    secrets_map: Optional[dict[str, str]] = None,
-    valid_namespaces: Optional[list[str]] = None,
+    secrets_map: dict[str, str] | None = None,
+    valid_namespaces: list[str] | None = None,
     secrets_from_env: bool = True,
-    additional_import_mappings: Optional[dict[tuple[str, ...], tuple[str, ...]]] = None,
+    additional_import_mappings: dict[tuple[str, ...], tuple[str, ...]] | None = None,
     ignore_unserializable_fields: bool = False,
 ) -> Any:
     """Revive a LangChain class from a JSON object.
@@ -232,16 +239,13 @@ def load(
         obj: The object to load.
         secrets_map: A map of secrets to load. If a secret is not found in
             the map, it will be loaded from the environment if `secrets_from_env`
-            is True. Defaults to None.
+            is True.
         valid_namespaces: A list of additional namespaces (modules)
-            to allow to be deserialized. Defaults to None.
+            to allow to be deserialized.
         secrets_from_env: Whether to load secrets from the environment.
-            Defaults to True.
         additional_import_mappings: A dictionary of additional namespace mappings
             You can use this to override default mappings or add new mappings.
-            Defaults to None.
         ignore_unserializable_fields: Whether to ignore unserializable fields.
-            Defaults to False.
 
     Returns:
         Revived LangChain objects.

langchain_core/load/mapping.py

@@ -413,11 +413,10 @@ SERIALIZABLE_MAPPING: dict[tuple[str, ...], tuple[str, ...]] = {
         "few_shot_with_templates",
         "FewShotPromptWithTemplates",
     ),
-    ("langchain", "prompts", "pipeline", "PipelinePromptTemplate"): (
+    ("langchain", "prompts", "pipeline"): (
         "langchain_core",
         "prompts",
         "pipeline",
-        "PipelinePromptTemplate",
     ),
     ("langchain", "prompts", "base", "StringPromptTemplate"): (
         "langchain_core",
@@ -846,11 +845,10 @@ OLD_CORE_NAMESPACES_MAPPING: dict[tuple[str, ...], tuple[str, ...]] = {
         "few_shot_with_templates",
         "FewShotPromptWithTemplates",
     ),
-    ("langchain_core", "prompts", "pipeline", "PipelinePromptTemplate"): (
+    ("langchain_core", "prompts", "pipeline"): (
         "langchain_core",
         "prompts",
         "pipeline",
-        "PipelinePromptTemplate",
     ),
     ("langchain_core", "prompts", "string", "StringPromptTemplate"): (
         "langchain_core",

langchain_core/load/serializable.py

@@ -6,9 +6,7 @@ from abc import ABC
 from typing import (
     Any,
     Literal,
-    Optional,
     TypedDict,
-    Union,
     cast,
 )
 
@@ -20,53 +18,41 @@ logger = logging.getLogger(__name__)
 
 
 class BaseSerialized(TypedDict):
-    """Base class for serialized objects.
-
-    Parameters:
-        lc: The version of the serialization format.
-        id: The unique identifier of the object.
-        name: The name of the object. Optional.
-        graph: The graph of the object. Optional.
-    """
+    """Base class for serialized objects."""
 
     lc: int
+    """The version of the serialization format."""
     id: list[str]
+    """The unique identifier of the object."""
     name: NotRequired[str]
+    """The name of the object."""
     graph: NotRequired[dict[str, Any]]
+    """The graph of the object."""
 
 
 class SerializedConstructor(BaseSerialized):
-    """Serialized constructor.
-
-    Parameters:
-        type: The type of the object. Must be "constructor".
-        kwargs: The constructor arguments.
-    """
+    """Serialized constructor."""
 
     type: Literal["constructor"]
+    """The type of the object. Must be `'constructor'`."""
     kwargs: dict[str, Any]
+    """The constructor arguments."""
 
 
 class SerializedSecret(BaseSerialized):
-    """Serialized secret.
-
-    Parameters:
-        type: The type of the object. Must be "secret".
-    """
+    """Serialized secret."""
 
     type: Literal["secret"]
+    """The type of the object. Must be `'secret'`."""
 
 
 class SerializedNotImplemented(BaseSerialized):
-    """Serialized not implemented.
-
-    Parameters:
-        type: The type of the object. Must be "not_implemented".
-        repr: The representation of the object. Optional.
-    """
+    """Serialized not implemented."""
 
     type: Literal["not_implemented"]
-    repr: Optional[str]
+    """The type of the object. Must be `'not_implemented'`."""
+    repr: str | None
+    """The representation of the object."""
 
 
 def try_neq_default(value: Any, key: str, model: BaseModel) -> bool:
@@ -75,13 +61,10 @@ def try_neq_default(value: Any, key: str, model: BaseModel) -> bool:
     Args:
         value: The value.
         key: The key.
-        model: The pydantic model.
+        model: The Pydantic model.
 
     Returns:
         Whether the value is different from the default.
-
-    Raises:
-        Exception: If the key is not in the model.
     """
     field = type(model).model_fields[key]
     return _try_neq_default(value, field)
@@ -110,15 +93,15 @@ class Serializable(BaseModel, ABC):
     It relies on the following methods and properties:
 
     - `is_lc_serializable`: Is this class serializable?
-        By design, even if a class inherits from Serializable, it is not serializable by
-        default. This is to prevent accidental serialization of objects that should not
-        be serialized.
-    - `get_lc_namespace`: Get the namespace of the langchain object.
+        By design, even if a class inherits from `Serializable`, it is not serializable
+        by default. This is to prevent accidental serialization of objects that should
+        not be serialized.
+    - `get_lc_namespace`: Get the namespace of the LangChain object.
         During deserialization, this namespace is used to identify
         the correct class to instantiate.
         Please see the `Reviver` class in `langchain_core.load.load` for more details.
-        During deserialization an additional mapping is handle
-        classes that have moved or been renamed across package versions.
+        During deserialization an additional mapping is handle classes that have moved
+        or been renamed across package versions.
     - `lc_secrets`: A map of constructor argument names to secret ids.
     - `lc_attributes`: List of additional attribute names that should be included
         as part of the serialized representation.
@@ -126,28 +109,31 @@ class Serializable(BaseModel, ABC):
 
     # Remove default BaseModel init docstring.
     def __init__(self, *args: Any, **kwargs: Any) -> None:
-        """"""  # noqa: D419
+        """"""  # noqa: D419  # Intentional blank docstring
         super().__init__(*args, **kwargs)
 
     @classmethod
     def is_lc_serializable(cls) -> bool:
         """Is this class serializable?
 
-        By design, even if a class inherits from Serializable, it is not serializable by
-        default. This is to prevent accidental serialization of objects that should not
-        be serialized.
+        By design, even if a class inherits from `Serializable`, it is not serializable
+        by default. This is to prevent accidental serialization of objects that should
+        not be serialized.
 
         Returns:
-            Whether the class is serializable. Default is False.
+            Whether the class is serializable. Default is `False`.
         """
         return False
 
     @classmethod
     def get_lc_namespace(cls) -> list[str]:
-        """Get the namespace of the langchain object.
+        """Get the namespace of the LangChain object.
 
         For example, if the class is `langchain.llms.openai.OpenAI`, then the
-        namespace is ["langchain", "llms", "openai"]
+        namespace is `["langchain", "llms", "openai"]`
+
+        Returns:
+            The namespace.
         """
         return cls.__module__.split(".")
 
@@ -155,8 +141,7 @@ class Serializable(BaseModel, ABC):
     def lc_secrets(self) -> dict[str, str]:
         """A map of constructor argument names to secret ids.
 
-        For example,
-            {"openai_api_key": "OPENAI_API_KEY"}
+        For example, `{"openai_api_key": "OPENAI_API_KEY"}`
         """
         return {}
 
@@ -165,18 +150,20 @@ class Serializable(BaseModel, ABC):
         """List of attribute names that should be included in the serialized kwargs.
 
         These attributes must be accepted by the constructor.
+
         Default is an empty dictionary.
         """
         return {}
 
     @classmethod
     def lc_id(cls) -> list[str]:
-        """A unique identifier for this class for serialization purposes.
+        """Return a unique identifier for this class for serialization purposes.
 
         The unique identifier is a list of strings that describes the path
         to the object.
+
         For example, for the class `langchain.llms.openai.OpenAI`, the id is
-        ["langchain", "llms", "openai", "OpenAI"].
+        `["langchain", "llms", "openai", "OpenAI"]`.
         """
         # Pydantic generics change the class name. So we need to do the following
         if (
@@ -200,11 +187,14 @@ class Serializable(BaseModel, ABC):
             if (k not in type(self).model_fields or try_neq_default(v, k, self))
         ]
 
-    def to_json(self) -> Union[SerializedConstructor, SerializedNotImplemented]:
+    def to_json(self) -> SerializedConstructor | SerializedNotImplemented:
         """Serialize the object to JSON.
 
+        Raises:
+            ValueError: If the class has deprecated attributes.
+
         Returns:
-            A json serializable object or a SerializedNotImplemented object.
+            A json serializable object or a `SerializedNotImplemented` object.
         """
         if not self.is_lc_serializable():
             return self.to_json_not_implemented()
@@ -276,7 +266,11 @@ class Serializable(BaseModel, ABC):
         }
 
     def to_json_not_implemented(self) -> SerializedNotImplemented:
-        """Serialize a "not implemented" object."""
+        """Serialize a "not implemented" object.
+
+        Returns:
+            `SerializedNotImplemented`.
+        """
         return to_json_not_implemented(self)
 
 
@@ -290,8 +284,8 @@ def _is_field_useful(inst: Serializable, key: str, value: Any) -> bool:
 
     Returns:
         Whether the field is useful. If the field is required, it is useful.
-        If the field is not required, it is useful if the value is not None.
-        If the field is not required and the value is None, it is useful if the
+        If the field is not required, it is useful if the value is not `None`.
+        If the field is not required and the value is `None`, it is useful if the
         default value is different from the value.
     """
     field = type(inst).model_fields.get(key)
@@ -350,10 +344,10 @@ def to_json_not_implemented(obj: object) -> SerializedNotImplemented:
     """Serialize a "not implemented" object.
 
     Args:
-        obj: object to serialize.
+        obj: Object to serialize.
 
     Returns:
-        SerializedNotImplemented
+        `SerializedNotImplemented`
     """
     id_: list[str] = []
     try:

langchain_core/messages/__init__.py

@@ -1,23 +1,9 @@
-"""**Messages** are objects used in prompts and chat conversations.
-
-**Class hierarchy:**
-
-.. code-block::
-
-    BaseMessage --> SystemMessage, AIMessage, HumanMessage, ChatMessage, FunctionMessage, ToolMessage
-                --> BaseMessageChunk --> SystemMessageChunk, AIMessageChunk, HumanMessageChunk, ChatMessageChunk, FunctionMessageChunk, ToolMessageChunk
-
-**Main helpers:**
-
-.. code-block::
-
-    ChatPromptTemplate
-
-"""  # noqa: E501
+"""**Messages** are objects used in prompts and chat conversations."""
 
 from typing import TYPE_CHECKING
 
 from langchain_core._import_utils import import_attr
+from langchain_core.utils.utils import LC_AUTO_PREFIX, LC_ID_PREFIX, ensure_id
 
 if TYPE_CHECKING:
     from langchain_core.messages.ai import (
@@ -31,28 +17,29 @@ if TYPE_CHECKING:
         message_to_dict,
         messages_to_dict,
     )
+    from langchain_core.messages.block_translators.openai import (
+        convert_to_openai_data_block,
+        convert_to_openai_image_block,
+    )
     from langchain_core.messages.chat import ChatMessage, ChatMessageChunk
-    from langchain_core.messages.content_blocks import (
+    from langchain_core.messages.content import (
         Annotation,
         AudioContentBlock,
         Citation,
-        CodeInterpreterCall,
-        CodeInterpreterOutput,
-        CodeInterpreterResult,
         ContentBlock,
         DataContentBlock,
         FileContentBlock,
         ImageContentBlock,
+        InvalidToolCall,
         NonStandardAnnotation,
         NonStandardContentBlock,
         PlainTextContentBlock,
         ReasoningContentBlock,
+        ServerToolCall,
+        ServerToolCallChunk,
+        ServerToolResult,
         TextContentBlock,
         VideoContentBlock,
-        WebSearchCall,
-        WebSearchResult,
-        convert_to_openai_data_block,
-        convert_to_openai_image_block,
         is_data_content_block,
     )
     from langchain_core.messages.function import FunctionMessage, FunctionMessageChunk
@@ -60,7 +47,6 @@ if TYPE_CHECKING:
     from langchain_core.messages.modifier import RemoveMessage
     from langchain_core.messages.system import SystemMessage, SystemMessageChunk
     from langchain_core.messages.tool import (
-        InvalidToolCall,
         ToolCall,
         ToolCallChunk,
         ToolMessage,
@@ -81,6 +67,8 @@ if TYPE_CHECKING:
     )
 
 __all__ = (
+    "LC_AUTO_PREFIX",
+    "LC_ID_PREFIX",
     "AIMessage",
     "AIMessageChunk",
     "Annotation",
@@ -91,9 +79,6 @@ __all__ = (
     "ChatMessage",
     "ChatMessageChunk",
     "Citation",
-    "CodeInterpreterCall",
-    "CodeInterpreterOutput",
-    "CodeInterpreterResult",
     "ContentBlock",
     "DataContentBlock",
     "FileContentBlock",
@@ -109,6 +94,9 @@ __all__ = (
     "PlainTextContentBlock",
     "ReasoningContentBlock",
     "RemoveMessage",
+    "ServerToolCall",
+    "ServerToolCallChunk",
+    "ServerToolResult",
     "SystemMessage",
     "SystemMessageChunk",
     "TextContentBlock",
@@ -117,13 +105,12 @@ __all__ = (
     "ToolMessage",
     "ToolMessageChunk",
     "VideoContentBlock",
-    "WebSearchCall",
-    "WebSearchResult",
     "_message_from_dict",
     "convert_to_messages",
     "convert_to_openai_data_block",
     "convert_to_openai_image_block",
     "convert_to_openai_messages",
+    "ensure_id",
     "filter_messages",
     "get_buffer_string",
     "is_data_content_block",
@@ -139,53 +126,51 @@ __all__ = (
 _dynamic_imports = {
     "AIMessage": "ai",
     "AIMessageChunk": "ai",
-    "Annotation": "content_blocks",
-    "AudioContentBlock": "content_blocks",
+    "Annotation": "content",
+    "AudioContentBlock": "content",
     "BaseMessage": "base",
     "BaseMessageChunk": "base",
     "merge_content": "base",
     "message_to_dict": "base",
     "messages_to_dict": "base",
-    "Citation": "content_blocks",
-    "ContentBlock": "content_blocks",
+    "Citation": "content",
+    "ContentBlock": "content",
     "ChatMessage": "chat",
     "ChatMessageChunk": "chat",
-    "CodeInterpreterCall": "content_blocks",
-    "CodeInterpreterOutput": "content_blocks",
-    "CodeInterpreterResult": "content_blocks",
-    "DataContentBlock": "content_blocks",
-    "FileContentBlock": "content_blocks",
+    "DataContentBlock": "content",
+    "FileContentBlock": "content",
     "FunctionMessage": "function",
     "FunctionMessageChunk": "function",
     "HumanMessage": "human",
     "HumanMessageChunk": "human",
-    "NonStandardAnnotation": "content_blocks",
-    "NonStandardContentBlock": "content_blocks",
-    "PlainTextContentBlock": "content_blocks",
-    "ReasoningContentBlock": "content_blocks",
+    "NonStandardAnnotation": "content",
+    "NonStandardContentBlock": "content",
+    "PlainTextContentBlock": "content",
+    "ReasoningContentBlock": "content",
     "RemoveMessage": "modifier",
+    "ServerToolCall": "content",
+    "ServerToolCallChunk": "content",
+    "ServerToolResult": "content",
     "SystemMessage": "system",
     "SystemMessageChunk": "system",
-    "WebSearchCall": "content_blocks",
-    "WebSearchResult": "content_blocks",
-    "ImageContentBlock": "content_blocks",
+    "ImageContentBlock": "content",
     "InvalidToolCall": "tool",
-    "TextContentBlock": "content_blocks",
+    "TextContentBlock": "content",
     "ToolCall": "tool",
     "ToolCallChunk": "tool",
     "ToolMessage": "tool",
     "ToolMessageChunk": "tool",
-    "VideoContentBlock": "content_blocks",
+    "VideoContentBlock": "content",
     "AnyMessage": "utils",
     "MessageLikeRepresentation": "utils",
     "_message_from_dict": "utils",
     "convert_to_messages": "utils",
-    "convert_to_openai_data_block": "content_blocks",
-    "convert_to_openai_image_block": "content_blocks",
+    "convert_to_openai_data_block": "block_translators.openai",
+    "convert_to_openai_image_block": "block_translators.openai",
     "convert_to_openai_messages": "utils",
     "filter_messages": "utils",
     "get_buffer_string": "utils",
-    "is_data_content_block": "content_blocks",
+    "is_data_content_block": "content",
     "merge_message_runs": "utils",
     "message_chunk_to_message": "utils",
     "messages_from_dict": "utils",