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

dashscope/api_entities/chat_completion_types.py

@@ -0,0 +1,344 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
+# adapter from openai sdk
+from dataclasses import dataclass
+from typing import List, Literal, Optional
+
+from dashscope.common.base_type import BaseObjectMixin
+
+
+@dataclass(init=False)
+class CompletionUsage(BaseObjectMixin):
+    completion_tokens: int
+    """Number of tokens in the generated completion."""
+
+    prompt_tokens: int
+    """Number of tokens in the prompt."""
+
+    total_tokens: int
+    """Total number of tokens used in the request (prompt + completion)."""
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+
+@dataclass(init=False)
+class TopLogprob(BaseObjectMixin):
+    token: str
+    """The token."""
+
+    bytes: Optional[List[int]] = None
+    """A list of integers representing the UTF-8 bytes representation of the token.
+
+    Useful in instances where characters are represented by multiple tokens and
+    their byte representations must be combined to generate the correct text
+    representation. Can be `null` if there is no bytes representation for the token.
+    """
+
+    logprob: float
+    """The log probability of this token, if it is within the top 20 most likely
+    tokens.
+
+    Otherwise, the value `-9999.0` is used to signify that the token is very
+    unlikely.
+    """
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+
+@dataclass(init=False)
+class ChatCompletionTokenLogprob(BaseObjectMixin):
+    token: str
+    """The token."""
+
+    bytes: Optional[List[int]] = None
+    """A list of integers representing the UTF-8 bytes representation of the token.
+
+    Useful in instances where characters are represented by multiple tokens and
+    their byte representations must be combined to generate the correct text
+    representation. Can be `null` if there is no bytes representation for the token.
+    """
+
+    logprob: float
+    """The log probability of this token, if it is within the top 20 most likely
+    tokens.
+
+    Otherwise, the value `-9999.0` is used to signify that the token is very
+    unlikely.
+    """
+
+    top_logprobs: List[TopLogprob]
+    """List of the most likely tokens and their log probability, at this token
+    position.
+
+    In rare cases, there may be fewer than the number of requested `top_logprobs`
+    returned.
+    """
+    def __init__(self, **kwargs):
+        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']:
+            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
+    """
+    The arguments to call the function with, as generated by the model in JSON
+    format. Note that the model does not always generate valid JSON, and may
+    hallucinate parameters not defined by your function schema. Validate the
+    arguments in your code before calling your function.
+    """
+
+    name: str
+    """The name of the function to call."""
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+
+@dataclass(init=False)
+class Function(BaseObjectMixin):
+    arguments: str
+    """
+    The arguments to call the function with, as generated by the model in JSON
+    format. Note that the model does not always generate valid JSON, and may
+    hallucinate parameters not defined by your function schema. Validate the
+    arguments in your code before calling your function.
+    """
+
+    name: str
+    """The name of the function to call."""
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+
+@dataclass(init=False)
+class ChatCompletionMessageToolCall(BaseObjectMixin):
+    id: str
+    """The ID of the tool call."""
+
+    function: Function
+    """The function that the model called."""
+
+    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']:
+            self.function = Function(**kwargs.pop('function', {}))
+        else:
+            self.function = None
+
+        super().__init__(**kwargs)
+
+
+@dataclass(init=False)
+class ChatCompletionMessage(BaseObjectMixin):
+    content: Optional[str] = None
+    """The contents of the message."""
+
+    role: Literal['assistant']
+    """The role of the author of this message."""
+
+    function_call: Optional[FunctionCall] = None
+    """Deprecated and replaced by `tool_calls`.
+
+    The name and arguments of a function that should be called, as generated by the
+    model.
+    """
+
+    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']:
+            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']
+    """The reason the model stopped generating tokens.
+
+    This will be `stop` if the model hit a natural stop point or a provided stop
+    sequence, `length` if the maximum number of tokens specified in the request was
+    reached, `content_filter` if content was omitted due to a flag from our content
+    filters, `tool_calls` if the model called a tool, or `function_call`
+    (deprecated) if the model called a function.
+    """
+
+    index: int
+    """The index of the choice in the list of choices."""
+
+    logprobs: Optional[ChoiceLogprobs] = None
+    """Log probability information for the choice."""
+
+    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']:
+            self.message = ChatCompletionMessage(**kwargs.pop('message', {}))
+        else:
+            self.message = None
+
+        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
+    """The call response status_code, 200 indicate create success.
+    """
+    code: str
+    """The request failed, this is the error code.
+    """
+    message: str
+    """The request failed, this is the error message.
+    """
+    id: str
+    """A unique identifier for the chat completion.
+    """
+    choices: List[Choice]
+    """A list of chat completion choices.
+
+    Can be more than one if `n` is greater than 1.
+    """
+
+    created: int
+    """The Unix timestamp (in seconds) of when the chat completion was created."""
+
+    model: str
+    """The model used for the chat completion."""
+
+    object: Literal['chat.completion']
+    """The object type, which is always `chat.completion`."""
+
+    system_fingerprint: Optional[str] = None
+    """This fingerprint represents the backend configuration that the model runs with.
+
+    Can be used in conjunction with the `seed` request parameter to understand when
+    backend changes have been made that might impact determinism.
+    """
+
+    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']:
+            self.usage = CompletionUsage(**kwargs.pop('usage', {}))
+        else:
+            self.usage = None
+
+        if 'choices' in kwargs and kwargs['choices'] is not None and kwargs[
+                'choices']:
+            choices = []
+            for choice in kwargs.pop('choices', []):
+                choices.append(Choice(**choice))
+            self.choices = choices
+        else:
+            self.choices = None
+        super().__init__(**kwargs)
+
+
+@dataclass(init=False)
+class ChatCompletionChunk(BaseObjectMixin):
+    status_code: int
+    """The call response status_code, 200 indicate create success.
+    """
+    code: str
+    """The request failed, this is the error code.
+    """
+    message: str
+    """The request failed, this is the error message.
+    """
+    id: str
+    """A unique identifier for the chat completion. Each chunk has the same ID."""
+
+    choices: List[Choice]
+    """A list of chat completion choices.
+
+    Can contain more than one elements if `n` is greater than 1. Can also be empty
+    for the last chunk if you set `stream_options: {"include_usage": true}`.
+    """
+
+    created: int
+    """The Unix timestamp (in seconds) of when the chat completion was created.
+
+    Each chunk has the same timestamp.
+    """
+
+    model: str
+    """The model to generate the completion."""
+
+    object: Literal['chat.completion.chunk']
+    """The object type, which is always `chat.completion.chunk`."""
+
+    system_fingerprint: Optional[str] = None
+    """
+    This fingerprint represents the backend configuration that the model runs with.
+    Can be used in conjunction with the `seed` request parameter to understand when
+    backend changes have been made that might impact determinism.
+    """
+
+    usage: Optional[CompletionUsage] = None
+    """
+    An optional field that will only be present when you set
+    `stream_options: {"include_usage": true}` in your request. When present, it
+    contains a null value except for the last chunk which contains the token usage
+    statistics for the entire request.
+    """
+    def __init__(self, **kwargs):
+        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']:
+            choices = []
+            for choice in kwargs.pop('choices', []):
+                choices.append(Choice(**choice))
+            self.choices = choices
+        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
@@ -620,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,

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,

dashscope/assistants/files.py

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

dashscope/audio/__init__.py

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

dashscope/audio/asr/__init__.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 from .asr_phrase_manager import AsrPhraseManager
 from .recognition import Recognition, RecognitionCallback, RecognitionResult
 from .transcription import Transcription

dashscope/audio/asr/asr_phrase_manager.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 from http import HTTPStatus
 from typing import Any, Dict
 

dashscope/audio/asr/recognition.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import json
 import os
 import threading

dashscope/audio/asr/transcription.py

@@ -1,8 +1,11 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import asyncio
 import time
 from typing import List, Union
 
 import aiohttp
+
 from dashscope.api_entities.dashscope_response import (DashScopeAPIResponse,
                                                        TranscriptionResponse)
 from dashscope.client.base_api import BaseAsyncApi

dashscope/audio/asr/translation_recognizer.py

@@ -1,3 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import json
 import os
 import threading

dashscope/audio/asr/vocabulary.py

@@ -1,8 +1,11 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
 import asyncio
 import time
 from typing import List
 
 import aiohttp
+
 from dashscope.client.base_api import BaseApi
 from dashscope.common.constants import ApiProtocol, HTTPMethod
 from dashscope.common.logging import logger

dashscope/audio/qwen_tts/__init__.py

@@ -0,0 +1,5 @@
+# Copyright (c) Alibaba, Inc. and its affiliates.
+
+from .speech_synthesizer import SpeechSynthesizer
+
+__all__ = [SpeechSynthesizer]