dashscope 1.24.2__py3-none-any.whl → 1.24.3__py3-none-any.whl

dashscope/client/base_api.py

@@ -1,5 +1,6 @@
 # Copyright (c) Alibaba, Inc. and its affiliates.
-
+import asyncio
+import collections
 import time
 from http import HTTPStatus
 from typing import Any, Dict, Iterator, List, Union
@@ -13,7 +14,7 @@ from dashscope.common.api_key import get_default_api_key
 from dashscope.common.constants import (DEFAULT_REQUEST_TIMEOUT_SECONDS,
                                         REPEATABLE_STATUS,
                                         REQUEST_TIMEOUT_KEYWORD,
-                                        SSE_CONTENT_TYPE, TaskStatus)
+                                        SSE_CONTENT_TYPE, TaskStatus, HTTPMethod)
 from dashscope.common.error import InvalidParameter, InvalidTask, ModelRequired
 from dashscope.common.logging import logger
 from dashscope.common.utils import (_handle_http_failed_response,
@@ -21,8 +22,299 @@ from dashscope.common.utils import (_handle_http_failed_response,
                                     _handle_http_stream_response,
                                     default_headers, join_url)
 
+class AsyncAioTaskGetMixin:
+    @classmethod
+    async def _get(cls,
+             task_id: str,
+             api_key: str = None,
+             workspace: str = None,
+             **kwargs) -> DashScopeAPIResponse:
+        base_url = kwargs.pop('base_address', None)
+        url = _normalization_url(base_url, 'tasks', task_id)
+        kwargs = cls._handle_kwargs(api_key, workspace, **kwargs)
+        kwargs["base_address"] = url
+        if not api_key:
+            api_key = get_default_api_key()
+        request = _build_api_request("", "", "",
+                                     "", "", api_key=api_key,
+                                     is_service=False, **kwargs)
+        return await cls._handle_request(request)
+
+    @classmethod
+    def _handle_kwargs(cls, api_key: str = None ,workspace: str = None, **kwargs):
+        custom_headers = kwargs.pop('headers', None)
+        headers = {
+            **_workspace_header(workspace),
+            **default_headers(api_key),
+        }
+        if custom_headers:
+            headers = {
+                **custom_headers,
+                **headers,
+            }
+        if workspace is not None:
+            headers = {
+                'X-DashScope-WorkSpace': workspace,
+                **kwargs.pop('headers', {})
+            }
+        kwargs['headers'] = headers
+        kwargs['http_method'] = HTTPMethod.GET
+        return kwargs
+
+    @classmethod
+    async def _handle_request(cls, request):
+        # 如果 aio_call 返回的是异步生成器，则需要从中获取响应
+        response = await request.aio_call()
+        # 处理异步生成器的情况
+        if isinstance(response, collections.abc.AsyncGenerator):
+            result = None
+            async for item in response:
+                result = item
+            return result
+        else:
+            return response
+
+class BaseAsyncAioApi(AsyncAioTaskGetMixin):
+    """BaseApi, internal use only.
+
+    """
+    @classmethod
+    def _validate_params(cls, api_key, model):
+        if api_key is None:
+            api_key = get_default_api_key()
+        if model is None or not model:
+            raise ModelRequired('Model is required!')
+        return api_key, model
+
+    @classmethod
+    async def async_call(cls,
+                   model: str,
+                   input: object,
+                   task_group: str,
+                   task: str = None,
+                   function: str = None,
+                   api_key: str = None,
+                   workspace: str = None,
+                   **kwargs) -> DashScopeAPIResponse:
+        api_key, model = cls._validate_params(api_key, model)
+        if workspace is not None:
+            headers = {
+                'X-DashScope-WorkSpace': workspace,
+                **kwargs.pop('headers', {})
+            }
+            kwargs['headers'] = headers
+        kwargs['async_request'] = True
+        request = _build_api_request(model=model,
+                                     input=input,
+                                     task_group=task_group,
+                                     task=task,
+                                     function=function,
+                                     api_key=api_key,
+                                     **kwargs)
+        # call request service.
+        return await request.aio_call()
+
+    @classmethod
+    async def call(cls,
+                  model: str,
+                  input: object,
+                  task_group: str,
+                  task: str = None,
+                  function: str = None,
+                  api_key: str = None,
+                  workspace: str = None,
+                  **kwargs) -> DashScopeAPIResponse:
+        # call request service.
+        response = await BaseAsyncAioApi.async_call(model, input, task_group, task,
+                                        function, api_key, workspace,
+                                        **kwargs)
+        response = await BaseAsyncAioApi.wait(response,
+                                  api_key=api_key,
+                                  workspace=workspace,
+                                  **kwargs)
+        return response
+
+
+    @classmethod
+    def _get_task_id(cls, task):
+        if isinstance(task, str):
+            task_id = task
+        elif isinstance(task, DashScopeAPIResponse):
+            if task.status_code == HTTPStatus.OK:
+                task_id = task.output['task_id']
+            else:
+                raise InvalidTask('Invalid task, task create failed: %s' %
+                                  task)
+        else:
+            raise InvalidParameter('Task invalid!')
+        if task_id is None or task_id == '':
+            raise InvalidParameter('Task id required!')
+        return task_id
+
+    @classmethod
+    async def wait(cls,
+             task: Union[str, DashScopeAPIResponse],
+             api_key: str = None,
+             workspace: str = None,
+             **kwargs) -> DashScopeAPIResponse:
+        """Wait for async task completion and return task result.
+
+        Args:
+            task (Union[str, DashScopeAPIResponse]): The task_id, or
+                async_call response.
+            api_key (str, optional): The api_key. Defaults to None.
+
+        Returns:
+            DashScopeAPIResponse: The async task information.
+        """
+        task_id = cls._get_task_id(task)
+        wait_seconds = 1
+        max_wait_seconds = 5
+        increment_steps = 3
+        step = 0
+        while True:
+            step += 1
+            # we start by querying once every second, and double
+            # the query interval after every 3(increment_steps)
+            # intervals, until we hit the max waiting interval
+            # of 5(seconds）
+            # (server side return immediately when ready)
+            if wait_seconds < max_wait_seconds and step % increment_steps == 0:
+                wait_seconds = min(wait_seconds * 2, max_wait_seconds)
+            rsp = await cls._get(task_id, api_key, workspace=workspace, **kwargs)
+            if rsp.status_code == HTTPStatus.OK:
+                if rsp.output is None:
+                    return rsp
+
+                task_status = rsp.output['task_status']
+                if task_status in [
+                        TaskStatus.FAILED, TaskStatus.CANCELED,
+                        TaskStatus.SUCCEEDED, TaskStatus.UNKNOWN
+                ]:
+                    return rsp
+                else:
+                    logger.info('The task %s is  %s' % (task_id, task_status))
+                    await asyncio.sleep(wait_seconds)  # 异步等待
+            elif rsp.status_code in REPEATABLE_STATUS:
+                logger.warn(
+                    ('Get task: %s temporary failure, \
+                        status_code: %s, code: %s message: %s, will try again.'
+                     ) % (task_id, rsp.status_code, rsp.code, rsp.message))
+                await asyncio.sleep(wait_seconds)  # 异步等待
+            else:
+                return rsp
+
+    @classmethod
+    async def cancel(
+        cls,
+        task: Union[str, DashScopeAPIResponse],
+        api_key: str = None,
+        workspace: str = None,
+        **kwargs,
+    ) -> DashScopeAPIResponse:
+        """Cancel PENDING task.
+
+        Args:
+            task (Union[str, DashScopeAPIResponse]): The task_id, or
+                async_call response.
+            api_key (str, optional): The api-key. Defaults to None.
+
+        Returns:
+            DashScopeAPIResponse: The cancel result.
+        """
+        task_id = cls._get_task_id(task)
+        base_url = kwargs.pop('base_address', None)
+        url = _normalization_url(base_url, 'tasks', task_id, 'cancel')
+        kwargs = cls._handle_kwargs(api_key, workspace, **kwargs)
+        kwargs["base_address"] = url
+        if not api_key:
+            api_key = get_default_api_key()
+        request = _build_api_request("", "", "",
+                                     "", "",api_key=api_key,
+                                     is_service=False, **kwargs)
+        return await cls._handle_request(request)
+
+    @classmethod
+    async def list(cls,
+             start_time: str = None,
+             end_time: str = None,
+             model_name: str = None,
+             api_key_id: str = None,
+             region: str = None,
+             status: str = None,
+             page_no: int = 1,
+             page_size: int = 10,
+             api_key: str = None,
+             workspace: str = None,
+             **kwargs) -> DashScopeAPIResponse:
+        """List async tasks.
+
+        Args:
+            start_time (str, optional): The tasks start time,
+                for example: 20230420000000. Defaults to None.
+            end_time (str, optional): The tasks end time,
+                for example: 20230420000000. Defaults to None.
+            model_name (str, optional): The tasks model name.
+                Defaults to None.
+            api_key_id (str, optional): The tasks api-key-id.
+                Defaults to None.
+            region (str, optional): The service region,
+                for example: cn-beijing. Defaults to None.
+            status (str, optional): The status of tasks[PENDING,
+                RUNNING, SUCCEEDED, FAILED, CANCELED]. Defaults to None.
+            page_no (int, optional): The page number. Defaults to 1.
+            page_size (int, optional): The page size. Defaults to 10.
+            api_key (str, optional): The user api-key. Defaults to None.
+
+        Returns:
+            DashScopeAPIResponse: The response data.
+        """
+        base_url = kwargs.pop('base_address', None)
+        url = _normalization_url(base_url, 'tasks')
+        params = {'page_no': page_no, 'page_size': page_size}
+        if start_time is not None:
+            params['start_time'] = start_time
+        if end_time is not None:
+            params['end_time'] = end_time
+        if model_name is not None:
+            params['model_name'] = model_name
+        if api_key_id is not None:
+            params['api_key_id'] = api_key_id
+        if region is not None:
+            params['region'] = region
+        if status is not None:
+            params['status'] = status
+        kwargs = cls._handle_kwargs(api_key, workspace, **kwargs)
+        kwargs["base_address"] = url
+        if not api_key:
+            api_key = get_default_api_key()
+        request = _build_api_request(model_name, "", "",
+                                     "", "", api_key=api_key,
+                                     is_service=False, extra_url_parameters=params,
+                                     **kwargs)
+        return await cls._handle_request(request)
+
+    @classmethod
+    async def fetch(cls,
+                    task: Union[str, DashScopeAPIResponse],
+                    api_key: str = None,
+                    workspace: str = None,
+                    **kwargs) -> DashScopeAPIResponse:
+        """Query async task status.
+
+        Args:
+            task (Union[str, DashScopeAPIResponse]): The task_id, or
+                async_call response.
+            api_key (str, optional): The api_key. Defaults to None.
+
+        Returns:
+            DashScopeAPIResponse: The async task information.
+        """
+        task_id = cls._get_task_id(task)
+        return await cls._get(task_id, api_key, workspace, **kwargs)
+
 
-class BaseAioApi():
+class BaseAioApi:
     """BaseApi, internal use only.
 
     """

dashscope/utils/oss_utils.py

@@ -188,6 +188,6 @@ def check_and_upload(model, elem: dict, api_key):
     return has_upload
 
 
-def preprocess_message_element(model: str, elem: List[dict], api_key: str):
+def preprocess_message_element(model: str, elem: dict, api_key: str):
     is_upload = check_and_upload(model, elem, api_key)
     return is_upload

dashscope/version.py

@@ -1,3 +1,3 @@
 # Copyright (c) Alibaba, Inc. and its affiliates.
 
-__version__ = '1.24.2'
+__version__ = '1.24.3'

{dashscope-1.24.2.dist-info → dashscope-1.24.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dashscope
-Version: 1.24.2
+Version: 1.24.3
 Summary: dashscope client sdk library
 Home-page: https://dashscope.aliyun.com/
 Author: Alibaba Cloud
@@ -23,6 +23,7 @@ Requires-Dist: aiohttp
 Requires-Dist: requests
 Requires-Dist: websocket-client
 Requires-Dist: cryptography
+Requires-Dist: certifi
 Provides-Extra: tokenizer
 Requires-Dist: tiktoken; extra == "tokenizer"
 Dynamic: author

{dashscope-1.24.2.dist-info → dashscope-1.24.3.dist-info}/RECORD

@@ -1,26 +1,26 @@
-dashscope/__init__.py,sha256=__BY0dzgFX5Bt50WL-2PJmI8EYOmnpXhABQntdqDtSM,3062
+dashscope/__init__.py,sha256=MJI4PJmnevfQA_GA30_L3hmsq49hooZpg25k6w39dts,3120
 dashscope/cli.py,sha256=64oGkevgX0RHPPmMg0sevXDgaFLQNA_0vdtjQ7Z2pHM,26492
 dashscope/files.py,sha256=vRDQygm3lOqBZR73o7KNHs1iTBVuvLncuwJNxIYjzAU,3981
 dashscope/model.py,sha256=B5v_BtYLPqj6raClejBgdKg6WTGwhH_f-20pvsQqmsk,1491
 dashscope/models.py,sha256=dE4mzXkl85G343qVylSGpURPRdA5pZSqXlx6PcxqC_Q,1275
-dashscope/version.py,sha256=tFrHRbI2SJLqcZ_I7s27rempXOnJ1PnfN0UpyIemTGE,74
-dashscope/aigc/__init__.py,sha256=AuRhu_vA1K0tbs_C6DgcZYhTvxMuzDgpwHJNHzEPIHg,442
+dashscope/version.py,sha256=V0YmAKw8G9I8NSRumZjDtPh52jnAd9OGCwh9X-oeC_M,74
+dashscope/aigc/__init__.py,sha256=m51CHEKL3WPq-s14OF-G1Uk3rLj6B6KrU55bbCKU-Ak,500
 dashscope/aigc/chat_completion.py,sha256=ONlyyssIbfaKKcFo7cEKhHx5OCF2XX810HFzIExW1ho,14813
 dashscope/aigc/code_generation.py,sha256=p_mxDKJLQMW0IjFD46JRlZuEZCRESSVKEfLlAevBtqw,10936
 dashscope/aigc/conversation.py,sha256=95xEEY4ThZJysj5zy3aMw7ql9KLJVfD_1iHv9QZ17Ew,14282
 dashscope/aigc/generation.py,sha256=xMcMu16rICTdjZiD_sPqYV_Ltdp4ewGzzfC7JD9VApY,17948
-dashscope/aigc/image_synthesis.py,sha256=Jgqmyv4jRxikgX7J18QrKKQ4OZAMxs6Q6YXObae3DhI,13363
-dashscope/aigc/multimodal_conversation.py,sha256=1rZZRk_1lCdbVs7Rx1kJ5LvwWE1put5p_dQKdCX0ysY,5574
-dashscope/aigc/video_synthesis.py,sha256=XQ3-NKYFmj5cIbUbLTbI0-FyC_fQp8eds6QmD1ZHj_0,13015
+dashscope/aigc/image_synthesis.py,sha256=Itx9h5brEwC-d3Mj_ntDHGd4qaitqDg9DeGHMJouhMk,28178
+dashscope/aigc/multimodal_conversation.py,sha256=Kjg8Gtfhl_Ok8WVwD-AeT-VBN9hh6E74TfkCxkL5wbY,10821
+dashscope/aigc/video_synthesis.py,sha256=RSPjar5-YiF9xclRmf9H7-5QbRxLcsNXO4zS7oTKi2I,24137
 dashscope/api_entities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dashscope/api_entities/aiohttp_request.py,sha256=1L7XdIJ9L65cQmX8x9JCR4t5hNIMDrbiWADfKKp9yfo,10280
 dashscope/api_entities/api_request_data.py,sha256=04rpYPNK1HkT3iTPJmZpquH621xcBbe8R8EGrDJSLt0,5514
-dashscope/api_entities/api_request_factory.py,sha256=18A40aHL0t3s01VdbkIWRGNeVJyX0GXRHTZUxau7po4,5640
+dashscope/api_entities/api_request_factory.py,sha256=ynpbFmxSne4dJkv5m40Vlwt4hJSxQPprAuUgMSQIQDg,5639
 dashscope/api_entities/base_request.py,sha256=W2SzrSAGFS6V8DErfSrayQtSL0T4iO7BrC8flr7nt1w,977
 dashscope/api_entities/chat_completion_types.py,sha256=1WMWPszhM3HaJBVz-ZXx-El4D8-RfVUL3ym65xsDRLk,11435
-dashscope/api_entities/dashscope_response.py,sha256=qNNB86h5Gb_4uHjBD_4lx6UckyQzSdaTgjze1prc12M,22073
+dashscope/api_entities/dashscope_response.py,sha256=slc7o9jNS5yzv2giEPzz9CDOW6X797nkAocgZ1r84aU,22089
 dashscope/api_entities/encryption.py,sha256=rUCZx3wwVvS5oyKXEeWgyWPxM8Y5d4AaVdgxLhizBqA,5517
-dashscope/api_entities/http_request.py,sha256=p2xfmq79evNON4ctCVXCcrJo8jnKABn0XzdTkTDgbLM,14540
+dashscope/api_entities/http_request.py,sha256=MTxYsbkK8oYWDp8ZPjrkdY9YbnQ9SEIy87riyJidMXo,16484
 dashscope/api_entities/websocket_request.py,sha256=PS0FU854-HjTbKa68f4GHa7-noFRMzKySJGfPkrrBjw,16146
 dashscope/app/__init__.py,sha256=xvSvU8O7m5u7vgIvJXTJektJZxmjT2Rpt_YwePH88XE,113
 dashscope/app/application.py,sha256=Whf_ij4RHOaY12_xdS8uj8HVNCwkTp_MRdrFTryF1Kg,9472
@@ -48,7 +48,7 @@ dashscope/audio/tts_v2/__init__.py,sha256=me9a3_7KsHQxcJ8hx4SeKlY1e_ThHVvGMw7Yn0
 dashscope/audio/tts_v2/enrollment.py,sha256=-nrlywYSOP73Bm9ETTSxNnlp-B8ezJcUmd59mVvyvgk,6361
 dashscope/audio/tts_v2/speech_synthesizer.py,sha256=jbTwybwJjhbgUa6TgeLUYnkDBkmk-tjzxta1FtYeWAk,20824
 dashscope/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dashscope/client/base_api.py,sha256=aWNy_xm02GXuLKVgWnYJht2nI4ZHSGfYIcr52SML15A,41239
+dashscope/client/base_api.py,sha256=znAJ65DeHiFw1H7FWK0YrkLz1CoNcyqUxF8EJ3gujeY,52523
 dashscope/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dashscope/common/api_key.py,sha256=yqFCAteq8CNQGnlLv6fxNFWsLqsQDbSzOpgAlUmDkaE,2037
 dashscope/common/base_type.py,sha256=2OQDqFlEH43wn54i-691cbarV_eKRLvRsPGfyb_GS0g,4670
@@ -98,10 +98,10 @@ dashscope/tokenizers/tokenization.py,sha256=ubQBJ_yw_MoHuHxZcK9NarZSSbyExloeSOLI
 dashscope/tokenizers/tokenizer.py,sha256=3FQVDvMNkCW9ccYeJdjrd_PIMMD3Xv7aNZkaYOE4XX4,1205
 dashscope/tokenizers/tokenizer_base.py,sha256=5EJIFuizMWESEmLmbd38yJnfeHmPnzZPwsO4aOGjpl4,707
 dashscope/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dashscope/utils/oss_utils.py,sha256=0BrMogT1PgNAWLYx947akgw_lcLsaVIIMAL1KUtaB88,7507
-dashscope-1.24.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dashscope-1.24.2.dist-info/METADATA,sha256=W7cXJ-appClSQXDftF5s2agUBHZHKaqrfPZ_oKZ35N4,7123
-dashscope-1.24.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-dashscope-1.24.2.dist-info/entry_points.txt,sha256=e9C3sOf9zDYL0O5ROEGX6FT8w-QK_kaGRWmPZDHAFys,49
-dashscope-1.24.2.dist-info/top_level.txt,sha256=woqavFJK9zas5xTqynmALqOtlafghjsk63Xk86powTU,10
-dashscope-1.24.2.dist-info/RECORD,,
+dashscope/utils/oss_utils.py,sha256=aZIHlMN2JOfVw6kp0SVrMw_N1MfoTcR_-wiRbJ7DgHw,7501
+dashscope-1.24.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dashscope-1.24.3.dist-info/METADATA,sha256=fLj2JRtUdQhu6TCj2GdodS2iFXLay7WWgMCcEq15jm4,7146
+dashscope-1.24.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dashscope-1.24.3.dist-info/entry_points.txt,sha256=e9C3sOf9zDYL0O5ROEGX6FT8w-QK_kaGRWmPZDHAFys,49
+dashscope-1.24.3.dist-info/top_level.txt,sha256=woqavFJK9zas5xTqynmALqOtlafghjsk63Xk86powTU,10
+dashscope-1.24.3.dist-info/RECORD,,