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

dashscope/assistants/assistants.py

@@ -0,0 +1,311 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
+from typing import Dict, List, Optional
+
+from dashscope.assistants.assistant_types import (Assistant, AssistantList,
+                                                  DeleteResponse)
+from dashscope.client.base_api import (CancelMixin, CreateMixin, DeleteMixin,
+                                       GetStatusMixin, ListObjectMixin,
+                                       UpdateMixin)
+from dashscope.common.error import ModelRequired
+
+__all__ = ['Assistants']
+
+
+class Assistants(CreateMixin, CancelMixin, DeleteMixin, ListObjectMixin,
+                 GetStatusMixin, UpdateMixin):
+    SUB_PATH = 'assistants'
+
+    @classmethod
+    def _create_assistant_object(
+        cls,
+        model: str = None,
+        name: str = None,
+        description: str = None,
+        instructions: str = None,
+        tools: Optional[List[Dict]] = None,
+        file_ids: Optional[List[str]] = [],
+        metadata: Dict = {},
+        top_p: Optional[float] = None,
+        top_k: Optional[int] = None,
+        temperature: Optional[float] = None,
+        max_tokens: Optional[int] = None,
+    ):
+        obj = {}
+        if model:
+            obj['model'] = model
+        if name:
+            obj['name'] = name
+        if description:
+            obj['description'] = description
+        if instructions:
+            obj['instructions'] = instructions
+        if tools is not None:
+            obj['tools'] = tools
+        obj['file_ids'] = file_ids
+        obj['metadata'] = metadata
+
+        if top_p is not None:
+            obj['top_p'] = top_p
+        if top_k is not None:
+            obj['top_k'] = top_k
+        if temperature is not None:
+            obj['temperature'] = temperature
+        if max_tokens is not None:
+            obj['max_tokens'] = max_tokens
+
+        return obj
+
+    @classmethod
+    def call(cls,
+             *,
+             model: str,
+             name: str = None,
+             description: str = None,
+             instructions: str = None,
+             tools: Optional[List[Dict]] = None,
+             file_ids: Optional[List[str]] = [],
+             metadata: Dict = None,
+             workspace: str = None,
+             api_key: str = None,
+             **kwargs) -> Assistant:
+        """Create Assistant.
+
+        Args:
+            model (str): The model to use.
+            name (str, optional): The assistant name. Defaults to None.
+            description (str, optional): The assistant description. Defaults to None.
+            instructions (str, optional): The system instructions this assistant uses. Defaults to None.
+            tools (Optional[List[Dict]], optional): List of tools to use. Defaults to [].
+            file_ids (Optional[List[str]], optional): : The files to use. Defaults to [].
+            metadata (Dict, optional): Custom key-value pairs associate with assistant. Defaults to None.
+            workspace (str, optional): The DashScope workspace id. Defaults to None.
+            api_key (str, optional): The DashScope api key. Defaults to None.
+
+        Raises:
+            ModelRequired: The model is required.
+
+        Returns:
+            Assistant: The `Assistant` object.
+        """
+        return cls.create(model=model,
+                          name=name,
+                          description=description,
+                          instructions=instructions,
+                          tools=tools,
+                          file_ids=file_ids,
+                          metadata=metadata,
+                          workspace=workspace,
+                          api_key=api_key,
+                          **kwargs)
+
+    @classmethod
+    def create(cls,
+               *,
+               model: str,
+               name: str = None,
+               description: str = None,
+               instructions: str = None,
+               tools: Optional[List[Dict]] = None,
+               file_ids: Optional[List[str]] = [],
+               metadata: Dict = None,
+               workspace: str = None,
+               api_key: str = None,
+               top_p: Optional[float] = None,
+               top_k: Optional[int] = None,
+               temperature: Optional[float] = None,
+               max_tokens: Optional[int] = None,
+               **kwargs) -> Assistant:
+        """Create Assistant.
+
+        Args:
+            model (str): The model to use.
+            name (str, optional): The assistant name. Defaults to None.
+            description (str, optional): The assistant description. Defaults to None.
+            instructions (str, optional): The system instructions this assistant uses. Defaults to None.
+            tools (Optional[List[Dict]], optional): List of tools to use. Defaults to [].
+            file_ids (Optional[List[str]], optional): : The files to use. Defaults to [].
+            metadata (Dict, optional): Custom key-value pairs associate with assistant. Defaults to None.
+            workspace (str, optional): The DashScope workspace id. Defaults to None.
+            api_key (str, optional): The DashScope api key. Defaults to None.
+            top_p (float, optional): top_p parameter for model. Defaults to None.
+            top_k (int, optional): top_p parameter for model. Defaults to None.
+            temperature (float, optional): temperature parameter for model. Defaults to None.
+            max_tokens (int, optional): max_tokens parameter for model. Defaults to None.
+
+        Raises:
+            ModelRequired: The model is required.
+
+        Returns:
+            Assistant: The `Assistant` object.
+        """
+        if not model:
+            raise ModelRequired('Model is required!')
+        data = cls._create_assistant_object(model, name, description,
+                                            instructions, tools, file_ids,
+                                            metadata, top_p, top_k, temperature, max_tokens)
+        response = super().call(data=data,
+                                api_key=api_key,
+                                flattened_output=True,
+                                workspace=workspace,
+                                **kwargs)
+        return Assistant(**response)
+
+    @classmethod
+    def retrieve(cls,
+                 assistant_id: str,
+                 *,
+                 workspace: str = None,
+                 api_key: str = None,
+                 **kwargs) -> Assistant:
+        """Get the `Assistant`.
+
+        Args:
+            assistant_id (str): The assistant id.
+            workspace (str): The dashscope workspace id.
+            api_key (str, optional): The api key. Defaults to None.
+
+        Returns:
+            Assistant: The `Assistant` object.
+        """
+        return cls.get(assistant_id,
+                       workspace=workspace,
+                       api_key=api_key,
+                       **kwargs)
+
+    @classmethod
+    def get(cls,
+            assistant_id: str,
+            *,
+            workspace: str = None,
+            api_key: str = None,
+            **kwargs) -> Assistant:
+        """Get the `Assistant`.
+
+        Args:
+            assistant_id (str): The assistant id.
+            workspace (str): The dashscope workspace id.
+            api_key (str, optional): The api key. Defaults to None.
+
+        Returns:
+            Assistant: The `Assistant` object.
+        """
+        if not assistant_id:
+            raise ModelRequired('assistant_id is required!')
+        response = super().get(assistant_id,
+                               workspace=workspace,
+                               api_key=api_key,
+                               flattened_output=True,
+                               **kwargs)
+        return Assistant(**response)
+
+    @classmethod
+    def list(cls,
+             *,
+             limit: int = None,
+             order: str = None,
+             after: str = None,
+             before: str = None,
+             workspace: str = None,
+             api_key: str = None,
+             **kwargs) -> AssistantList:
+        """List assistants
+
+        Args:
+            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:
+            AssistantList: The list of assistants.
+        """
+        response = super().list(limit=limit,
+                                order=order,
+                                after=after,
+                                before=before,
+                                workspace=workspace,
+                                api_key=api_key,
+                                flattened_output=True,
+                                **kwargs)
+        return AssistantList(**response)
+
+    @classmethod
+    def update(cls,
+               assistant_id: str,
+               *,
+               model: str = None,
+               name: str = None,
+               description: str = None,
+               instructions: str = None,
+               tools: Optional[List[Dict]] = None,
+               file_ids: Optional[List[str]] = [],
+               metadata: Dict = None,
+               workspace: str = None,
+               api_key: str = None,
+               top_p: Optional[float] = None,
+               top_k: Optional[int] = None,
+               temperature: Optional[float] = None,
+               max_tokens: Optional[int] = None,
+               **kwargs) -> Assistant:
+        """Update an exist assistants
+
+        Args:
+            assistant_id (str): The target assistant id.
+            model (str): The model to use.
+            name (str, optional): The assistant name. Defaults to None.
+            description (str, optional): The assistant description . Defaults to None.
+            instructions (str, optional): The system instructions this assistant uses.. Defaults to None.
+            tools (Optional[str], optional): List of tools to use.. Defaults to [].
+            file_ids (Optional[str], optional): The files to use in assistants.. Defaults to [].
+            metadata (Dict, optional): Custom key-value pairs associate with assistant. Defaults to None.
+            workspace (str): The DashScope workspace id.
+            api_key (str, optional): The DashScope workspace id. Defaults to None.
+            top_p (float, optional): top_p parameter for model. Defaults to None.
+            top_k (int, optional): top_p parameter for model. Defaults to None.
+            temperature (float, optional): temperature parameter for model. Defaults to None.
+            max_tokens (int, optional): max_tokens parameter for model. Defaults to None.
+
+        Returns:
+            Assistant: The updated assistant.
+        """
+        if not assistant_id:
+            raise ModelRequired('assistant_id is required!')
+        response = super().update(assistant_id,
+                                  cls._create_assistant_object(
+                                      model, name, description, instructions,
+                                      tools, file_ids, metadata, top_p, top_k, temperature, max_tokens),
+                                  api_key=api_key,
+                                  workspace=workspace,
+                                  flattened_output=True,
+                                  method='post',
+                                  **kwargs)
+        return Assistant(**response)
+
+    @classmethod
+    def delete(cls,
+               assistant_id: str,
+               *,
+               workspace: str = None,
+               api_key: str = None,
+               **kwargs) -> DeleteResponse:
+        """Delete uploaded file.
+
+        Args:
+            assistant_id (str): The assistant id want to delete.
+            workspace (str): The DashScope workspace id.
+            api_key (str, optional): The api key. Defaults to None.
+
+        Returns:
+            AssistantsDeleteResponse: Delete result.
+        """
+        if not assistant_id:
+            raise ModelRequired('assistant_id is required!')
+        response = super().delete(assistant_id,
+                                  api_key=api_key,
+                                  workspace=workspace,
+                                  flattened_output=True,
+                                  **kwargs)
+        return DeleteResponse(**response)

dashscope/assistants/files.py

@@ -0,0 +1,197 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+from typing import Optional
+
+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) -> Optional[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.
+        """
+        response = super().get(target=assistant_id + '/files/' + file_id, api_key=api_key, workspace=workspace, **kwargs)
+        if response.status_code == 200 and response.output:
+            return AssistantFile(**response.output)
+        else:
+            return None
+
+    @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/__init__.py

@@ -1,3 +1,5 @@
-from . import asr, tts
+# Copyright (c) Alibaba, Inc. and its affiliates.
 
-__all__ = [asr, tts]
+from . import asr, tts, tts_v2, qwen_tts, qwen_tts_realtime, qwen_omni
+
+__all__ = [asr, tts, tts_v2, qwen_tts, qwen_tts_realtime, qwen_omni]

dashscope/audio/asr/__init__.py

@@ -1,4 +1,20 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
+from .asr_phrase_manager import AsrPhraseManager
 from .recognition import Recognition, RecognitionCallback, RecognitionResult
 from .transcription import Transcription
+from .translation_recognizer import (TranscriptionResult, Translation,
+                                     TranslationRecognizerCallback,
+                                     TranslationRecognizerChat,
+                                     TranslationRecognizerRealtime,
+                                     TranslationRecognizerResultPack,
+                                     TranslationResult)
+from .vocabulary import VocabularyService, VocabularyServiceException
 
-__all__ = [Transcription, Recognition, RecognitionCallback, RecognitionResult]
+__all__ = [
+    'Transcription', 'Recognition', 'RecognitionCallback', 'RecognitionResult',
+    'AsrPhraseManager', 'VocabularyServiceException', 'VocabularyService',
+    'TranslationRecognizerRealtime', 'TranslationRecognizerChat',
+    'TranslationRecognizerCallback', 'Translation', 'TranslationResult',
+    'TranscriptionResult', 'TranslationRecognizerResultPack'
+]