dashscope 1.22.1__py3-none-any.whl → 1.23.0__py3-none-any.whl

dashscope/__init__.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import logging
 from logging import NullHandler
 
@@ -5,8 +7,8 @@ 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.aigc.video_synthesis import VideoSynthesis
 from dashscope.app.application import Application
 from dashscope.assistants import Assistant, AssistantList, Assistants
 from dashscope.assistants.assistant_types import AssistantFile, DeleteResponse

dashscope/aigc/__init__.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 from .conversation import Conversation, History, HistoryItem
 from .generation import Generation
 from .image_synthesis import ImageSynthesis

dashscope/aigc/chat_completion.py

@@ -1,14 +1,17 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import json
 from typing import Any, Dict, Generator, List, Union
 
 import dashscope
+from dashscope.aigc.generation import Generation
+from dashscope.api_entities.chat_completion_types import (ChatCompletion,
+                                                          ChatCompletionChunk)
 from dashscope.api_entities.dashscope_response import (GenerationResponse,
                                                        Message)
 from dashscope.client.base_api import BaseAioApi, CreateMixin
-from dashscope.common import constants
 from dashscope.common.error import InputRequired, ModelRequired
 from dashscope.common.utils import _get_task_group_and_task
-from dashscope.api_entities.chat_completion_types import ChatCompletion, ChatCompletionChunk
 
 
 class Completions(CreateMixin):
@@ -16,6 +19,7 @@ class Completions(CreateMixin):
 
     """
     SUB_PATH = ''
+
     @classmethod
     def create(
         cls,
@@ -115,9 +119,16 @@ class Completions(CreateMixin):
             data['repetition_penalty'] = repetition_penalty
         if extra_body is not None and extra_body:
             data = {**data, **extra_body}
-        
+
         if extra_headers is not None and extra_headers:
-            kwargs = {'headers': extra_headers} if kwargs else {**kwargs, **{'headers': extra_headers}}
+            kwargs = {
+                'headers': extra_headers
+            } if kwargs else {
+                **kwargs,
+                **{
+                    'headers': extra_headers
+                }
+            }
 
         response = super().call(data=data,
                                 path='chat/completions',

dashscope/aigc/code_generation.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 from typing import Generator, List, Union
 
 from dashscope.api_entities.dashscope_response import (DashScopeAPIResponse,

dashscope/aigc/conversation.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import json
 from copy import deepcopy
 from http import HTTPStatus

dashscope/aigc/generation.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import copy
 import json
 from typing import Any, Dict, Generator, List, Union

dashscope/aigc/image_synthesis.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 from typing import Any, Dict, List, Union
 
 from dashscope.api_entities.dashscope_response import (DashScopeAPIResponse,

dashscope/aigc/multimodal_conversation.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import copy
 from typing import Generator, List, Union
 
@@ -121,8 +123,10 @@ class MultiModalConversation(BaseApi):
         for message in messages:
             content = message['content']
             for elem in content:
-                is_upload = preprocess_message_element(model, elem, api_key)
-                if is_upload and not has_upload:
-                    has_upload = True
-
+                if not isinstance(elem,
+                                  (int, float, bool, str, bytes, bytearray)):
+                    is_upload = preprocess_message_element(
+                        model, elem, api_key)
+                    if is_upload and not has_upload:
+                        has_upload = True
         return has_upload

dashscope/aigc/video_synthesis.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 from typing import Any, Dict, Union
 
 from dashscope.api_entities.dashscope_response import (DashScopeAPIResponse,

dashscope/api_entities/aiohttp_request.py

@@ -1,7 +1,10 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import json
 from http import HTTPStatus
 
 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,

dashscope/api_entities/api_request_data.py

@@ -1,7 +1,10 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import json
 from urllib.parse import urlencode
 
 import aiohttp
+
 from dashscope.common.constants import ApiProtocol
 from dashscope.io.input_output import InputResolver
 

dashscope/api_entities/api_request_factory.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 from urllib.parse import urlencode
 
 import dashscope

dashscope/api_entities/base_request.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import os
 import platform
 from abc import ABC, abstractmethod

dashscope/api_entities/chat_completion_types.py

@@ -1,34 +1,11 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 # adapter from openai sdk
 from dataclasses import dataclass
-from typing import Dict, List, Literal, Optional
+from typing import List, Literal, Optional
 
 from dashscope.common.base_type import BaseObjectMixin
-"""
-{
-    "choices": [
-        {
-            "message": {
-                "role": "assistant",
-                "content": "很抱歉，由于您提供的信息不完整，我无法直接比较两篇文章的内容。但是，一般而言，大型语言模型的训练通常确实涉及两个主要阶段：\n\n1. **预训练阶段 (Pre-Training Phase)**：在这个阶段，模型在大规模无标注文本数据集（如互联网上的网页、书籍、新闻等）上进行训练。目的是让模型学习语言的通用模式和结构。常见的预训练技术包括自回归（Autoregressive）模型如GPT系列，以及transformer架构下的编码器-解码器模型如BERT系列。\n\n2. **微调阶段 (Fine-Tuning Phase)**：预训练模型在特定任务的数据集上进行进一步训练，以适应下游任务，如问答、文本分类、机器翻译等。这个阶段允许模型根据具体任务的需求调整权重，从而提高性能。\n\n如果您能提供更详细的信息或两篇文章的具体内容，我可以给出更准确的比较分析。"
-            },
-            "finish_reason": "stop",
-            "index": 0,
-            "logprobs": null
-        }
-    ],
-    "object": "chat.completion",
-    "usage": {
-        "prompt_tokens": 66,
-        "completion_tokens": 195,
-        "total_tokens": 261
-    },
-    "created": 1716539630,
-    "system_fingerprint": null,
-    "model": "qwen-long",
-    "id": "chatcmpl-a737071790e091c6be016ea27a891392",
-    "status_code": 200
-}
-"""
+
 
 @dataclass(init=False)
 class CompletionUsage(BaseObjectMixin):
@@ -43,6 +20,7 @@ class CompletionUsage(BaseObjectMixin):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
+
 @dataclass(init=False)
 class TopLogprob(BaseObjectMixin):
     token: str
@@ -66,6 +44,7 @@ class TopLogprob(BaseObjectMixin):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
+
 @dataclass(init=False)
 class ChatCompletionTokenLogprob(BaseObjectMixin):
     token: str
@@ -95,32 +74,35 @@ class ChatCompletionTokenLogprob(BaseObjectMixin):
     returned.
     """
     def __init__(self, **kwargs):
-        if 'top_logprobs' in kwargs and kwargs['top_logprobs'] is not None and kwargs['top_logprobs']:
+        if 'top_logprobs' in kwargs and kwargs[
+                'top_logprobs'] is not None and kwargs['top_logprobs']:
             top_logprobs = []
             for logprob in kwargs['top_logprobs']:
                 top_logprobs.append(ChatCompletionTokenLogprob(**logprob))
             self.top_logprobs = top_logprobs
         else:
             self.top_logprobs = None
-                
+
         super().__init__(**kwargs)
-        
-   
+
+
 @dataclass(init=False)
 class ChoiceLogprobs(BaseObjectMixin):
     content: Optional[List[ChatCompletionTokenLogprob]] = None
     """A list of message content tokens with log probability information."""
     def __init__(self, **kwargs):
-        if 'content' in kwargs and kwargs['content'] is not None and kwargs['content']:
+        if 'content' in kwargs and kwargs['content'] is not None and kwargs[
+                'content']:
             logprobs = []
             for logprob in kwargs['content']:
                 logprobs.append(ChatCompletionTokenLogprob(**logprob))
             self.content = logprobs
         else:
             self.content = None
-                
+
         super().__init__(**kwargs)
 
+
 @dataclass(init=False)
 class FunctionCall(BaseObjectMixin):
     arguments: str
@@ -136,6 +118,7 @@ class FunctionCall(BaseObjectMixin):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
+
 @dataclass(init=False)
 class Function(BaseObjectMixin):
     arguments: str
@@ -151,6 +134,7 @@ class Function(BaseObjectMixin):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
+
 @dataclass(init=False)
 class ChatCompletionMessageToolCall(BaseObjectMixin):
     id: str
@@ -159,22 +143,24 @@ class ChatCompletionMessageToolCall(BaseObjectMixin):
     function: Function
     """The function that the model called."""
 
-    type: Literal["function"]
+    type: Literal['function']
     """The type of the tool. Currently, only `function` is supported."""
     def __init__(self, **kwargs):
-        if 'function' in kwargs and kwargs['function'] is not None and kwargs['function']:
+        if 'function' in kwargs and kwargs['function'] is not None and kwargs[
+                'function']:
             self.function = Function(**kwargs.pop('function', {}))
         else:
-            function = None
-                
+            self.function = None
+
         super().__init__(**kwargs)
-    
+
+
 @dataclass(init=False)
 class ChatCompletionMessage(BaseObjectMixin):
     content: Optional[str] = None
     """The contents of the message."""
 
-    role: Literal["assistant"]
+    role: Literal['assistant']
     """The role of the author of this message."""
 
     function_call: Optional[FunctionCall] = None
@@ -185,23 +171,27 @@ class ChatCompletionMessage(BaseObjectMixin):
     """
 
     tool_calls: Optional[List[ChatCompletionMessageToolCall]] = None
-    
     """The tool calls generated by the model, such as function calls."""
     def __init__(self, **kwargs):
-        if 'function_call' in kwargs and kwargs['function_call'] is not None and kwargs['function_call']:
-            self.function_call = FunctionCall(**kwargs.pop('function_call', {}))
-        
-        if 'tool_calls' in kwargs and kwargs['tool_calls'] is not None and kwargs['tool_calls']:
+        if 'function_call' in kwargs and kwargs[
+                'function_call'] is not None and kwargs['function_call']:
+            self.function_call = FunctionCall(
+                **kwargs.pop('function_call', {}))
+
+        if 'tool_calls' in kwargs and kwargs[
+                'tool_calls'] is not None and kwargs['tool_calls']:
             tool_calls = []
             for tool_call in kwargs['tool_calls']:
                 tool_calls.append(ChatCompletionMessageToolCall(**tool_call))
             self.tool_calls = tool_calls
-                
+
         super().__init__(**kwargs)
-    
+
+
 @dataclass(init=False)
 class Choice(BaseObjectMixin):
-    finish_reason: Literal["stop", "length", "tool_calls", "content_filter", "function_call"]
+    finish_reason: Literal['stop', 'length', 'tool_calls', 'content_filter',
+                           'function_call']
     """The reason the model stopped generating tokens.
 
     This will be `stop` if the model hit a natural stop point or a provided stop
@@ -219,18 +209,20 @@ class Choice(BaseObjectMixin):
 
     message: ChatCompletionMessage
     """A chat completion message generated by the model."""
-    
     def __init__(self, **kwargs):
-        if 'message' in kwargs and kwargs['message'] is not None and kwargs['message']:
+        if 'message' in kwargs and kwargs['message'] is not None and kwargs[
+                'message']:
             self.message = ChatCompletionMessage(**kwargs.pop('message', {}))
         else:
             self.message = None
-        
-        if 'logprobs' in kwargs and kwargs['logprobs'] is not None and kwargs['logprobs']:
+
+        if 'logprobs' in kwargs and kwargs['logprobs'] is not None and kwargs[
+                'logprobs']:
             self.logprobs = ChoiceLogprobs(**kwargs.pop('logprobs', {}))
 
         super().__init__(**kwargs)
-    
+
+
 @dataclass(init=False)
 class ChatCompletion(BaseObjectMixin):
     status_code: int
@@ -257,7 +249,7 @@ class ChatCompletion(BaseObjectMixin):
     model: str
     """The model used for the chat completion."""
 
-    object: Literal["chat.completion"]
+    object: Literal['chat.completion']
     """The object type, which is always `chat.completion`."""
 
     system_fingerprint: Optional[str] = None
@@ -269,14 +261,15 @@ class ChatCompletion(BaseObjectMixin):
 
     usage: Optional[CompletionUsage] = None
     """Usage statistics for the completion request."""
-    
     def __init__(self, **kwargs):
-        if 'usage' in kwargs and kwargs['usage'] is not None and kwargs['usage']:
+        if 'usage' in kwargs and kwargs['usage'] is not None and kwargs[
+                'usage']:
             self.usage = CompletionUsage(**kwargs.pop('usage', {}))
         else:
             self.usage = None
-        
-        if 'choices' in kwargs and kwargs['choices'] is not None and kwargs['choices']:
+
+        if 'choices' in kwargs and kwargs['choices'] is not None and kwargs[
+                'choices']:
             choices = []
             for choice in kwargs.pop('choices', []):
                 choices.append(Choice(**choice))
@@ -284,7 +277,8 @@ class ChatCompletion(BaseObjectMixin):
         else:
             self.choices = None
         super().__init__(**kwargs)
-        
+
+
 @dataclass(init=False)
 class ChatCompletionChunk(BaseObjectMixin):
     status_code: int
@@ -315,7 +309,7 @@ class ChatCompletionChunk(BaseObjectMixin):
     model: str
     """The model to generate the completion."""
 
-    object: Literal["chat.completion.chunk"]
+    object: Literal['chat.completion.chunk']
     """The object type, which is always `chat.completion.chunk`."""
 
     system_fingerprint: Optional[str] = None
@@ -333,12 +327,14 @@ class ChatCompletionChunk(BaseObjectMixin):
     statistics for the entire request.
     """
     def __init__(self, **kwargs):
-        if 'usage' in kwargs and kwargs['usage'] is not None and kwargs['usage']:
+        if 'usage' in kwargs and kwargs['usage'] is not None and kwargs[
+                'usage']:
             self.usage = CompletionUsage(**kwargs.pop('usage', {}))
         else:
             self.usage = None
-        
-        if 'choices' in kwargs and kwargs['choices'] is not None and kwargs['choices']:
+
+        if 'choices' in kwargs and kwargs['choices'] is not None and kwargs[
+                'choices']:
             choices = []
             for choice in kwargs.pop('choices', []):
                 choices.append(Choice(**choice))
@@ -346,4 +342,3 @@ class ChatCompletionChunk(BaseObjectMixin):
         else:
             self.choices = None
         super().__init__(**kwargs)
-    

dashscope/api_entities/dashscope_response.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import json
 from dataclasses import dataclass
 from http import HTTPStatus
@@ -487,9 +489,18 @@ class ImageSynthesisUsage(DictMixin):
 @dataclass(init=False)
 class VideoSynthesisUsage(DictMixin):
     video_count: int
+    video_duration: int
+    video_ratio: str
 
-    def __init__(self, video_count: int = 1, **kwargs):
-        super().__init__(video_count=video_count, **kwargs)
+    def __init__(self,
+                 video_count: int = 1,
+                 video_duration: int = 0,
+                 video_ratio: str = '',
+                 **kwargs):
+        super().__init__(video_count=video_count,
+                         video_duration=video_duration,
+                         video_ratio=video_ratio,
+                         **kwargs)
 
 
 @dataclass(init=False)
@@ -611,3 +622,64 @@ class ReRankResponse(DashScopeAPIResponse):
                                   request_id=api_response.request_id,
                                   code=api_response.code,
                                   message=api_response.message)
+
+
+@dataclass(init=False)
+class TextToSpeechAudio(DictMixin):
+    expires_at: int
+    id: str
+    data: str
+    url: str
+
+    def __init__(self,
+                 expires_at: int,
+                 id: str,
+                 data: str = None,
+                 url: str = None,
+                 **kwargs):
+        super().__init__(expires_at=expires_at,
+                         id=id,
+                         data=data,
+                         url=url,
+                         **kwargs)
+
+
+@dataclass(init=False)
+class TextToSpeechOutput(DictMixin):
+    finish_reason: str
+    audio: TextToSpeechAudio
+
+    def __init__(self,
+                 finish_reason: str = None,
+                 audio: TextToSpeechAudio = None,
+                 **kwargs):
+        super().__init__(finish_reason=finish_reason,
+                         audio=audio,
+                         **kwargs)
+
+
+@dataclass(init=False)
+class TextToSpeechResponse(DashScopeAPIResponse):
+    output: TextToSpeechOutput
+    usage: MultiModalConversationUsage
+
+    @staticmethod
+    def from_api_response(api_response: DashScopeAPIResponse):
+        if api_response.status_code == HTTPStatus.OK:
+            usage = {}
+            if api_response.usage:
+                usage = api_response.usage
+
+            return MultiModalConversationResponse(
+                status_code=api_response.status_code,
+                request_id=api_response.request_id,
+                code=api_response.code,
+                message=api_response.message,
+                output=TextToSpeechOutput(**api_response.output),
+                usage=MultiModalConversationUsage(**usage))
+        else:
+            return TextToSpeechResponse(
+                status_code=api_response.status_code,
+                request_id=api_response.request_id,
+                code=api_response.code,
+                message=api_response.message)

dashscope/api_entities/http_request.py

@@ -1,8 +1,11 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import json
 from http import HTTPStatus
 
 import aiohttp
 import requests
+
 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,

dashscope/api_entities/websocket_request.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import asyncio
 import json
 import uuid
@@ -5,6 +7,7 @@ from http import HTTPStatus
 from typing import Tuple, Union
 
 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,
@@ -356,5 +359,3 @@ class WebSocketRequest(AioBaseRequest):
     def _build_up_message(self, headers, payload):
         message = {'header': headers, 'payload': payload}
         return json.dumps(message)
-
-[{"type": "Path", "pathConfig": {"values": ["/api/v1/configs/*","/api/v1/auths/activate","/api/v1/evaluations/*","/oauth/*","/api/v1/auths/reset/password","~*^/api/v1/users/logout/*"]}}]

dashscope/app/__init__.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 from .application import Application
 
 __all__ = [Application]

dashscope/app/application.py

@@ -1,19 +1,20 @@
-#!/usr/bin/env python3
+# Copyright (c) Alibaba, Inc. and its affiliates.
 """
 @File    :   application.py
 @Date    :   2024-02-24
 @Desc    :   Application calls for both http and http sse
 """
 import copy
-from typing import Generator, Union, List
+from typing import Generator, List, Union
 
 from dashscope.api_entities.api_request_factory import _build_api_request
+from dashscope.api_entities.dashscope_response import Message, Role
 from dashscope.app.application_response import ApplicationResponse
 from dashscope.client.base_api import BaseApi
 from dashscope.common.api_key import get_default_api_key
-from dashscope.common.constants import HISTORY, PROMPT, DEPRECATED_MESSAGE, MESSAGES
+from dashscope.common.constants import (DEPRECATED_MESSAGE, HISTORY, MESSAGES,
+                                        PROMPT)
 from dashscope.common.error import InputRequired, InvalidInput
-from dashscope.api_entities.dashscope_response import Message, Role
 from dashscope.common.logging import logger
 
 
@@ -23,7 +24,6 @@ class Application(BaseApi):
     """API for app completion calls.
 
     """
-
     class DocReferenceType:
         """ doc reference type for rag completion """
 
@@ -43,15 +43,16 @@ class Application(BaseApi):
 
     @classmethod
     def call(
-            cls,
-            app_id: str,
-            prompt: str = None,
-            history: list = None,
-            workspace: str = None,
-            api_key: str = None,
-            messages: List[Message] = None,
-            **kwargs
-    ) -> Union[ApplicationResponse, Generator[ApplicationResponse, None, None]]:
+        cls,
+        app_id: str,
+        prompt: str = None,
+        history: list = None,
+        workspace: str = None,
+        api_key: str = None,
+        messages: List[Message] = None,
+        **kwargs
+    ) -> Union[ApplicationResponse, Generator[ApplicationResponse, None,
+                                              None]]:
         """Call app completion service.
 
         Args:
@@ -119,7 +120,8 @@ class Application(BaseApi):
 
         api_key, app_id = Application._validate_params(api_key, app_id)
 
-        if (prompt is None or not prompt) and (messages is None or len(messages) == 0):
+        if (prompt is None or not prompt) and (messages is None
+                                               or len(messages) == 0):
             raise InputRequired('prompt or messages is required!')
 
         if workspace is not None and workspace:

dashscope/app/application_response.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python3
+# Copyright (c) Alibaba, Inc. and its affiliates.
 """
 @File    :   application_response.py
 @Date    :   2024-02-24

dashscope/assistants/__init__.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 # yapf: disable
 
 from dashscope.assistants.assistant_types import (Assistant, AssistantFile,

dashscope/assistants/assistant_types.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 # adapter from openai sdk
 from dataclasses import dataclass
 from typing import Dict, List, Optional, Union

dashscope/assistants/assistants.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 from typing import Dict, List, Optional
 
 from dashscope.assistants.assistant_types import (Assistant, AssistantList,