dashscope 1.20.14__py3-none-any.whl → 1.21.0__py3-none-any.whl

dashscope/__init__.py

@@ -5,6 +5,7 @@ from dashscope.aigc.code_generation import CodeGeneration
 from dashscope.aigc.conversation import Conversation, History, HistoryItem
 from dashscope.aigc.generation import AioGeneration, Generation
 from dashscope.aigc.image_synthesis import ImageSynthesis
+from dashscope.aigc.video_synthesis import VideoSynthesis
 from dashscope.aigc.multimodal_conversation import MultiModalConversation
 from dashscope.app.application import Application
 from dashscope.assistants import Assistant, AssistantList, Assistants
@@ -84,6 +85,7 @@ __all__ = [
     RunStep,
     MessageFile,
     AssistantFile,
+    VideoSynthesis,
 ]
 
 logging.getLogger(__name__).addHandler(NullHandler())

dashscope/aigc/__init__.py

@@ -2,6 +2,7 @@ from .conversation import Conversation, History, HistoryItem
 from .generation import Generation
 from .image_synthesis import ImageSynthesis
 from .multimodal_conversation import MultiModalConversation
+from .video_synthesis import VideoSynthesis
 
 __all__ = [
     Generation,
@@ -10,4 +11,5 @@ __all__ = [
     History,
     ImageSynthesis,
     MultiModalConversation,
+    VideoSynthesis,
 ]

dashscope/aigc/video_synthesis.py

@@ -0,0 +1,242 @@
+from typing import Any, Dict, Union
+
+from dashscope.api_entities.dashscope_response import (DashScopeAPIResponse,
+                                                       VideoSynthesisResponse)
+from dashscope.client.base_api import BaseAsyncApi
+from dashscope.common.constants import PROMPT
+from dashscope.common.error import InputRequired
+from dashscope.common.utils import _get_task_group_and_task
+from dashscope.utils.oss_utils import check_and_upload_local
+
+
+class VideoSynthesis(BaseAsyncApi):
+    task = 'video-generation'
+    """API for video synthesis.
+    """
+    class Models:
+        wanx_txt2video_pro = 'wanx-txt2video-pro'
+        wanx_img2video_pro = 'wanx-img2video-pro'
+        wanx_2_1_t2v_turbo = 'wanx2.1-t2v-turbo'
+        wanx_2_1_t2v_plus = 'wanx2.1-t2v-plus'
+
+    @classmethod
+    def call(cls,
+             model: str,
+             prompt: Any,
+             extend_prompt: bool = True,
+             negative_prompt: str = None,
+             template: str = None,
+             img_url: str = None,
+             api_key: str = None,
+             extra_input: Dict = None,
+             workspace: str = None,
+             task: str = None,
+             **kwargs) -> VideoSynthesisResponse:
+        """Call video synthesis service and get result.
+
+        Args:
+            model (str): The model, reference ``Models``.
+            prompt (Any): The prompt for video synthesis.
+            extend_prompt (bool): The extend_prompt. Whether to enable write expansion. The default value is True.
+            negative_prompt (str): The negative prompt is the opposite of the prompt meaning.
+            template (str): LoRa input, such as gufeng, katong, etc.
+            img_url (str): The input image url, Generate the URL of the image referenced by the video.
+            api_key (str, optional): The api api_key. Defaults to None.
+            workspace (str): The dashscope workspace id.
+            extra_input (Dict): The extra input parameters.
+            task (str): The task of api, ref doc.
+            **kwargs:
+                size(str, `optional`): The output video size(width*height).
+                duration(int, optional): The duration. Duration of video generation. The default value is 5, in seconds.
+                seed(int, optional): The seed. The random seed for video generation. The default value is 5.
+
+        Raises:
+            InputRequired: The prompt cannot be empty.
+
+        Returns:
+            VideoSynthesisResponse: The video synthesis result.
+        """
+        return super().call(model,
+                            prompt,
+                            img_url=img_url,
+                            api_key=api_key,
+                            extend_prompt=extend_prompt,
+                            negative_prompt=negative_prompt,
+                            template=template,
+                            workspace=workspace,
+                            extra_input=extra_input,
+                            task=task,
+                            **kwargs)
+
+    @classmethod
+    def async_call(cls,
+                   model: str,
+                   prompt: Any,
+                   img_url: str = None,
+                   extend_prompt: bool = True,
+                   negative_prompt: str = None,
+                   template: str = None,
+                   api_key: str = None,
+                   extra_input: Dict = None,
+                   workspace: str = None,
+                   task: str = None,
+                   **kwargs) -> VideoSynthesisResponse:
+        """Create a video synthesis task, and return task information.
+
+        Args:
+            model (str): The model, reference ``Models``.
+            prompt (Any): The prompt for video synthesis.
+            extend_prompt (bool): The extend_prompt. Whether to enable write expansion. The default value is True.
+            negative_prompt (str): The negative prompt is the opposite of the prompt meaning.
+            template (str): LoRa input, such as gufeng, katong, etc.
+            img_url (str): The input image url, Generate the URL of the image referenced by the video.
+            api_key (str, optional): The api api_key. Defaults to None.
+            workspace (str): The dashscope workspace id.
+            extra_input (Dict): The extra input parameters.
+            task (str): The task of api, ref doc.
+            **kwargs:
+                size(str, `optional`): The output video size(width*height).
+                duration(int, optional): The duration. Duration of video generation. The default value is 5, in seconds.
+                seed(int, optional): The seed. The random seed for video generation. The default value is 5.
+
+        Raises:
+            InputRequired: The prompt cannot be empty.
+
+        Returns:
+            DashScopeAPIResponse: The video synthesis
+                task id in the response.
+        """
+        if prompt is None or not prompt:
+            raise InputRequired('prompt is required!')
+        task_group, function = _get_task_group_and_task(__name__)
+        inputs = {PROMPT: prompt, 'extend_prompt': extend_prompt}
+        if negative_prompt:
+            inputs['negative_prompt'] = negative_prompt
+        if template:
+            inputs['template'] = template
+        has_upload = False
+        if img_url is not None and img_url:
+            is_upload, res_img_url = check_and_upload_local(
+                model, img_url, api_key)
+            if is_upload:
+                has_upload = True
+            inputs['img_url'] = res_img_url
+        if extra_input is not None and extra_input:
+            inputs = {**inputs, **extra_input}
+        if has_upload:
+            headers = kwargs.pop('headers', {})
+            headers['X-DashScope-OssResourceResolve'] = 'enable'
+            kwargs['headers'] = headers
+        response = super().async_call(
+            model=model,
+            task_group=task_group,
+            task=VideoSynthesis.task if task is None else task,
+            function=function,
+            api_key=api_key,
+            input=inputs,
+            workspace=workspace,
+            **kwargs)
+        return VideoSynthesisResponse.from_api_response(response)
+
+    @classmethod
+    def fetch(cls,
+              task: Union[str, VideoSynthesisResponse],
+              api_key: str = None,
+              workspace: str = None) -> VideoSynthesisResponse:
+        """Fetch video synthesis task status or result.
+
+        Args:
+            task (Union[str, VideoSynthesisResponse]): The task_id or
+                VideoSynthesisResponse return by async_call().
+            api_key (str, optional): The api api_key. Defaults to None.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            VideoSynthesisResponse: The task status or result.
+        """
+        response = super().fetch(task, api_key=api_key, workspace=workspace)
+        return VideoSynthesisResponse.from_api_response(response)
+
+    @classmethod
+    def wait(cls,
+             task: Union[str, VideoSynthesisResponse],
+             api_key: str = None,
+             workspace: str = None) -> VideoSynthesisResponse:
+        """Wait for video synthesis task to complete, and return the result.
+
+        Args:
+            task (Union[str, VideoSynthesisResponse]): The task_id or
+                VideoSynthesisResponse return by async_call().
+            api_key (str, optional): The api api_key. Defaults to None.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            VideoSynthesisResponse: The task result.
+        """
+        response = super().wait(task, api_key, workspace=workspace)
+        return VideoSynthesisResponse.from_api_response(response)
+
+    @classmethod
+    def cancel(cls,
+               task: Union[str, VideoSynthesisResponse],
+               api_key: str = None,
+               workspace: str = None) -> DashScopeAPIResponse:
+        """Cancel video synthesis task.
+        Only tasks whose status is PENDING can be canceled.
+
+        Args:
+            task (Union[str, VideoSynthesisResponse]): The task_id or
+                VideoSynthesisResponse return by async_call().
+            api_key (str, optional): The api api_key. Defaults to None.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            DashScopeAPIResponse: The response data.
+        """
+        return super().cancel(task, api_key, workspace=workspace)
+
+    @classmethod
+    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.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            DashScopeAPIResponse: The response data.
+        """
+        return super().list(start_time=start_time,
+                            end_time=end_time,
+                            model_name=model_name,
+                            api_key_id=api_key_id,
+                            region=region,
+                            status=status,
+                            page_no=page_no,
+                            page_size=page_size,
+                            api_key=api_key,
+                            workspace=workspace,
+                            **kwargs)

dashscope/api_entities/dashscope_response.py

@@ -458,6 +458,24 @@ class ImageSynthesisOutput(DictMixin):
                          **kwargs)
 
 
+@dataclass(init=False)
+class VideoSynthesisOutput(DictMixin):
+    task_id: str
+    task_status: str
+    video_url: str
+
+    def __init__(self,
+                 task_id: str,
+                 task_status: str,
+                 video_url: str = '',
+                 **kwargs):
+        super().__init__(self,
+                         task_id=task_id,
+                         task_status=task_status,
+                         video_url=video_url,
+                         **kwargs)
+
+
 @dataclass(init=False)
 class ImageSynthesisUsage(DictMixin):
     image_count: int
@@ -466,6 +484,14 @@ class ImageSynthesisUsage(DictMixin):
         super().__init__(image_count=image_count, **kwargs)
 
 
+@dataclass(init=False)
+class VideoSynthesisUsage(DictMixin):
+    video_count: int
+
+    def __init__(self, video_count: int = 1, **kwargs):
+        super().__init__(video_count=video_count, **kwargs)
+
+
 @dataclass(init=False)
 class ImageSynthesisResponse(DashScopeAPIResponse):
     output: ImageSynthesisOutput
@@ -495,6 +521,35 @@ class ImageSynthesisResponse(DashScopeAPIResponse):
                                           message=api_response.message)
 
 
+@dataclass(init=False)
+class VideoSynthesisResponse(DashScopeAPIResponse):
+    output: VideoSynthesisOutput
+    usage: VideoSynthesisUsage
+
+    @staticmethod
+    def from_api_response(api_response: DashScopeAPIResponse):
+        if api_response.status_code == HTTPStatus.OK:
+            output = None
+            usage = None
+            if api_response.output is not None:
+                output = VideoSynthesisOutput(**api_response.output)
+            if api_response.usage is not None:
+                usage = VideoSynthesisUsage(**api_response.usage)
+
+            return VideoSynthesisResponse(status_code=api_response.status_code,
+                                          request_id=api_response.request_id,
+                                          code=api_response.code,
+                                          message=api_response.message,
+                                          output=output,
+                                          usage=usage)
+
+        else:
+            return VideoSynthesisResponse(status_code=api_response.status_code,
+                                          request_id=api_response.request_id,
+                                          code=api_response.code,
+                                          message=api_response.message)
+
+
 @dataclass(init=False)
 class ReRankResult(DictMixin):
     index: int

dashscope/utils/oss_utils.py

@@ -142,7 +142,7 @@ def check_and_upload_local(model: str, content: str, api_key: str):
             file_path = parse_result.netloc + unquote_plus(parse_result.path)
         else:
             file_path = unquote_plus(parse_result.path)
-        if os.path.exists(file_path):
+        if os.path.isfile(file_path):
             file_url = OssUtils.upload(model=model,
                                        file_path=file_path,
                                        api_key=api_key)
@@ -153,7 +153,7 @@ def check_and_upload_local(model: str, content: str, api_key: str):
         else:
             raise InvalidInput('The file: %s is not exists!' % file_path)
     elif not content.startswith('http'):
-        if os.path.exists(content):
+        if os.path.isfile(content):
             file_url = OssUtils.upload(model=model,
                                        file_path=content,
                                        api_key=api_key)

dashscope/version.py

@@ -1 +1 @@
-__version__ = '1.20.14'
+__version__ = '1.21.0'

{dashscope-1.20.14.dist-info → dashscope-1.21.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dashscope
-Version: 1.20.14
+Version: 1.21.0
 Summary: dashscope client sdk library
 Home-page: https://dashscope.aliyun.com/
 Author: Alibaba Cloud

{dashscope-1.20.14.dist-info → dashscope-1.21.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-dashscope/__init__.py,sha256=lIBZR5fWUiO1L62J_17Gri7Dwk9kCf2xhWl8eRw8bkQ,2933
+dashscope/__init__.py,sha256=_9PaKXKpYc6PXO35BjcH3R0As9sTsXGOW2iQ6R5HAVc,3011
 dashscope/cli.py,sha256=amegoTkGOs6TlHMdoo4JVOqBePo3lGs745rc7leEyrE,24020
 dashscope/deployment.py,sha256=ljmVi-ny6SjEs8v4oIGNWIw8UQTorE7dl5QJv7dEPIQ,5728
 dashscope/file.py,sha256=Dv2Fz3DLbcye2uuQxyQwRM7ky27OthouLXIpSQagQy4,3324
@@ -6,19 +6,20 @@ dashscope/files.py,sha256=QgJjwhtn9F548nCA8jD8OvE6aQEj-20hZqJgYXsUdQU,3930
 dashscope/finetune.py,sha256=_tflDUvu0KagSoCzLaf0hofpG_P8NU6PylL8CPjVhrA,6243
 dashscope/model.py,sha256=UPOn1qMYFhX-ovXi3BMxZEBk8qOK7WLJOYHMbPZwYBo,1440
 dashscope/models.py,sha256=1-bc-Ue68zurgu_y6RhfFr9uzeQMF5AZq-C32lJGMGU,1224
-dashscope/version.py,sha256=f2v96-65Z-gg0WsfONkq43TxOuOMUup-4S2fb1hhRjA,24
-dashscope/aigc/__init__.py,sha256=s-MCA87KYiVumYtKtJi5IMN7xelSF6TqEU3s3_7RF-Y,327
+dashscope/version.py,sha256=sYFfnMKW3_pCoUqTSWWoBwqO-qPtJaDtBAgvBJqMx4I,23
+dashscope/aigc/__init__.py,sha256=xmdalVw7wS0cLIuU8Q0qk0q8XGw-iGk8NnQwAQZ3jAc,391
 dashscope/aigc/code_generation.py,sha256=KAJVrGp6tiNFBBg64Ovs9RfcP5SrIhrbW3wdA89NKso,10885
 dashscope/aigc/conversation.py,sha256=xRoJlCR-IXHjSdkDrK74a9ut1FJg0FZhTNXZAJC18MA,14231
 dashscope/aigc/generation.py,sha256=53oMCmN5ZbqeqAsKxmdunXlRh-XP8ZtnA7hB2id4Koo,17897
 dashscope/aigc/image_synthesis.py,sha256=UWHW-nvf7_aDZKr4uZDusVHjqWr9TSZjCsZI8YSWaek,11052
 dashscope/aigc/multimodal_conversation.py,sha256=SlNnnsUPV19gdx8fYJAtsMFWPNGY6vhk5IGHZ5ZczpI,5369
+dashscope/aigc/video_synthesis.py,sha256=gbp5XG_DMVN0JnBOgxftdwsCIyrV7nM2gVnlyO8X-ek,10400
 dashscope/api_entities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dashscope/api_entities/aiohttp_request.py,sha256=aE3AeWba8Ig_xHMYjrAdkq0N61l_L2VFTG6HYh912X0,10229
 dashscope/api_entities/api_request_data.py,sha256=JUMcfpJjKXEZLCBSFIDpgoaeQYk5uK9-CwhM4OHIHFQ,5463
 dashscope/api_entities/api_request_factory.py,sha256=j4VOA1qKzvsK6-BOHGyA35oqsMkNoc4xZe9GHefV0fU,4947
 dashscope/api_entities/base_request.py,sha256=cXUL7xqSV8wBr5d-1kx65AO3IsRR9A_ps6Lok-v-MKM,926
-dashscope/api_entities/dashscope_response.py,sha256=Bp1T7HwVlkOvpMNg-AEjz-BScxhLUXMXlE8ApXTtfhQ,17872
+dashscope/api_entities/dashscope_response.py,sha256=4a8Iya8RBUnVdzGmzoj6NvaaEeEnodGAD7evBrqEXfU,19832
 dashscope/api_entities/http_request.py,sha256=pYE8qRMu9CaQDiugPlXeYoaj_diBv-ZDExCD3WNhehI,13259
 dashscope/api_entities/websocket_request.py,sha256=Xr6IJ9WqrIw5ouBQLpgoRSwL1C09jkb4u1EZdxhVQy0,15039
 dashscope/app/__init__.py,sha256=UiN_9i--z84Dw5wUehOh_Tkk_9Gq_td_Kbz1dobBEKg,62
@@ -84,10 +85,10 @@ dashscope/tokenizers/tokenization.py,sha256=G6cSEmVLr3pjXUC3EOU9ot8MYxNnOQ4wOB2m
 dashscope/tokenizers/tokenizer.py,sha256=y6P91qTCYo__pEx_0VHAcj9YECfbUdRqZU1fdGTjF4o,1154
 dashscope/tokenizers/tokenizer_base.py,sha256=REDhzRyDT13iequ61-a6_KcTy0GFKlihQve5HkyoyRs,656
 dashscope/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dashscope/utils/oss_utils.py,sha256=7vZ2Lypxwiit8VcAqAvr3cCyhVfaLapDiNuF-H3ZCD4,7332
-dashscope-1.20.14.dist-info/LICENSE,sha256=Izp5L1DF1Mbza6qojkqNNWlE_mYLnr4rmzx2EBF8YFw,11413
-dashscope-1.20.14.dist-info/METADATA,sha256=BjqLaIu_UNVWxAYRXU8wsrrr4I8qsr08dUtKcm-LGyY,6642
-dashscope-1.20.14.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-dashscope-1.20.14.dist-info/entry_points.txt,sha256=raEp5dOuj8whJ7yqZlDM8WQ5p2RfnGrGNo0QLQEnatY,50
-dashscope-1.20.14.dist-info/top_level.txt,sha256=woqavFJK9zas5xTqynmALqOtlafghjsk63Xk86powTU,10
-dashscope-1.20.14.dist-info/RECORD,,
+dashscope/utils/oss_utils.py,sha256=Ci_3gkvVGq_2kWzDA90lM7VoMoewAvCkoFcQTbPj8bI,7332
+dashscope-1.21.0.dist-info/LICENSE,sha256=Izp5L1DF1Mbza6qojkqNNWlE_mYLnr4rmzx2EBF8YFw,11413
+dashscope-1.21.0.dist-info/METADATA,sha256=vIJ9LChy9z3oLteT9IifLTqwTceHE8SMO7_ymLMJU3A,6641
+dashscope-1.21.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+dashscope-1.21.0.dist-info/entry_points.txt,sha256=raEp5dOuj8whJ7yqZlDM8WQ5p2RfnGrGNo0QLQEnatY,50
+dashscope-1.21.0.dist-info/top_level.txt,sha256=woqavFJK9zas5xTqynmALqOtlafghjsk63Xk86powTU,10
+dashscope-1.21.0.dist-info/RECORD,,