langchain-core 1.0.0a8__py3-none-any.whl → 1.0.0rc2__py3-none-any.whl

langchain_core/load/load.py

@@ -63,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 {}
@@ -107,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
@@ -200,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.
@@ -245,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/serializable.py

@@ -25,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."""
 
@@ -43,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'``."""
+    """The type of the object. Must be `'not_implemented'`."""
     repr: str | None
-    """The representation of the object. Optional."""
+    """The representation of the object."""
 
 
 def try_neq_default(value: Any, key: str, model: BaseModel) -> bool:
@@ -61,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.
@@ -92,19 +92,19 @@ 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.
@@ -116,24 +116,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(".")
 
@@ -141,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 {}
 
@@ -151,6 +150,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 {}
@@ -161,8 +161,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 (
@@ -193,7 +194,7 @@ class Serializable(BaseModel, ABC):
             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()
@@ -268,7 +269,7 @@ class Serializable(BaseModel, ABC):
         """Serialize a "not implemented" object.
 
         Returns:
-            SerializedNotImplemented.
+            `SerializedNotImplemented`.
         """
         return to_json_not_implemented(self)
 
@@ -283,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)
@@ -343,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,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