dashscope 1.8.0__py3-none-any.whl → 1.25.6__py3-none-any.whl

dashscope/aigc/video_synthesis.py

@@ -0,0 +1,610 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
+from typing import Any, Dict, Union, List
+
+from dashscope.api_entities.dashscope_response import (DashScopeAPIResponse,
+                                                       VideoSynthesisResponse)
+from dashscope.client.base_api import BaseAsyncApi, BaseAsyncAioApi
+from dashscope.common.constants import PROMPT, REFERENCE_VIDEO_URLS
+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:
+        """@deprecated, use wanx2.1-t2v-plus instead"""
+        wanx_txt2video_pro = 'wanx-txt2video-pro'
+        """@deprecated, use wanx2.1-i2v-plus instead"""
+        wanx_img2video_pro = 'wanx-img2video-pro'
+
+        wanx_2_1_t2v_turbo = 'wanx2.1-t2v-turbo'
+        wanx_2_1_t2v_plus = 'wanx2.1-t2v-plus'
+
+        wanx_2_1_i2v_plus = 'wanx2.1-i2v-plus'
+        wanx_2_1_i2v_turbo = 'wanx2.1-i2v-turbo'
+
+        wanx_2_1_kf2v_plus = 'wanx2.1-kf2v-plus'
+        wanx_kf2v = 'wanx-kf2v'
+
+    @classmethod
+    def call(cls,
+             model: str,
+             prompt: Any = None,
+             # """@deprecated, use prompt_extend in parameters """
+             extend_prompt: bool = True,
+             negative_prompt: str = None,
+             template: str = None,
+             img_url: str = None,
+             audio_url: str = None,
+             reference_video_urls: List[str] = None,
+             reference_video_description: List[str] = None,
+             api_key: str = None,
+             extra_input: Dict = None,
+             workspace: str = None,
+             task: str = None,
+             head_frame: str = None,
+             tail_frame: str = None,
+             first_frame_url: str = None,
+             last_frame_url: 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): @deprecated, use prompt_extend in parameters
+            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.
+            audio_url (str): The input audio url
+            reference_video_urls (List[str]): list of character reference video file urls uploaded by the user
+            reference_video_description (List[str]): For the description information of the picture and sound of the reference video, corresponding to ref video, it needs to be in the order of the url. If the quantity is different, an error will be reported
+            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.
+            first_frame_url (str): The URL of the first frame image for generating the video.
+            last_frame_url (str): The URL of the last frame image for generating the video.
+            **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,
+                            audio_url=audio_url,
+                            reference_video_urls=reference_video_urls,
+                            reference_video_description=reference_video_description,
+                            api_key=api_key,
+                            extend_prompt=extend_prompt,
+                            negative_prompt=negative_prompt,
+                            template=template,
+                            workspace=workspace,
+                            extra_input=extra_input,
+                            task=task,
+                            head_frame=head_frame,
+                            tail_frame=tail_frame,
+                            first_frame_url=first_frame_url,
+                            last_frame_url=last_frame_url,
+                            **kwargs)
+
+    @classmethod
+    def _get_input(cls,
+                   model: str,
+                   prompt: Any = None,
+                   img_url: str = None,
+                   audio_url: str = None,
+                   reference_video_urls: List[str] = None,
+                   reference_video_description: List[str] = None,
+                   # """@deprecated, use prompt_extend in parameters """
+                   extend_prompt: bool = True,
+                   negative_prompt: str = None,
+                   template: str = None,
+                   api_key: str = None,
+                   extra_input: Dict = None,
+                   task: str = None,
+                   function: str = None,
+                   head_frame: str = None,
+                   tail_frame: str = None,
+                   first_frame_url: str = None,
+                   last_frame_url: str = None,
+                   **kwargs):
+
+        inputs = {PROMPT: prompt, 'extend_prompt': extend_prompt}
+        if negative_prompt:
+            inputs['negative_prompt'] = negative_prompt
+        if template:
+            inputs['template'] = template
+        if function:
+            inputs['function'] = function
+        if reference_video_description:
+            inputs['reference_video_description'] = reference_video_description
+
+        has_upload = False
+        upload_certificate = None
+
+        if img_url is not None and img_url:
+            is_upload, res_img_url, upload_certificate = check_and_upload_local(
+                model, img_url, api_key, upload_certificate)
+            if is_upload:
+                has_upload = True
+            inputs['img_url'] = res_img_url
+
+        if audio_url is not None and audio_url:
+            is_upload, res_audio_url, upload_certificate = check_and_upload_local(
+                model, audio_url, api_key, upload_certificate)
+            if is_upload:
+                has_upload = True
+            inputs['audio_url'] = res_audio_url
+
+        if head_frame is not None and head_frame:
+            is_upload, res_head_frame, upload_certificate = check_and_upload_local(
+                model, head_frame, api_key, upload_certificate)
+            if is_upload:
+                has_upload = True
+            inputs['head_frame'] = res_head_frame
+
+        if tail_frame is not None and tail_frame:
+            is_upload, res_tail_frame, upload_certificate = check_and_upload_local(
+                model, tail_frame, api_key, upload_certificate)
+            if is_upload:
+                has_upload = True
+            inputs['tail_frame'] = res_tail_frame
+
+        if first_frame_url is not None and first_frame_url:
+            is_upload, res_first_frame_url, upload_certificate = check_and_upload_local(
+                model, first_frame_url, api_key, upload_certificate)
+            if is_upload:
+                has_upload = True
+            inputs['first_frame_url'] = res_first_frame_url
+
+        if last_frame_url is not None and last_frame_url:
+            is_upload, res_last_frame_url, upload_certificate = check_and_upload_local(
+                model, last_frame_url, api_key, upload_certificate)
+            if is_upload:
+                has_upload = True
+            inputs['last_frame_url'] = res_last_frame_url
+
+        if (reference_video_urls is not None
+                and reference_video_urls and len(reference_video_urls) > 0):
+            new_videos = []
+            for video in reference_video_urls:
+                is_upload, new_video, upload_certificate = check_and_upload_local(
+                    model, video, api_key, upload_certificate)
+                if is_upload:
+                    has_upload = True
+                new_videos.append(new_video)
+            inputs[REFERENCE_VIDEO_URLS] = new_videos
+
+        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
+
+        if task is None:
+            task = VideoSynthesis.task
+        if model is not None and model and 'kf2v' in model:
+            task = 'image2video'
+
+        return inputs, kwargs, task
+
+    @classmethod
+    def async_call(cls,
+                   model: str,
+                   prompt: Any = None,
+                   img_url: str = None,
+                   audio_url: str = None,
+                   reference_video_urls: List[str] = None,
+                   reference_video_description: List[str] = None,
+                   # """@deprecated, use prompt_extend in parameters """
+                   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,
+                   head_frame: str = None,
+                   tail_frame: str = None,
+                   first_frame_url: str = None,
+                   last_frame_url: 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): @deprecated, use prompt_extend in parameters
+            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.
+            audio_url (str): The input audio url.
+            reference_video_urls (List[str]): list of character reference video file urls uploaded by the user
+            reference_video_description (List[str]): For the description information of the picture and sound of the reference video, corresponding to ref video, it needs to be in the order of the url. If the quantity is different, an error will be reported
+            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.
+            first_frame_url (str): The URL of the first frame image for generating the video.
+            last_frame_url (str): The URL of the last frame image for generating the video.
+            **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.
+        """
+        task_group, function = _get_task_group_and_task(__name__)
+
+        inputs, kwargs, task = cls._get_input(
+            model, prompt, img_url, audio_url, reference_video_urls, reference_video_description,
+            extend_prompt, negative_prompt, template, api_key,
+            extra_input, task, function, head_frame, tail_frame,
+            first_frame_url, last_frame_url, **kwargs)
+
+        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)
+
+class AioVideoSynthesis(BaseAsyncAioApi):
+    @classmethod
+    async def call(cls,
+                   model: str,
+                   prompt: Any = None,
+                   img_url: str = None,
+                   audio_url: str = None,
+                   reference_video_urls: List[str] = None,
+                   reference_video_description: List[str] = None,
+                   # """@deprecated, use prompt_extend in parameters """
+                   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,
+                   head_frame: str = None,
+                   tail_frame: str = None,
+                   first_frame_url: str = None,
+                   last_frame_url: 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): @deprecated, use prompt_extend in parameters
+            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.
+            audio_url (str): The input audio url.
+            reference_video_urls (List[str]): list of character reference video file urls uploaded by the user
+            reference_video_description (List[str]): For the description information of the picture and sound of the reference video, corresponding to ref video, it needs to be in the order of the url. If the quantity is different, an error will be reported
+            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.
+            first_frame_url (str): The URL of the first frame image for generating the video.
+            last_frame_url (str): The URL of the last frame image for generating the video.
+            **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.
+        """
+        task_group, f = _get_task_group_and_task(__name__)
+        inputs, kwargs, task = VideoSynthesis._get_input(
+            model, prompt, img_url, audio_url, reference_video_urls, reference_video_description,
+            extend_prompt, negative_prompt, template, api_key,
+            extra_input, task, f, head_frame, tail_frame,
+            first_frame_url, last_frame_url, **kwargs)
+        response = await super().call(model, inputs, task_group, task, f, api_key, workspace, **kwargs)
+        return VideoSynthesisResponse.from_api_response(response)
+
+    @classmethod
+    async def async_call(cls,
+                   model: str,
+                   prompt: Any = None,
+                   img_url: str = None,
+                   audio_url: str = None,
+                   reference_video_urls: List[str] = None,
+                   reference_video_description: List[str] = None,
+                   # """@deprecated, use prompt_extend in parameters """
+                   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,
+                   head_frame: str = None,
+                   tail_frame: str = None,
+                   first_frame_url: str = None,
+                   last_frame_url: 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): @deprecated, use prompt_extend in parameters
+            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.
+            audio_url (str): The input audio url.
+            reference_video_urls (List[str]): list of character reference video file urls uploaded by the user
+            reference_video_description (List[str]): For the description information of the picture and sound of the reference video, corresponding to ref video, it needs to be in the order of the url. If the quantity is different, an error will be reported
+            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.
+            first_frame_url (str): The URL of the first frame image for generating the video.
+            last_frame_url (str): The URL of the last frame image for generating the video.
+            **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.
+        """
+        task_group, function = _get_task_group_and_task(__name__)
+
+        inputs, kwargs, task = VideoSynthesis._get_input(
+            model, prompt, img_url, audio_url, reference_video_urls, reference_video_description,
+            extend_prompt, negative_prompt, template, api_key,
+            extra_input, task, function, head_frame, tail_frame,
+            first_frame_url, last_frame_url, **kwargs)
+
+        response = await 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
+    async def fetch(cls,
+                    task: Union[str, VideoSynthesisResponse],
+                    api_key: str = None,
+                    workspace: str = None,
+                    **kwargs) -> 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 = await super().fetch(task, api_key=api_key, workspace=workspace)
+        return VideoSynthesisResponse.from_api_response(response)
+
+    @classmethod
+    async def wait(cls,
+                task: Union[str, VideoSynthesisResponse],
+                api_key: str = None,
+                workspace: str = None,
+                **kwargs) -> 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 = await super().wait(task, api_key, workspace=workspace)
+        return VideoSynthesisResponse.from_api_response(response)
+
+    @classmethod
+    async def cancel(cls,
+                   task: Union[str, VideoSynthesisResponse],
+                   api_key: str = None,
+                   workspace: str = None,
+                   **kwargs) -> 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 await super().cancel(task, api_key, workspace=workspace)
+
+    @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.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            DashScopeAPIResponse: The response data.
+        """
+        return await 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/aiohttp_request.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import json
 from http import HTTPStatus
 
@@ -6,8 +8,7 @@ import aiohttp
 from dashscope.api_entities.base_request import AioBaseRequest
 from dashscope.api_entities.dashscope_response import DashScopeAPIResponse
 from dashscope.common.constants import (DEFAULT_REQUEST_TIMEOUT_SECONDS,
-                                        SSE_CONTENT_TYPE, HTTPMethod,
-                                        StreamResultMode)
+                                        SSE_CONTENT_TYPE, HTTPMethod)
 from dashscope.common.error import UnsupportedHTTPMethod
 from dashscope.common.logging import logger
 from dashscope.common.utils import async_to_sync
@@ -21,9 +22,9 @@ class AioHttpRequest(AioBaseRequest):
                  stream: bool = True,
                  async_request: bool = False,
                  query: bool = False,
-                 stream_result_mode: str = StreamResultMode.ACCUMULATE,
                  timeout: int = DEFAULT_REQUEST_TIMEOUT_SECONDS,
-                 task_id: str = None) -> None:
+                 task_id: str = None,
+                 user_agent: str = '') -> None:
         """HttpSSERequest, processing http server sent event stream.
 
         Args:
@@ -33,9 +34,11 @@ class AioHttpRequest(AioBaseRequest):
             stream (bool, optional): Is stream request. Defaults to True.
             timeout (int, optional): Total request timeout.
                 Defaults to DEFAULT_REQUEST_TIMEOUT_SECONDS.
+            user_agent (str, optional): Additional user agent string to
+                append. Defaults to ''.
         """
 
-        super().__init__()
+        super().__init__(user_agent=user_agent)
         self.url = url
         self.async_request = async_request
         self.headers = {

dashscope/api_entities/api_request_data.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import json
 from urllib.parse import urlencode
 
@@ -41,10 +43,10 @@ class ApiRequestData():
     def add_parameters(self, **params):
         for key, value in params.items():
             self.parameters[key] = value
-    
+
     def add_resources(self, resources):
         self.resources = resources
-    
+
     def to_request_object(self) -> str:
         """Convert data to json, called from http request.
         Returns: