deprecate: mark dashscope.threads (Assistants API) as deprecated

Add DeprecationWarning to Threads, Messages, Runs, Steps classes.
Warns only when methods are actually called, not on import.

Users should migrate to the Responses API.
See https://help.aliyun.com/zh/model-studio/synchronous-call-api-reference for migration details.

Author: zhansheng.lzs

dashscope/threads/messages/messages.py

@@ -2,6 +2,7 @@
 # Copyright (c) Alibaba, Inc. and its affiliates.
 
 from typing import Dict, List, Optional
+import warnings
 
 from dashscope.client.base_api import (
     CreateMixin,
@@ -16,6 +17,12 @@
 
 
 class Messages(CreateMixin, ListObjectMixin, GetStatusMixin, UpdateMixin):
+    """
+    .. deprecated::
+        The Messages API (Assistants API) is deprecated and will be removed
+        in a future release. Please migrate to the Responses API.
+        See https://help.aliyun.com/zh/model-studio/ for migration details.
+    """
     SUB_PATH = "messages"  # useless
 
     @classmethod
@@ -73,6 +80,7 @@ def create(
         api_key: str = None,
         **kwargs,
     ) -> ThreadMessage:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """Create message of thread.
 
         Args:
@@ -149,6 +157,7 @@ def get(  # type: ignore[override]
         api_key: str = None,
         **kwargs,
     ) -> ThreadMessage:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """Get the `ThreadMessage`.
 
         Args:
@@ -185,6 +194,7 @@ def list(  # type: ignore[override]
         api_key: str = None,
         **kwargs,
     ) -> ThreadMessageList:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """List message of the thread.
 
         Args:

dashscope/threads/runs/runs.py

@@ -3,6 +3,7 @@
 
 import time
 from http import HTTPStatus
+import warnings
 from typing import Dict, List, Optional
 
 from dashscope.client.base_api import (
@@ -38,6 +39,12 @@ class Runs(
     GetStatusMixin,
     UpdateMixin,
 ):
+    """
+    .. deprecated::
+        The Runs API (Assistants API) is deprecated and will be removed
+        in a future release. Please migrate to the Responses API.
+        See https://help.aliyun.com/zh/model-studio/ for migration details.
+    """
     SUB_PATH = "RUNS"  # useless
 
     @classmethod
@@ -57,6 +64,7 @@ def create_thread_and_run(
         api_key: str = None,
         **kwargs,
     ) -> Run:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         if not assistant_id:
             raise InputRequired("assistant_id is required")
         data = {"assistant_id": assistant_id}
@@ -114,6 +122,7 @@ def create(  # pylint: disable=too-many-branches
         max_tokens: Optional[int] = None,
         **kwargs,
     ) -> Run:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """Create a run.
 
         Args:
@@ -293,6 +302,7 @@ def list(  # type: ignore[override]
         api_key: str = None,
         **kwargs,
     ) -> RunList:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """List `Run`.
 
         Args:
@@ -334,6 +344,7 @@ def retrieve(
         api_key: str = None,
         **kwargs,
     ) -> Run:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """Retrieve the `Run`.
 
         Args:
@@ -399,6 +410,7 @@ def submit_tool_outputs(
         api_key: str = None,
         **kwargs,
     ) -> Run:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """_summary_
 
         Args:
@@ -557,6 +569,7 @@ def cancel(  # type: ignore[override]
         api_key: str = None,
         **kwargs,
     ) -> Run:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """Cancel the `Run`.
 
         Args:

dashscope/threads/runs/steps.py

@@ -2,13 +2,20 @@
 # Copyright (c) Alibaba, Inc. and its affiliates.
 
 from dashscope.client.base_api import GetStatusMixin, ListObjectMixin
+import warnings
 from dashscope.common.error import InputRequired
 from dashscope.threads.thread_types import RunStep, RunStepList
 
 __all__ = ["Steps"]
 
 
 class Steps(ListObjectMixin, GetStatusMixin):
+    """
+    .. deprecated::
+        The Steps API (Assistants API) is deprecated and will be removed
+        in a future release. Please migrate to the Responses API.
+        See https://help.aliyun.com/zh/model-studio/ for migration details.
+    """
     SUB_PATH = "RUNS"  # useless
 
     @classmethod
@@ -25,6 +32,7 @@ def list(  # type: ignore[override]
         api_key: str = None,
         **kwargs,
     ) -> RunStepList:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """List  `RunStep` of `Run`.
 
         Args:
@@ -68,6 +76,7 @@ def retrieve(
         api_key: str = None,
         **kwargs,
     ) -> RunStep:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """Retrieve the `RunStep`.
 
         Args:

dashscope/threads/threads.py

@@ -2,6 +2,7 @@
 # Copyright (c) Alibaba, Inc. and its affiliates.
 
 from typing import Dict, List, Optional
+import warnings
 
 from dashscope.assistants.assistant_types import DeleteResponse
 from dashscope.client.base_api import (
@@ -17,6 +18,12 @@
 
 
 class Threads(CreateMixin, DeleteMixin, GetStatusMixin, UpdateMixin):
+    """
+    .. deprecated::
+        The Threads API is deprecated and will be removed in a future release.
+        Please migrate to the Responses API.
+        See https://help.aliyun.com/zh/model-studio/ for migration details.
+    """
     SUB_PATH = "threads"
 
     @classmethod
@@ -62,6 +69,7 @@ def create(
         api_key: str = None,
         **kwargs,
     ) -> Thread:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """Create a thread.
 
         Args:
@@ -127,6 +135,7 @@ def retrieve(
         api_key: str = None,
         **kwargs,
     ) -> Thread:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """Retrieve the thread.
 
         Args:
@@ -159,6 +168,7 @@ def update(  # type: ignore[override]
         api_key: str = None,
         **kwargs,
     ) -> Thread:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """Update thread information.
 
         Args:
@@ -194,6 +204,7 @@ def delete(  # type: ignore[override]
         api_key: str = None,
         **kwargs,
     ) -> DeleteResponse:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         """Delete thread.
 
         Args:
@@ -231,6 +242,7 @@ def create_and_run(
         api_key: str = None,
         **kwargs,
     ) -> Run:
+        warnings.warn("The Assistants API (dashscope.threads) is deprecated and will be removed in a future release. Please migrate to the Responses API. See https://help.aliyun.com/zh/model-studio/ for migration details.", category=DeprecationWarning, stacklevel=2)
         if not assistant_id:
             raise InputRequired("assistant_id is required")
         data = {"assistant_id": assistant_id}