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

dashscope/__init__.py

@@ -1,11 +1,14 @@
 import logging
 from logging import NullHandler
 
+from dashscope.app.application import Application
 from dashscope.aigc.code_generation import CodeGeneration
 from dashscope.aigc.conversation import Conversation, History, HistoryItem
 from dashscope.aigc.generation import Generation
 from dashscope.aigc.image_synthesis import ImageSynthesis
 from dashscope.aigc.multimodal_conversation import MultiModalConversation
+from dashscope.assistants import Assistant, AssistantList, Assistants
+from dashscope.assistants.assistant_types import AssistantFile, DeleteResponse
 from dashscope.audio.asr.transcription import Transcription
 from dashscope.audio.tts.speech_synthesizer import SpeechSynthesizer
 from dashscope.common.api_key import save_api_key
@@ -19,23 +22,67 @@ from dashscope.embeddings.multimodal_embedding import (
     MultiModalEmbedding, MultiModalEmbeddingItemAudio,
     MultiModalEmbeddingItemImage, MultiModalEmbeddingItemText)
 from dashscope.embeddings.text_embedding import TextEmbedding
-from dashscope.file import File
+from dashscope.files import Files
 from dashscope.finetune import FineTune
 from dashscope.model import Model
 from dashscope.nlp.understanding import Understanding
+from dashscope.rerank.text_rerank import TextReRank
+from dashscope.threads import (MessageFile, Messages, Run, RunList, Runs,
+                               RunStep, RunStepList, Steps, Thread,
+                               ThreadMessage, ThreadMessageList, Threads)
 from dashscope.tokenizers import (Tokenization, Tokenizer, get_tokenizer,
                                   list_tokenizers)
-from dashscope.app.application import Application
 
 __all__ = [
-    base_http_api_url, base_websocket_api_url, api_key, api_key_file_path,
-    save_api_key, Conversation, Generation, History, HistoryItem,
-    ImageSynthesis, Transcription, File, Deployment, FineTune, Model,
-    TextEmbedding, MultiModalEmbedding, MultiModalEmbeddingItemAudio,
-    MultiModalEmbeddingItemImage, MultiModalEmbeddingItemText,
-    SpeechSynthesizer, MultiModalConversation, BatchTextEmbedding,
-    BatchTextEmbeddingResponse, Understanding, CodeGeneration, Tokenization,
-    Tokenizer, get_tokenizer, list_tokenizers, Application
+    base_http_api_url,
+    base_websocket_api_url,
+    api_key,
+    api_key_file_path,
+    save_api_key,
+    Conversation,
+    Generation,
+    History,
+    HistoryItem,
+    ImageSynthesis,
+    Transcription,
+    Files,
+    Deployment,
+    FineTune,
+    Model,
+    TextEmbedding,
+    MultiModalEmbedding,
+    MultiModalEmbeddingItemAudio,
+    MultiModalEmbeddingItemImage,
+    MultiModalEmbeddingItemText,
+    SpeechSynthesizer,
+    MultiModalConversation,
+    BatchTextEmbedding,
+    BatchTextEmbeddingResponse,
+    Understanding,
+    CodeGeneration,
+    Tokenization,
+    Tokenizer,
+    get_tokenizer,
+    list_tokenizers,
+    Application,
+    TextReRank,
+    Assistants,
+    Threads,
+    Messages,
+    Runs,
+    Assistant,
+    ThreadMessage,
+    Run,
+    Steps,
+    AssistantList,
+    ThreadMessageList,
+    RunList,
+    RunStepList,
+    Thread,
+    DeleteResponse,
+    RunStep,
+    MessageFile,
+    AssistantFile,
 ]
 
 logging.getLogger(__name__).addHandler(NullHandler())

dashscope/aigc/code_generation.py

@@ -68,6 +68,7 @@ class CodeGeneration(BaseApi):
         scene: str = None,
         api_key: str = None,
         message: List[MessageParam] = None,
+        workspace: str = None,
         **kwargs
     ) -> Union[DashScopeAPIResponse, Generator[DashScopeAPIResponse, None,
                                                None]]:
@@ -89,23 +90,24 @@ class CodeGeneration(BaseApi):
                 if None, will get by default rule(TODO: api key doc).
             message (list): The generation messages.
                 scene == custom, examples:
-                    [{"role": "user", "content": "根据下面的功能描述生成一个python函数。代码的功能是计算给定路径下所有文件的总大小。"}]
+                    [{"role": "user", "content": "根据下面的功能描述生成一个python函数。代码的功能是计算给定路径下所有文件的总大小。"}]  # noqa E501
                 scene == nl2code, examples:
-                    [{"role": "user", "content": "计算给定路径下所有文件的总大小"}, {"role": "attachment", "meta": {"language": "java"}}]
+                    [{"role": "user", "content": "计算给定路径下所有文件的总大小"}, {"role": "attachment", "meta": {"language": "java"}}]  # noqa E501
                 scene == code2comment, examples:
-                    [{"role": "user", "content": "1. 生成中文注释\n2. 仅生成代码部分，不需要额外解释函数功能\n"}, {"role": "attachment", "meta": {"code": "\t\t@Override\n\t\tpublic  CancelExportTaskResponse  cancelExportTask(\n\t\t\t\tCancelExportTask  cancelExportTask)  {\n\t\t\tAmazonEC2SkeletonInterface  ec2Service  =  ServiceProvider.getInstance().getServiceImpl(AmazonEC2SkeletonInterface.class);\n\t\t\treturn  ec2Service.cancelExportTask(cancelExportTask);\n\t\t}", "language": "java"}}]
+                    [{"role": "user", "content": "1. 生成中文注释\n2. 仅生成代码部分，不需要额外解释函数功能\n"}, {"role": "attachment", "meta": {"code": "\t\t@Override\n\t\tpublic  CancelExportTaskResponse  cancelExportTask(\n\t\t\t\tCancelExportTask  cancelExportTask)  {\n\t\t\tAmazonEC2SkeletonInterface  ec2Service  =  ServiceProvider.getInstance().getServiceImpl(AmazonEC2SkeletonInterface.class);\n\t\t\treturn  ec2Service.cancelExportTask(cancelExportTask);\n\t\t}", "language": "java"}}]  # noqa E501
                 scene == code2explain, examples:
-                    [{"role": "user", "content": "要求不低于200字"}, {"role": "attachment", "meta": {"code": "@Override\n                                public  int  getHeaderCacheSize()\n                                {\n                                        return  0;\n                                }\n\n", "language": "java"}}]
+                    [{"role": "user", "content": "要求不低于200字"}, {"role": "attachment", "meta": {"code": "@Override\n                                public  int  getHeaderCacheSize()\n                                {\n                                        return  0;\n                                }\n\n", "language": "java"}}]  # noqa E501
                 scene == commit2msg, examples:
-                    [{"role": "attachment", "meta": {"diff_list": [{"diff": "--- src/com/siondream/core/PlatformResolver.java\n+++ src/com/siondream/core/PlatformResolver.java\n@@ -1,11 +1,8 @@\npackage com.siondream.core;\n-\n-import com.badlogic.gdx.files.FileHandle;\n\npublic interface PlatformResolver {\npublic void openURL(String url);\npublic void rateApp();\npublic void sendFeedback();\n-\tpublic FileHandle[] listFolder(String path);\n}\n", "old_file_path": "src/com/siondream/core/PlatformResolver.java", "new_file_path": "src/com/siondream/core/PlatformResolver.java"}]}}]
+                    [{"role": "attachment", "meta": {"diff_list": [{"diff": "--- src/com/siondream/core/PlatformResolver.java\n+++ src/com/siondream/core/PlatformResolver.java\n@@ -1,11 +1,8 @@\npackage com.siondream.core;\n-\n-import com.badlogic.gdx.files.FileHandle;\n\npublic interface PlatformResolver {\npublic void openURL(String url);\npublic void rateApp();\npublic void sendFeedback();\n-\tpublic FileHandle[] listFolder(String path);\n}\n", "old_file_path": "src/com/siondream/core/PlatformResolver.java", "new_file_path": "src/com/siondream/core/PlatformResolver.java"}]}}]  # noqa E501
                 scene == unittest, examples:
-                    [{"role": "attachment", "meta": {"code": "public static <T> TimestampMap<T> parseTimestampMap(Class<T> typeClass, String input, DateTimeZone timeZone) throws IllegalArgumentException {\n        if (typeClass == null) {\n            throw new IllegalArgumentException(\"typeClass required\");\n        }\n\n        if (input == null) {\n            return null;\n        }\n\n        TimestampMap result;\n\n        typeClass = AttributeUtils.getStandardizedType(typeClass);\n        if (typeClass.equals(String.class)) {\n            result = new TimestampStringMap();\n        } else if (typeClass.equals(Byte.class)) {\n            result = new TimestampByteMap();\n        } else if (typeClass.equals(Short.class)) {\n            result = new TimestampShortMap();\n        } else if (typeClass.equals(Integer.class)) {\n            result = new TimestampIntegerMap();\n        } else if (typeClass.equals(Long.class)) {\n            result = new TimestampLongMap();\n        } else if (typeClass.equals(Float.class)) {\n            result = new TimestampFloatMap();\n        } else if (typeClass.equals(Double.class)) {\n            result = new TimestampDoubleMap();\n        } else if (typeClass.equals(Boolean.class)) {\n            result = new TimestampBooleanMap();\n        } else if (typeClass.equals(Character.class)) {\n            result = new TimestampCharMap();\n        } else {\n            throw new IllegalArgumentException(\"Unsupported type \" + typeClass.getClass().getCanonicalName());\n        }\n\n        if (input.equalsIgnoreCase(EMPTY_VALUE)) {\n            return result;\n        }\n\n        StringReader reader = new StringReader(input + ' ');// Add 1 space so\n                                                            // reader.skip\n                                                            // function always\n                                                            // works when\n                                                            // necessary (end of\n                                                            // string not\n                                                            // reached).\n\n        try {\n            int r;\n            char c;\n            while ((r = reader.read()) != -1) {\n                c = (char) r;\n                switch (c) {\n                    case LEFT_BOUND_SQUARE_BRACKET:\n                    case LEFT_BOUND_BRACKET:\n                        parseTimestampAndValue(typeClass, reader, result, timeZone);\n                        break;\n                    default:\n                        // Ignore other chars outside of bounds\n                }\n            }\n        } catch (IOException ex) {\n            throw new RuntimeException(\"Unexpected expection while parsing timestamps\", ex);\n        }\n\n        return result;\n    }", "language": "java"}}]
+                    [{"role": "attachment", "meta": {"code": "public static <T> TimestampMap<T> parseTimestampMap(Class<T> typeClass, String input, DateTimeZone timeZone) throws IllegalArgumentException {\n        if (typeClass == null) {\n            throw new IllegalArgumentException(\"typeClass required\");\n        }\n\n        if (input == null) {\n            return null;\n        }\n\n        TimestampMap result;\n\n        typeClass = AttributeUtils.getStandardizedType(typeClass);\n        if (typeClass.equals(String.class)) {\n            result = new TimestampStringMap();\n        } else if (typeClass.equals(Byte.class)) {\n            result = new TimestampByteMap();\n        } else if (typeClass.equals(Short.class)) {\n            result = new TimestampShortMap();\n        } else if (typeClass.equals(Integer.class)) {\n            result = new TimestampIntegerMap();\n        } else if (typeClass.equals(Long.class)) {\n            result = new TimestampLongMap();\n        } else if (typeClass.equals(Float.class)) {\n            result = new TimestampFloatMap();\n        } else if (typeClass.equals(Double.class)) {\n            result = new TimestampDoubleMap();\n        } else if (typeClass.equals(Boolean.class)) {\n            result = new TimestampBooleanMap();\n        } else if (typeClass.equals(Character.class)) {\n            result = new TimestampCharMap();\n        } else {\n            throw new IllegalArgumentException(\"Unsupported type \" + typeClass.getClass().getCanonicalName());\n        }\n\n        if (input.equalsIgnoreCase(EMPTY_VALUE)) {\n            return result;\n        }\n\n        StringReader reader = new StringReader(input + ' ');// Add 1 space so\n                                                            // reader.skip\n                                                            // function always\n                                                            // works when\n                                                            // necessary (end of\n                                                            // string not\n                                                            // reached).\n\n        try {\n            int r;\n            char c;\n            while ((r = reader.read()) != -1) {\n                c = (char) r;\n                switch (c) {\n                    case LEFT_BOUND_SQUARE_BRACKET:\n                    case LEFT_BOUND_BRACKET:\n                        parseTimestampAndValue(typeClass, reader, result, timeZone);\n                        break;\n                    default:\n                        // Ignore other chars outside of bounds\n                }\n            }\n        } catch (IOException ex) {\n            throw new RuntimeException(\"Unexpected expection while parsing timestamps\", ex);\n        }\n\n        return result;\n    }", "language": "java"}}]  # noqa E501
                 scene == codeqa, examples:
-                    [{"role": "user", "content": "I'm writing a small web server in Python, using BaseHTTPServer and a custom subclass of BaseHTTPServer.BaseHTTPRequestHandler. Is it possible to make this listen on more than one port?\nWhat I'm doing now:\nclass MyRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):\n  def doGET\n  [...]\n\nclass ThreadingHTTPServer(ThreadingMixIn, HTTPServer): \n    pass\n\nserver = ThreadingHTTPServer(('localhost', 80), MyRequestHandler)\nserver.serve_forever()"}]
+                    [{"role": "user", "content": "I'm writing a small web server in Python, using BaseHTTPServer and a custom subclass of BaseHTTPServer.BaseHTTPRequestHandler. Is it possible to make this listen on more than one port?\nWhat I'm doing now:\nclass MyRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):\n  def doGET\n  [...]\n\nclass ThreadingHTTPServer(ThreadingMixIn, HTTPServer): \n    pass\n\nserver = ThreadingHTTPServer(('localhost', 80), MyRequestHandler)\nserver.serve_forever()"}]  # noqa E501
                 scene == nl2sql, examples:
-                    [{"role": "user", "content": "小明的总分数是多少"}, {"role": "attachment", "meta": {"synonym_infos": {"学生姓名": "姓名|名字|名称", "学生分数": "分数|得分"}, "recall_infos": [{"content": "student_score.id='小明'", "score": "0.83"}], "schema_infos": [{"table_id": "student_score", "table_desc": "学生分数表", "columns": [{"col_name": "id", "col_caption": "学生id", "col_desc": "例值为:1,2,3", "col_type": "string"}, {"col_name": "name", "col_caption": "学生姓名", "col_desc": "例值为:张三,李四,小明", "col_type": "string"}, {"col_name": "score", "col_caption": "学生分数", "col_desc": "例值为:98,100,66", "col_type": "string"}]}]}}]
+                    [{"role": "user", "content": "小明的总分数是多少"}, {"role": "attachment", "meta": {"synonym_infos": {"学生姓名": "姓名|名字|名称", "学生分数": "分数|得分"}, "recall_infos": [{"content": "student_score.id='小明'", "score": "0.83"}], "schema_infos": [{"table_id": "student_score", "table_desc": "学生分数表", "columns": [{"col_name": "id", "col_caption": "学生id", "col_desc": "例值为:1,2,3", "col_type": "string"}, {"col_name": "name", "col_caption": "学生姓名", "col_desc": "例值为:张三,李四,小明", "col_type": "string"}, {"col_name": "score", "col_caption": "学生分数", "col_desc": "例值为:98,100,66", "col_type": "string"}]}]}}]  # noqa E501
+            workspace (str): The dashscope workspace id.
             **kwargs:
-                n(int, `optional`): The number of output results, currently only supports 1, with a default value of 1
+                n(int, `optional`): The number of output results, currently only supports 1, with a default value of 1  # noqa E501
 
         Returns:
             Union[DashScopeAPIResponse,
@@ -125,6 +127,7 @@ class CodeGeneration(BaseApi):
                                 function=CodeGeneration.function,
                                 api_key=api_key,
                                 input=input,
+                                workspace=workspace,
                                 **parameters)
 
         is_stream = kwargs.get('stream', False)

dashscope/aigc/conversation.py

@@ -127,6 +127,7 @@ class Conversation(BaseApi):
         api_key: str = None,
         messages: List[Message] = None,
         plugins: Union[str, Dict[str, Any]] = None,
+        workspace: str = None,
         **kwargs
     ) -> Union[ConversationResponse, Generator[ConversationResponse, None,
                                                None]]:
@@ -203,6 +204,7 @@ class Conversation(BaseApi):
                 repetition_penalty(float, `optional`): Used to control the repeatability when generating models.  # noqa E501
                     Increasing repetition_penalty can reduce the duplication of model generation.  # noqa E501
                     1.0 means no punishment.
+            workspace (str): The dashscope workspace id.
         Raises:
             InputRequired: The prompt cannot be empty.
             InvalidInput: The history and auto_history are mutually exclusive.
@@ -235,6 +237,7 @@ class Conversation(BaseApi):
                                 function='generation',
                                 api_key=api_key,
                                 input=input,
+                                workspace=workspace,
                                 **parameters)
         is_stream = kwargs.get('stream', False)
         return self._handle_response(prompt, response, is_stream)

dashscope/aigc/generation.py

@@ -39,6 +39,7 @@ class Generation(BaseApi):
         api_key: str = None,
         messages: List[Message] = None,
         plugins: Union[str, Dict[str, Any]] = None,
+        workspace: str = None,
         **kwargs
     ) -> Union[GenerationResponse, Generator[GenerationResponse, None, None]]:
         """Call generation model service.
@@ -110,6 +111,7 @@ class Generation(BaseApi):
                 repetition_penalty(float, `optional`): Used to control the repeatability when generating models.  # noqa E501
                     Increasing repetition_penalty can reduce the duplication of model generation.  # noqa E501
                     1.0 means no punishment.
+            workspace (str): The dashscope workspace id.
         Raises:
             InvalidInput: The history and auto_history are mutually exclusive.
 
@@ -139,6 +141,7 @@ class Generation(BaseApi):
                                 function=function,
                                 api_key=api_key,
                                 input=input,
+                                workspace=workspace,
                                 **parameters)
         is_stream = kwargs.get('stream', False)
         if is_stream:

dashscope/aigc/image_synthesis.py

@@ -24,6 +24,7 @@ class ImageSynthesis(BaseAsyncApi):
              images: List[str] = None,
              api_key: str = None,
              sketch_image_url: str = None,
+             workspace: str = None,
              **kwargs) -> ImageSynthesisResponse:
         """Call image(s) synthesis service and get result.
 
@@ -36,6 +37,7 @@ class ImageSynthesis(BaseAsyncApi):
             api_key (str, optional): The api api_key. Defaults to None.
             sketch_image_url (str, optional): Only for wanx-sketch-to-image-v1.
                 Defaults to None.
+            workspace (str): The dashscope workspace id.
             **kwargs:
                 n(int, `optional`): Number of images to synthesis.
                 size(str, `optional`): The output image(s) size(width*height).
@@ -59,6 +61,7 @@ class ImageSynthesis(BaseAsyncApi):
                             images,
                             api_key=api_key,
                             sketch_image_url=sketch_image_url,
+                            workspace=workspace,
                             **kwargs)
 
     @classmethod
@@ -69,6 +72,7 @@ class ImageSynthesis(BaseAsyncApi):
                    images: List[str] = None,
                    api_key: str = None,
                    sketch_image_url: str = None,
+                   workspace: str = None,
                    **kwargs) -> ImageSynthesisResponse:
         """Create a image(s) synthesis task, and return task information.
 
@@ -80,6 +84,7 @@ class ImageSynthesis(BaseAsyncApi):
             api_key (str, optional): The api api_key. Defaults to None.
             sketch_image_url (str, optional): Only for wanx-sketch-to-image-v1.
                 Defaults to None.
+            workspace (str): The dashscope workspace id.
             **kwargs(wanx-v1):
                 n(int, `optional`): Number of images to synthesis.
                 size: The output image(s) size, Default 1024*1024
@@ -114,47 +119,53 @@ class ImageSynthesis(BaseAsyncApi):
                                       function=function,
                                       api_key=api_key,
                                       input=input,
+                                      workspace=workspace,
                                       **kwargs)
         return ImageSynthesisResponse.from_api_response(response)
 
     @classmethod
     def fetch(cls,
               task: Union[str, ImageSynthesisResponse],
-              api_key: str = None) -> ImageSynthesisResponse:
+              api_key: str = None,
+              workspace: str = None) -> ImageSynthesisResponse:
         """Fetch image(s) synthesis task status or result.
 
         Args:
             task (Union[str, ImageSynthesisResponse]): The task_id or
                 ImageSynthesisResponse return by async_call().
             api_key (str, optional): The api api_key. Defaults to None.
+            workspace (str): The dashscope workspace id.
 
         Returns:
             ImageSynthesisResponse: The task status or result.
         """
-        response = super().fetch(task, api_key)
+        response = super().fetch(task, api_key=api_key, workspace=workspace)
         return ImageSynthesisResponse.from_api_response(response)
 
     @classmethod
     def wait(cls,
              task: Union[str, ImageSynthesisResponse],
-             api_key: str = None) -> ImageSynthesisResponse:
+             api_key: str = None,
+             workspace: str = None) -> ImageSynthesisResponse:
         """Wait for image(s) synthesis task to complete, and return the result.
 
         Args:
             task (Union[str, ImageSynthesisResponse]): The task_id or
                 ImageSynthesisResponse return by async_call().
             api_key (str, optional): The api api_key. Defaults to None.
+            workspace (str): The dashscope workspace id.
 
         Returns:
             ImageSynthesisResponse: The task result.
         """
-        response = super().wait(task, api_key)
+        response = super().wait(task, api_key, workspace=workspace)
         return ImageSynthesisResponse.from_api_response(response)
 
     @classmethod
     def cancel(cls,
                task: Union[str, ImageSynthesisResponse],
-               api_key: str = None) -> DashScopeAPIResponse:
+               api_key: str = None,
+               workspace: str = None) -> DashScopeAPIResponse:
         """Cancel image synthesis task.
         Only tasks whose status is PENDING can be canceled.
 
@@ -162,11 +173,12 @@ class ImageSynthesis(BaseAsyncApi):
             task (Union[str, ImageSynthesisResponse]): The task_id or
                 ImageSynthesisResponse 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)
+        return super().cancel(task, api_key, workspace=workspace)
 
     @classmethod
     def list(cls,
@@ -179,6 +191,7 @@ class ImageSynthesis(BaseAsyncApi):
              page_no: int = 1,
              page_size: int = 10,
              api_key: str = None,
+             workspace: str = None,
              **kwargs) -> DashScopeAPIResponse:
         """List async tasks.
 
@@ -196,6 +209,7 @@ class ImageSynthesis(BaseAsyncApi):
             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.
@@ -209,4 +223,5 @@ class ImageSynthesis(BaseAsyncApi):
                             page_no=page_no,
                             page_size=page_size,
                             api_key=api_key,
+                            workspace=workspace,
                             **kwargs)

dashscope/aigc/multimodal_conversation.py

@@ -24,6 +24,7 @@ class MultiModalConversation(BaseApi):
         model: str,
         messages: List,
         api_key: str = None,
+        workspace: str = None,
         **kwargs
     ) -> Union[MultiModalConversationResponse, Generator[
             MultiModalConversationResponse, None, None]]:
@@ -51,6 +52,7 @@ class MultiModalConversation(BaseApi):
             api_key (str, optional): The api api_key, can be None,
                 if None, will retrieve by rule [1].
                 [1]: https://help.aliyun.com/zh/dashscope/developer-reference/api-key-settings. # noqa E501
+            workspace (str): The dashscope workspace id.
             **kwargs:
                 stream(bool, `optional`): Enable server-sent events
                     (ref: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)  # noqa E501
@@ -92,6 +94,7 @@ class MultiModalConversation(BaseApi):
                                 function=MultiModalConversation.function,
                                 api_key=api_key,
                                 input=input,
+                                workspace=workspace,
                                 **kwargs)
         is_stream = kwargs.get('stream', False)
         if is_stream:

dashscope/api_entities/aiohttp_request.py

@@ -2,6 +2,7 @@ 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_factory.py

@@ -24,22 +24,33 @@ def _get_protocol_params(kwargs):
     request_timeout = kwargs.pop(REQUEST_TIMEOUT_KEYWORD, None)
     form = kwargs.pop('form', None)
     resources = kwargs.pop('resources', None)
+    base_address = kwargs.pop('base_address', None)
+    flattened_output = kwargs.pop('flattened_output', False)
     return (api_protocol, ws_stream_mode, is_binary_input, http_method, stream,
-            async_request, query, headers, request_timeout, form, resources)
+            async_request, query, headers, request_timeout, form, resources,
+            base_address, flattened_output)
 
 
-def _build_api_request(model: str, input: object, task_group: str, task: str,
-                       function: str, api_key: str, is_service=True, **kwargs):
+def _build_api_request(model: str,
+                       input: object,
+                       task_group: str,
+                       task: str,
+                       function: str,
+                       api_key: str,
+                       is_service=True,
+                       **kwargs):
     (api_protocol, ws_stream_mode, is_binary_input, http_method, stream,
-     async_request, query, headers, request_timeout, form,
-     resources) = _get_protocol_params(kwargs)
+     async_request, query, headers, request_timeout, form, resources,
+     base_address, flattened_output) = _get_protocol_params(kwargs)
     task_id = kwargs.pop('task_id', None)
     if api_protocol in [ApiProtocol.HTTP, ApiProtocol.HTTPS]:
-        if not dashscope.base_http_api_url.endswith('/'):
-            http_url = dashscope.base_http_api_url + '/'
+        if base_address is None:
+            base_address = dashscope.base_http_api_url
+        if not base_address.endswith('/'):
+            http_url = base_address + '/'
         else:
-            http_url = dashscope.base_http_api_url    
-   
+            http_url = base_address
+
         if is_service:
             http_url = http_url + SERVICE_API_PATH + '/'
 
@@ -56,15 +67,20 @@ def _build_api_request(model: str, input: object, task_group: str, task: str,
                               async_request=async_request,
                               query=query,
                               timeout=request_timeout,
-                              task_id=task_id)
+                              task_id=task_id,
+                              flattened_output=flattened_output)
     elif api_protocol == ApiProtocol.WEBSOCKET:
-        websocket_url = dashscope.base_websocket_api_url
+        if base_address is not None:
+            websocket_url = base_address
+        else:
+            websocket_url = dashscope.base_websocket_api_url
         request = WebSocketRequest(url=websocket_url,
                                    api_key=api_key,
                                    stream=stream,
                                    ws_stream_mode=ws_stream_mode,
                                    is_binary_input=is_binary_input,
-                                   timeout=request_timeout)
+                                   timeout=request_timeout,
+                                   flattened_output=flattened_output)
     else:
         raise UnsupportedApiProtocol(
             'Unsupported protocol: %s, support [http, https, websocket]' %

dashscope/api_entities/dashscope_response.py

@@ -493,3 +493,66 @@ class ImageSynthesisResponse(DashScopeAPIResponse):
                                           request_id=api_response.request_id,
                                           code=api_response.code,
                                           message=api_response.message)
+
+
+@dataclass(init=False)
+class ReRankResult(DictMixin):
+    index: int
+    relevance_score: float
+    document: Dict = None
+
+    def __init__(self,
+                 index: int,
+                 relevance_score: float,
+                 document: Dict = None,
+                 **kwargs):
+        super().__init__(index=index,
+                         relevance_score=relevance_score,
+                         document=document,
+                         **kwargs)
+
+
+@dataclass(init=False)
+class ReRankOutput(DictMixin):
+    results: List[ReRankResult]
+
+    def __init__(self, results: List[ReRankResult] = None, **kwargs):
+        ress = None
+        if results is not None:
+            ress = []
+            for res in results:
+                ress.append(ReRankResult(**res))
+        super().__init__(results=ress, **kwargs)
+
+
+@dataclass(init=False)
+class ReRankUsage(DictMixin):
+    total_tokens: int
+
+    def __init__(self, total_tokens=None, **kwargs):
+        super().__init__(total_tokens=total_tokens, **kwargs)
+
+
+@dataclass(init=False)
+class ReRankResponse(DashScopeAPIResponse):
+    output: ReRankOutput
+    usage: GenerationUsage
+
+    @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 ReRankResponse(status_code=api_response.status_code,
+                                  request_id=api_response.request_id,
+                                  code=api_response.code,
+                                  message=api_response.message,
+                                  output=ReRankOutput(**api_response.output),
+                                  usage=ReRankUsage(**usage))
+        else:
+            return ReRankResponse(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

@@ -2,6 +2,7 @@ import json
 from http import HTTPStatus
 
 import requests
+
 from dashscope.api_entities.base_request import BaseRequest
 from dashscope.api_entities.dashscope_response import DashScopeAPIResponse
 from dashscope.common.constants import (DEFAULT_REQUEST_TIMEOUT_SECONDS,
@@ -19,7 +20,8 @@ class HttpRequest(BaseRequest):
                  async_request: bool = False,
                  query: bool = False,
                  timeout: int = DEFAULT_REQUEST_TIMEOUT_SECONDS,
-                 task_id: str = None) -> None:
+                 task_id: str = None,
+                 flattened_output: bool = False) -> None:
         """HttpSSERequest, processing http server sent event stream.
 
         Args:
@@ -33,6 +35,7 @@ class HttpRequest(BaseRequest):
 
         super().__init__()
         self.url = url
+        self.flattened_output = flattened_output
         self.async_request = async_request
         self.headers = {
             'Accept': 'application/json',
@@ -137,10 +140,13 @@ class HttpRequest(BaseRequest):
                         message=msg['message']
                         if 'message' in msg else None)  # noqa E501
                 else:
-                    yield DashScopeAPIResponse(request_id=request_id,
-                                               status_code=HTTPStatus.OK,
-                                               output=output,
-                                               usage=usage)
+                    if self.flattened_output:
+                        yield msg
+                    else:
+                        yield DashScopeAPIResponse(request_id=request_id,
+                                                   status_code=HTTPStatus.OK,
+                                                   output=output,
+                                                   usage=usage)
         elif response.status_code == HTTPStatus.OK:
             json_content = response.json()
             logger.debug('Response: %s' % json_content)
@@ -154,10 +160,13 @@ class HttpRequest(BaseRequest):
                 usage = json_content['usage']
             if 'request_id' in json_content:
                 request_id = json_content['request_id']
-            yield DashScopeAPIResponse(request_id=request_id,
-                                       status_code=HTTPStatus.OK,
-                                       output=output,
-                                       usage=usage)
+            if self.flattened_output:
+                yield json_content
+            else:
+                yield DashScopeAPIResponse(request_id=request_id,
+                                           status_code=HTTPStatus.OK,
+                                           output=output,
+                                           usage=usage)
         else:
             if 'application/json' in response.headers.get('content-type', ''):
                 error = response.json()

dashscope/api_entities/websocket_request.py

@@ -5,6 +5,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,
@@ -29,6 +30,7 @@ class WebSocketRequest(AioBaseRequest):
         ws_stream_mode: str = WebsocketStreamingMode.OUT,
         is_binary_input: bool = False,
         timeout: int = DEFAULT_REQUEST_TIMEOUT_SECONDS,
+        flattened_output: bool = False,
     ) -> None:
         super().__init__()
         """HttpRequest.
@@ -43,6 +45,7 @@ class WebSocketRequest(AioBaseRequest):
         """
         self.url = url
         self.stream = stream
+        self.flattened_output = flattened_output
         if timeout is None:
             self.timeout = DEFAULT_REQUEST_TIMEOUT_SECONDS
         else: