dashscope 1.15.0__py3-none-any.whl → 1.17.0__py3-none-any.whl

dashscope/assistants/files.py

@@ -0,0 +1,189 @@
+from dashscope.assistants.assistant_types import (AssistantFile,
+                                                  AssistantFileList,
+                                                  DeleteResponse)
+from dashscope.client.base_api import (CreateMixin, DeleteMixin,
+                                       GetStatusMixin, ListObjectMixin)
+from dashscope.common.error import InputRequired
+
+__all__ = ['Files']
+
+
+class Files(CreateMixin, DeleteMixin, ListObjectMixin, GetStatusMixin):
+    SUB_PATH = 'assistants'
+
+    @classmethod
+    def call(cls,
+             assistant_id: str,
+             *,
+             file_id: str,
+             workspace: str = None,
+             api_key: str = None,
+             **kwargs) -> AssistantFile:
+        """Create assistant file.
+
+        Args:
+            assistant_id (str): The target assistant id.
+            file_id (str): The file id.
+            workspace (str, optional): The DashScope workspace id. Defaults to None.
+            api_key (str, optional): The DashScope api key. Defaults to None.
+
+        Raises:
+            InputRequired: The assistant id and file id are required.
+
+        Returns:
+            AssistantFile: The assistant file object.
+        """
+        return cls.create(assistant_id,
+                          file_id=file_id,
+                          workspace=workspace,
+                          api_key=api_key,
+                          **kwargs)
+
+    @classmethod
+    def create(cls,
+               assistant_id: str,
+               *,
+               file_id: str,
+               workspace: str = None,
+               api_key: str = None,
+               **kwargs) -> AssistantFile:
+        """Create assistant file.
+
+        Args:
+            assistant_id (str): The target assistant id.
+            file_id (str): The file id.
+            workspace (str, optional): The DashScope workspace id. Defaults to None.
+            api_key (str, optional): The DashScope api key. Defaults to None.
+
+        Raises:
+            InputRequired: The assistant id and file id is required.
+
+        Returns:
+            AssistantFile: _description_
+        """
+        if not file_id or not assistant_id:
+            raise InputRequired('input file_id and assistant_id is required!')
+
+        response = super().call(data={'file_id': file_id},
+                                path=f'assistants/{assistant_id}/files',
+                                api_key=api_key,
+                                flattened_output=True,
+                                workspace=workspace,
+                                **kwargs)
+        return AssistantFile(**response)
+
+    @classmethod
+    def list(cls,
+             assistant_id: str,
+             *,
+             limit: int = None,
+             order: str = None,
+             after: str = None,
+             before: str = None,
+             workspace: str = None,
+             api_key: str = None,
+             **kwargs) -> AssistantFileList:
+        """List assistant files.
+
+        Args:
+            assistant_id (str): The assistant id.
+            limit (int, optional): How many assistant to retrieve. Defaults to None.
+            order (str, optional): Sort order by created_at. Defaults to None.
+            after (str, optional): Assistant id after. Defaults to None.
+            before (str, optional): Assistant id before. Defaults to None.
+            workspace (str, optional): The DashScope workspace id. Defaults to None.
+            api_key (str, optional): Your DashScope api key. Defaults to None.
+
+        Returns:
+            ListAssistantFile: The list of file objects.
+        """
+
+        response = super().list(limit=limit,
+                                order=order,
+                                after=after,
+                                before=before,
+                                path=f'assistants/{assistant_id}/files',
+                                api_key=api_key,
+                                flattened_output=True,
+                                workspace=workspace,
+                                **kwargs)
+        return AssistantFileList(**response)
+
+    @classmethod
+    def retrieve(cls,
+                 file_id: str,
+                 *,
+                 assistant_id: str,
+                 workspace: str = None,
+                 api_key: str = None,
+                 **kwargs) -> AssistantFile:
+        """Retrieve file information.
+
+        Args:
+            file_id (str): The file if.
+            assistant_id (str): The assistant id of the file.
+            workspace (str, optional): The DashScope workspace id. Defaults to None.
+            api_key (str, optional): Your DashScope api key. Defaults to None.
+
+        Returns:
+            AssistantFile: The `AssistantFile` object.
+        """
+        if not assistant_id or not file_id:
+            raise InputRequired('assistant id and file id are required!')
+        response = super().get(
+            file_id,
+            path=f'assistants/{assistant_id}/files/{file_id}',
+            api_key=api_key,
+            flattened_output=True,
+            workspace=workspace,
+            **kwargs)
+        return AssistantFile(**response)
+
+    @classmethod
+    def get(cls,
+            file_id: str,
+            *,
+            assistant_id: str,
+            workspace: str = None,
+            api_key: str = None,
+            **kwargs) -> AssistantFile:
+        """Retrieve file information.
+
+        Args:
+            file_id (str): The file if.
+            assistant_id (str): The assistant id of the file.
+            workspace (str, optional): The DashScope workspace id. Defaults to None.
+            api_key (str, optional): Your DashScope api key. Defaults to None.
+
+        Returns:
+            AssistantFile: The `AssistantFile` object.
+        """
+
+    @classmethod
+    def delete(cls,
+               file_id: str,
+               *,
+               assistant_id: str,
+               workspace: str = None,
+               api_key: str = None,
+               **kwargs) -> DeleteResponse:
+        """Delete the `file_id`.
+
+        Args:
+            file_id (str): The file to be deleted.
+            assistant_id (str): The assistant id of the file.
+            workspace (str, optional): The DashScope workspace id. Defaults to None.
+            api_key (str, optional): Your DashScope api key. Defaults to None.
+
+        Returns:
+            AssistantsDeleteResponse: _description_
+        """
+
+        response = super().delete(
+            file_id,
+            path=f'assistants/{assistant_id}/files/{file_id}',
+            api_key=api_key,
+            flattened_output=True,
+            workspace=workspace,
+            **kwargs)
+        return DeleteResponse(**response)

dashscope/audio/asr/asr_phrase_manager.py

@@ -16,6 +16,7 @@ class AsrPhraseManager(BaseAsyncApi):
                        model: str,
                        phrases: Dict[str, Any],
                        training_type: str = 'compile_asr_phrase',
+                       workspace: str = None,
                        **kwargs) -> DashScopeAPIResponse:
         """Create hot words.
 
@@ -25,6 +26,7 @@ class AsrPhraseManager(BaseAsyncApi):
                 such as {'下一首':90,'上一首':90}.
             training_type (str, `optional`): The training type,
                 'compile_asr_phrase' is default.
+            workspace (str): The dashscope workspace id.
 
         Raises:
             InvalidParameter: Parameter input is None or empty!
@@ -44,6 +46,7 @@ class AsrPhraseManager(BaseAsyncApi):
                                  validation_file_ids=[],
                                  mode=training_type,
                                  hyper_parameters={'phrase_list': phrases},
+                                 workspace=workspace,
                                  **kwargs)
         FineTune.SUB_PATH = original_ft_sub_path
 
@@ -58,6 +61,7 @@ class AsrPhraseManager(BaseAsyncApi):
                        phrase_id: str,
                        phrases: Dict[str, Any],
                        training_type: str = 'compile_asr_phrase',
+                       workspace: str = None,
                        **kwargs) -> DashScopeAPIResponse:
         """Update the hot words marked phrase_id.
 
@@ -69,6 +73,7 @@ class AsrPhraseManager(BaseAsyncApi):
                 such as {'暂停':90}.
             training_type (str, `optional`):
                 The training type, 'compile_asr_phrase' is default.
+            workspace (str): The dashscope workspace id.
 
         Raises:
             InvalidParameter: Parameter input is None or empty!
@@ -91,6 +96,7 @@ class AsrPhraseManager(BaseAsyncApi):
                                  mode=training_type,
                                  hyper_parameters={'phrase_list': phrases},
                                  finetuned_output=phrase_id,
+                                 workspace=workspace,
                                  **kwargs)
         FineTune.SUB_PATH = original_ft_sub_path
 
@@ -100,12 +106,16 @@ class AsrPhraseManager(BaseAsyncApi):
         return response
 
     @classmethod
-    def query_phrases(cls, phrase_id: str, **kwargs) -> DashScopeAPIResponse:
+    def query_phrases(cls,
+                      phrase_id: str,
+                      workspace: str = None,
+                      **kwargs) -> DashScopeAPIResponse:
         """Query the hot words by phrase_id.
 
         Args:
             phrase_id (str): The ID of phrases,
                 which created by create_phrases().
+            workspace (str): The dashscope workspace id.
 
         Raises:
             InvalidParameter: phrase_id input is None or empty!
@@ -118,7 +128,9 @@ class AsrPhraseManager(BaseAsyncApi):
 
         original_ft_sub_path = FineTune.SUB_PATH
         FineTune.SUB_PATH = 'fine-tunes/outputs'
-        response = FineTune.get(job_id=phrase_id, **kwargs)
+        response = FineTune.get(job_id=phrase_id,
+                                workspace=workspace,
+                                **kwargs)
         FineTune.SUB_PATH = original_ft_sub_path
 
         if response.status_code != HTTPStatus.OK:
@@ -130,6 +142,7 @@ class AsrPhraseManager(BaseAsyncApi):
     def list_phrases(cls,
                      page: int = 1,
                      page_size: int = 10,
+                     workspace: str = None,
                      **kwargs) -> DashScopeAPIResponse:
         """List all information of phrases.
 
@@ -137,13 +150,17 @@ class AsrPhraseManager(BaseAsyncApi):
             page (int): Page number, greater than 0, default value 1.
             page_size (int): The paging size, greater than 0
                 and less than or equal to 100, default value 10.
+            workspace (str): The dashscope workspace id.
 
         Returns:
             DashScopeAPIResponse: The results of listing hot words.
         """
         original_ft_sub_path = FineTune.SUB_PATH
         FineTune.SUB_PATH = 'fine-tunes/outputs'
-        response = FineTune.list(page=page, page_size=page_size, **kwargs)
+        response = FineTune.list(page=page,
+                                 page_size=page_size,
+                                 workspace=workspace,
+                                 **kwargs)
         FineTune.SUB_PATH = original_ft_sub_path
 
         if response.status_code != HTTPStatus.OK:
@@ -152,7 +169,10 @@ class AsrPhraseManager(BaseAsyncApi):
         return response
 
     @classmethod
-    def delete_phrases(cls, phrase_id: str, **kwargs) -> DashScopeAPIResponse:
+    def delete_phrases(cls,
+                       phrase_id: str,
+                       workspace: str = None,
+                       **kwargs) -> DashScopeAPIResponse:
         """Delete the hot words by phrase_id.
 
         Args:
@@ -170,7 +190,9 @@ class AsrPhraseManager(BaseAsyncApi):
 
         original_ft_sub_path = FineTune.SUB_PATH
         FineTune.SUB_PATH = 'fine-tunes/outputs'
-        response = FineTune.delete(job_id=phrase_id, **kwargs)
+        response = FineTune.delete(job_id=phrase_id,
+                                   workspace=workspace,
+                                   **kwargs)
         FineTune.SUB_PATH = original_ft_sub_path
 
         if response.status_code != HTTPStatus.OK:

dashscope/audio/asr/recognition.py

@@ -110,6 +110,7 @@ class Recognition(BaseApi):
             speech recognition results.
         format (str): The input audio format for speech recognition.
         sample_rate (int): The input audio sample rate for speech recognition.
+        workspace (str): The dashscope workspace id.
 
         **kwargs:
             phrase_id (list, `optional`): The ID of phrase.
@@ -130,8 +131,13 @@ class Recognition(BaseApi):
 
     SILENCE_TIMEOUT_S = 23
 
-    def __init__(self, model: str, callback: RecognitionCallback, format: str,
-                 sample_rate: int, **kwargs):
+    def __init__(self,
+                 model: str,
+                 callback: RecognitionCallback,
+                 format: str,
+                 sample_rate: int,
+                 workspace: str = None,
+                 **kwargs):
         if model is None:
             raise ModelRequired('Model is required!')
         if format is None:
@@ -150,6 +156,7 @@ class Recognition(BaseApi):
         self._worker = None
         self._silence_timer = None
         self._kwargs = kwargs
+        self._workspace = workspace
 
     def __del__(self):
         if self._running:
@@ -220,6 +227,7 @@ class Recognition(BaseApi):
                                  sample_rate=self.sample_rate,
                                  format=self.format,
                                  stream=True,
+                                 workspace=self._workspace,
                                  **self._kwargs)
         return responses
 

dashscope/audio/asr/transcription.py

@@ -29,6 +29,7 @@ class Transcription(BaseAsyncApi):
              file_urls: List[str],
              phrase_id: str = None,
              api_key: str = None,
+             workspace: str = None,
              **kwargs) -> TranscriptionResponse:
         """Transcribe the given files synchronously.
 
@@ -36,6 +37,7 @@ class Transcription(BaseAsyncApi):
             model (str): The requested model_id.
             file_urls (List[str]): List of stored URLs.
             phrase_id (str, `optional`): The ID of phrase.
+            workspace (str): The dashscope workspace id.
 
             **kwargs:
                 channel_id (List[int], optional):
@@ -56,7 +58,11 @@ class Transcription(BaseAsyncApi):
         """
         kwargs.update(cls._fill_resource_id(phrase_id, **kwargs))
         kwargs = cls._tidy_kwargs(**kwargs)
-        response = super().call(model, file_urls, api_key=api_key, **kwargs)
+        response = super().call(model,
+                                file_urls,
+                                api_key=api_key,
+                                workspace=workspace,
+                                **kwargs)
         return TranscriptionResponse.from_api_response(response)
 
     @classmethod
@@ -65,6 +71,7 @@ class Transcription(BaseAsyncApi):
                    file_urls: List[str],
                    phrase_id: str = None,
                    api_key: str = None,
+                   workspace: str = None,
                    **kwargs) -> TranscriptionResponse:
         """Transcribe the given files asynchronously,
         return the status of task submission for querying results subsequently.
@@ -73,6 +80,7 @@ class Transcription(BaseAsyncApi):
             model (str): The requested model, such as paraformer-16k-1
             file_urls (List[str]): List of stored URLs.
             phrase_id (str, `optional`): The ID of phrase.
+            workspace (str): The dashscope workspace id.
 
         **kwargs:
             channel_id (List[int], optional):
@@ -96,6 +104,7 @@ class Transcription(BaseAsyncApi):
         response = cls._launch_request(model,
                                        file_urls,
                                        api_key=api_key,
+                                       workspace=workspace,
                                        **kwargs)
         return TranscriptionResponse.from_api_response(response)
 
@@ -104,12 +113,14 @@ class Transcription(BaseAsyncApi):
         cls,
         task: Union[str, TranscriptionResponse],
         api_key: str = None,
+        workspace: str = None,
     ) -> TranscriptionResponse:
         """Fetch the status of task, including results of batch transcription when task_status is SUCCEEDED.  # noqa: E501
 
         Args:
             task (Union[str, TranscriptionResponse]): The task_id or
                 response including task_id returned from async_call().
+            workspace (str): The dashscope workspace id.
 
         Returns:
             TranscriptionResponse: The status of task_id,
@@ -118,7 +129,9 @@ class Transcription(BaseAsyncApi):
         try_count: int = 0
         while True:
             try:
-                response = super().fetch(task, api_key=api_key)
+                response = super().fetch(task,
+                                         api_key=api_key,
+                                         workspace=workspace)
             except (asyncio.TimeoutError, aiohttp.ClientConnectorError) as e:
                 logger.error(e)
                 try_count += 1
@@ -136,17 +149,19 @@ class Transcription(BaseAsyncApi):
         cls,
         task: Union[str, TranscriptionResponse],
         api_key: str = None,
+        workspace: str = None,
     ) -> TranscriptionResponse:
         """Poll task until the final results of transcription is obtained.
 
         Args:
             task (Union[str, TranscriptionResponse]): The task_id or
                 response including task_id returned from async_call().
+            workspace (str): The dashscope workspace id.
 
         Returns:
             TranscriptionResponse: The result of batch transcription.
         """
-        response = super().wait(task, api_key=api_key)
+        response = super().wait(task, api_key=api_key, workspace=workspace)
         return TranscriptionResponse.from_api_response(response)
 
     @classmethod
@@ -154,12 +169,14 @@ class Transcription(BaseAsyncApi):
                         model: str,
                         files: List[str],
                         api_key: str = None,
+                        workspace: str = None,
                         **kwargs) -> DashScopeAPIResponse:
         """Submit transcribe request.
 
         Args:
             model (str): The requested model, such as paraformer-16k-1
             files (List[str]): List of stored URLs.
+            workspace (str): The dashscope workspace id.
 
         Returns:
             DashScopeAPIResponse: The result of task submission.
@@ -177,6 +194,7 @@ class Transcription(BaseAsyncApi):
                                               api_protocol=ApiProtocol.HTTP,
                                               http_method=HTTPMethod.POST,
                                               api_key=api_key,
+                                              workspace=workspace,
                                               **kwargs)
             except (asyncio.TimeoutError, aiohttp.ClientConnectorError) as e:
                 logger.error(e)

dashscope/audio/tts/speech_synthesizer.py

@@ -94,6 +94,7 @@ class SpeechSynthesizer(BaseApi):
              model: str,
              text: str,
              callback: ResultCallback = None,
+             workspace: str = None,
              **kwargs) -> SpeechSynthesisResult:
         """Convert text to speech synchronously.
 
@@ -102,6 +103,7 @@ class SpeechSynthesizer(BaseApi):
             text (str): Text content used for speech synthesis.
             callback (ResultCallback): A callback that returns
                 speech synthesis results.
+            workspace (str): The dashscope workspace id.
             **kwargs:
                 format(str, `optional`): Audio encoding format,
                     such as pcm wav mp3, default is wav.
@@ -135,6 +137,7 @@ class SpeechSynthesizer(BaseApi):
                                 input={'text': text},
                                 stream=True,
                                 api_protocol=ApiProtocol.WEBSOCKET,
+                                workspace=workspace,
                                 **kwargs)
 
         if _callback is not None:

dashscope/cli.py

@@ -197,9 +197,9 @@ class FineTunes:
 class Files:
     @classmethod
     def upload(cls, args):
-        rsp = dashscope.File.upload(file_path=args.file,
-                                    purpose=args.purpose,
-                                    description=args.description)
+        rsp = dashscope.Files.upload(file_path=args.file,
+                                     purpose=args.purpose,
+                                     description=args.description)
         print(rsp)
         if rsp.status_code == HTTPStatus.OK:
             print('Upload success, file id: %s' %
@@ -209,7 +209,7 @@ class Files:
 
     @classmethod
     def get(cls, args):
-        rsp = dashscope.File.get(file_id=args.id)
+        rsp = dashscope.Files.get(file_id=args.id)
         if rsp.status_code == HTTPStatus.OK:
             print('file_id: %s, name: %s, description: %s' %
                   (rsp.output['file_id'], rsp.output['name'],
@@ -219,8 +219,8 @@ class Files:
 
     @classmethod
     def list(cls, args):
-        rsp = dashscope.File.list(page=args.start_page,
-                                  page_size=args.page_size)
+        rsp = dashscope.Files.list(page=args.start_page,
+                                   page_size=args.page_size)
         if rsp.status_code == HTTPStatus.OK:
             if rsp.output is not None:
                 for f in rsp.output['files']:
@@ -234,7 +234,7 @@ class Files:
 
     @classmethod
     def delete(cls, args):
-        rsp = dashscope.File.delete(args.id)
+        rsp = dashscope.Files.delete(args.id)
         if rsp.status_code == HTTPStatus.OK:
             print('Delete success')
         else: