Deprecate dict and use asdict instead

Author: cbornet

libs/core/langchain_core/language_models/chat_models.py

@@ -628,7 +628,7 @@ def _get_invocation_params(
         stop: Optional[list[str]] = None,
         **kwargs: Any,
     ) -> dict:
-        params = self.model_dump()
+        params = self.asdict()
         params["stop"] = stop
         return {**params, **kwargs}
 
@@ -1300,8 +1300,12 @@ async def apredict_messages(
     def _llm_type(self) -> str:
         """Return type of chat model."""
 
+    @deprecated("0.3.61", alternative="asdict", removal="1.0")
     @override
-    def model_dump(self, **kwargs: Any) -> dict:
+    def dict(self, **kwargs: Any) -> dict:
+        return self.asdict()
+
+    def asdict(self) -> typing.Dict[str, Any]:  # noqa: UP006
         """Return a dictionary of the LLM."""
         starter_dict = dict(self._identifying_params)
         starter_dict["_type"] = self._llm_type

libs/core/langchain_core/language_models/llms.py

@@ -7,6 +7,7 @@
 import inspect
 import json
 import logging
+import typing
 import warnings
 from abc import ABC, abstractmethod
 from collections.abc import AsyncIterator, Iterator, Sequence
@@ -530,7 +531,7 @@ def stream(
         else:
             prompt = self._convert_input(input).to_string()
             config = ensure_config(config)
-            params = self.model_dump()
+            params = self.asdict()
             params["stop"] = stop
             params = {**params, **kwargs}
             options = {"stop": stop}
@@ -600,7 +601,7 @@ async def astream(
 
         prompt = self._convert_input(input).to_string()
         config = ensure_config(config)
-        params = self.model_dump()
+        params = self.asdict()
         params["stop"] = stop
         params = {**params, **kwargs}
         options = {"stop": stop}
@@ -943,7 +944,7 @@ def generate(
             ] * len(prompts)
             run_name_list = [cast("Optional[str]", run_name)] * len(prompts)
         run_ids_list = self._get_run_ids_list(run_id, prompts)
-        params = self.model_dump()
+        params = self.asdict()
         params["stop"] = stop
         options = {"stop": stop}
         (
@@ -1195,7 +1196,7 @@ async def agenerate(
             ] * len(prompts)
             run_name_list = [cast("Optional[str]", run_name)] * len(prompts)
         run_ids_list = self._get_run_ids_list(run_id, prompts)
-        params = self.model_dump()
+        params = self.asdict()
         params["stop"] = stop
         options = {"stop": stop}
         (
@@ -1401,8 +1402,12 @@ def __str__(self) -> str:
     def _llm_type(self) -> str:
         """Return type of llm."""
 
+    @deprecated("0.3.61", alternative="asdict", removal="1.0")
     @override
-    def model_dump(self, **kwargs: Any) -> dict:
+    def dict(self, **kwargs: Any) -> dict:
+        return self.asdict()
+
+    def asdict(self) -> typing.Dict[str, Any]:  # noqa: UP006
         """Return a dictionary of the LLM."""
         starter_dict = dict(self._identifying_params)
         starter_dict["_type"] = self._llm_type
@@ -1429,7 +1434,7 @@ def save(self, file_path: Union[Path, str]) -> None:
         directory_path.mkdir(parents=True, exist_ok=True)
 
         # Fetch dictionary to save
-        prompt_dict = self.model_dump()
+        prompt_dict = self.asdict()
 
         if save_path.suffix == ".json":
             with save_path.open("w") as f:

libs/core/langchain_core/output_parsers/base.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import contextlib
+import typing
 from abc import ABC, abstractmethod
 from typing import (
     TYPE_CHECKING,
@@ -15,6 +16,7 @@
 
 from typing_extensions import override
 
+from langchain_core._api import deprecated
 from langchain_core.language_models import LanguageModelOutput
 from langchain_core.messages import AnyMessage, BaseMessage
 from langchain_core.outputs import ChatGeneration, Generation
@@ -324,7 +326,12 @@ def _type(self) -> str:
         )
         raise NotImplementedError(msg)
 
-    def model_dump(self, **kwargs: Any) -> dict:
+    @deprecated("0.3.61", alternative="asdict", removal="1.0")
+    @override
+    def dict(self, **kwargs: Any) -> dict:
+        return self.asdict(**kwargs)
+
+    def asdict(self, **kwargs: Any) -> typing.Dict[str, Any]:  # noqa: UP006
         """Return dictionary representation of output parser."""
         output_parser_dict = super().model_dump(**kwargs)
         with contextlib.suppress(NotImplementedError):

libs/core/langchain_core/prompts/base.py

@@ -23,6 +23,7 @@
 from pydantic import BaseModel, ConfigDict, Field, model_validator
 from typing_extensions import Self, override
 
+from langchain_core._api import deprecated
 from langchain_core.exceptions import ErrorCode, create_message
 from langchain_core.load import dumpd
 from langchain_core.output_parsers.base import BaseOutputParser
@@ -331,7 +332,12 @@ def _prompt_type(self) -> str:
         """Return the prompt type key."""
         raise NotImplementedError
 
-    def model_dump(self, **kwargs: Any) -> dict:
+    @deprecated("0.3.61", alternative="asdict", removal="1.0")
+    @override
+    def dict(self, **kwargs: Any) -> dict:
+        return self.asdict(**kwargs)
+
+    def asdict(self, **kwargs: Any) -> typing.Dict[str, Any]:  # noqa: UP006
         """Return dictionary representation of prompt.
 
         Args:
@@ -369,7 +375,7 @@ def save(self, file_path: Union[Path, str]) -> None:
             raise ValueError(msg)
 
         # Fetch dictionary to save
-        prompt_dict = self.model_dump()
+        prompt_dict = self.asdict()
         if "_type" not in prompt_dict:
             msg = f"Prompt {self} does not support saving."
             raise NotImplementedError(msg)