langchain-core 1.0.0a5__py3-none-any.whl → 1.0.3__py3-none-any.whl

langchain_core/load/dump.py

@@ -17,7 +17,7 @@ def default(obj: Any) -> Any:
         obj: The object to serialize to json if it is a Serializable object.
 
     Returns:
-        A json serializable object or a SerializedNotImplemented object.
+        A JSON serializable object or a SerializedNotImplemented object.
     """
     if isinstance(obj, Serializable):
         return obj.to_json()
@@ -38,17 +38,16 @@ def _dump_pydantic_models(obj: Any) -> Any:
 
 
 def dumps(obj: Any, *, pretty: bool = False, **kwargs: Any) -> str:
-    """Return a json string representation of an object.
+    """Return a JSON string representation of an object.
 
     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.
+        A JSON string representation of the object.
 
     Raises:
         ValueError: If `default` is passed as a kwarg.
@@ -72,14 +71,12 @@ 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.
-
     Args:
         obj: The object to dump.
 
     Returns:
-        dictionary that can be serialized to json using json.dumps
+        Dictionary that can be serialized to json using `json.dumps`.
     """
+    # 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.
     return json.loads(dumps(obj))

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 {}
@@ -108,7 +104,7 @@ class Reviver:
             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.
+                `ignore_unserializable_fields` is False.
         """
         if (
             value.get("lc") == 1
@@ -187,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.
@@ -201,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.
@@ -231,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.
@@ -246,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,
 )
 
@@ -27,16 +25,16 @@ class BaseSerialized(TypedDict):
     id: list[str]
     """The unique identifier of the object."""
     name: NotRequired[str]
-    """The name of the object. Optional."""
+    """The name of the object."""
     graph: NotRequired[dict[str, Any]]
-    """The graph of the object. Optional."""
+    """The graph of the object."""
 
 
 class SerializedConstructor(BaseSerialized):
     """Serialized constructor."""
 
     type: Literal["constructor"]
-    """The type of the object. Must be ``'constructor'``."""
+    """The type of the object. Must be `'constructor'`."""
     kwargs: dict[str, Any]
     """The constructor arguments."""
 
@@ -45,16 +43,16 @@ class SerializedSecret(BaseSerialized):
     """Serialized secret."""
 
     type: Literal["secret"]
-    """The type of the object. Must be ``'secret'``."""
+    """The type of the object. Must be `'secret'`."""
 
 
 class SerializedNotImplemented(BaseSerialized):
     """Serialized not implemented."""
 
     type: Literal["not_implemented"]
-    """The type of the object. Must be ``'not_implemented'``."""
-    repr: Optional[str]
-    """The representation of the object. Optional."""
+    """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:
@@ -63,7 +61,7 @@ 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.
@@ -94,19 +92,22 @@ 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.
-      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.
-    - ``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.
+    - `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.
+
+        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.
+
+    - `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.
     """
 
     # Remove default BaseModel init docstring.
@@ -118,24 +119,24 @@ class Serializable(BaseModel, ABC):
     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 as a list of strings.
+            The namespace.
         """
         return cls.__module__.split(".")
 
@@ -143,8 +144,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 {}
 
@@ -153,6 +153,7 @@ 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 {}
@@ -163,8 +164,9 @@ class Serializable(BaseModel, ABC):
 
         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 (
@@ -188,14 +190,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()
@@ -270,7 +272,7 @@ class Serializable(BaseModel, ABC):
         """Serialize a "not implemented" object.
 
         Returns:
-            SerializedNotImplemented.
+            `SerializedNotImplemented`.
         """
         return to_json_not_implemented(self)
 
@@ -285,8 +287,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)
@@ -345,10 +347,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,19 +1,4 @@
-"""**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
 
@@ -24,6 +9,9 @@ if TYPE_CHECKING:
     from langchain_core.messages.ai import (
         AIMessage,
         AIMessageChunk,
+        InputTokenDetails,
+        OutputTokenDetails,
+        UsageMetadata,
     )
     from langchain_core.messages.base import (
         BaseMessage,
@@ -102,10 +90,12 @@ __all__ = (
     "HumanMessage",
     "HumanMessageChunk",
     "ImageContentBlock",
+    "InputTokenDetails",
     "InvalidToolCall",
     "MessageLikeRepresentation",
     "NonStandardAnnotation",
     "NonStandardContentBlock",
+    "OutputTokenDetails",
     "PlainTextContentBlock",
     "ReasoningContentBlock",
     "RemoveMessage",
@@ -119,6 +109,7 @@ __all__ = (
     "ToolCallChunk",
     "ToolMessage",
     "ToolMessageChunk",
+    "UsageMetadata",
     "VideoContentBlock",
     "_message_from_dict",
     "convert_to_messages",
@@ -160,6 +151,7 @@ _dynamic_imports = {
     "HumanMessageChunk": "human",
     "NonStandardAnnotation": "content",
     "NonStandardContentBlock": "content",
+    "OutputTokenDetails": "ai",
     "PlainTextContentBlock": "content",
     "ReasoningContentBlock": "content",
     "RemoveMessage": "modifier",
@@ -169,12 +161,14 @@ _dynamic_imports = {
     "SystemMessage": "system",
     "SystemMessageChunk": "system",
     "ImageContentBlock": "content",
+    "InputTokenDetails": "ai",
     "InvalidToolCall": "tool",
     "TextContentBlock": "content",
     "ToolCall": "tool",
     "ToolCallChunk": "tool",
     "ToolMessage": "tool",
     "ToolMessageChunk": "tool",
+    "UsageMetadata": "ai",
     "VideoContentBlock": "content",
     "AnyMessage": "utils",
     "MessageLikeRepresentation": "utils",