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

dashscope/__init__.py

@@ -6,6 +6,7 @@ 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.app.application import Application
 from dashscope.audio.asr.transcription import Transcription
 from dashscope.audio.tts.speech_synthesizer import SpeechSynthesizer
 from dashscope.common.api_key import save_api_key
@@ -23,19 +24,43 @@ from dashscope.file import File
 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.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,
+    File,
+    Deployment,
+    FineTune,
+    Model,
+    TextEmbedding,
+    MultiModalEmbedding,
+    MultiModalEmbeddingItemAudio,
+    MultiModalEmbeddingItemImage,
+    MultiModalEmbeddingItemText,
+    SpeechSynthesizer,
+    MultiModalConversation,
+    BatchTextEmbedding,
+    BatchTextEmbeddingResponse,
+    Understanding,
+    CodeGeneration,
+    Tokenization,
+    Tokenizer,
+    get_tokenizer,
+    list_tokenizers,
+    Application,
+    TextReRank,
 ]
 
 logging.getLogger(__name__).addHandler(NullHandler())

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/rerank/text_rerank.py

@@ -0,0 +1,67 @@
+from typing import List
+
+from dashscope.api_entities.dashscope_response import ReRankResponse
+from dashscope.client.base_api import BaseApi
+from dashscope.common.error import InputRequired, ModelRequired
+from dashscope.common.utils import _get_task_group_and_task
+
+
+class TextReRank(BaseApi):
+    task = 'text-rerank'
+    """API for rerank models.
+
+    """
+    class Models:
+        gte_rerank = 'gte-rerank'
+
+    @classmethod
+    def call(cls,
+             model: str,
+             query: str,
+             documents: List[str],
+             return_documents: bool = None,
+             top_n: int = None,
+             api_key: str = None,
+             **kwargs) -> ReRankResponse:
+        """Calling rerank service.
+
+        Args:
+            model (str): The model to use.
+            query (str): The query string.
+            documents (List[str]): The documents to rank.
+            return_documents(bool, `optional`): enable return origin documents,
+                system default is false.
+            top_n(int, `optional`): how many documents to return, default return
+                all the documents.
+            api_key (str, optional): The DashScope api key. Defaults to None.
+
+        Raises:
+            InputRequired: The query and documents are required.
+            ModelRequired: The model is required.
+
+        Returns:
+            RerankResponse: The rerank result.
+        """
+
+        if query is None or documents is None or not documents:
+            raise InputRequired('query and documents are required!')
+        if model is None or not model:
+            raise ModelRequired('Model is required!')
+        task_group, function = _get_task_group_and_task(__name__)
+        input = {'query': query, 'documents': documents}
+        parameters = {}
+        if return_documents is not None:
+            parameters['return_documents'] = return_documents
+        if top_n is not None:
+            parameters['top_n'] = top_n
+        parameters = {**parameters, **kwargs}
+
+        response = super().call(model=model,
+                                task_group=task_group,
+                                task=TextReRank.task,
+                                function=function,
+                                api_key=api_key,
+                                input=input,
+                                **parameters)
+
+        return ReRankResponse.from_api_response(response)

dashscope/version.py

@@ -1 +1 @@
-__version__ = '1.15.0'
+__version__ = '1.16.0'

{dashscope-1.15.0.dist-info → dashscope-1.16.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dashscope
-Version: 1.15.0
+Version: 1.16.0
 Summary: dashscope client sdk library
 Home-page: https://dashscope.aliyun.com/
 Author: Alibaba Cloud

{dashscope-1.15.0.dist-info → dashscope-1.16.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
-dashscope/__init__.py,sha256=zochMrwoyyQyf62XbUZaFhFpkIwULQCSNHCd2lcb7pY,2081
+dashscope/__init__.py,sha256=d8I_67Tz2SZ2QQl5ApZQce86c3EM3obx9bQPtlvR_c8,2242
 dashscope/cli.py,sha256=7CnUZqaaUc0FxbmXHMiqOALl9YzZmSrFS23A7hbR0w0,23917
 dashscope/deployment.py,sha256=uhlQYOiu1baMQxQnFmRwI6ces0I-_DKp8uej_L0v1eY,4400
 dashscope/file.py,sha256=Dv2Fz3DLbcye2uuQxyQwRM7ky27OthouLXIpSQagQy4,3324
 dashscope/finetune.py,sha256=5QlIcnFCfSjN3gn9A2FO0kLUDa9Rx_jSc44ezT3aBEo,5118
 dashscope/model.py,sha256=iuIfal-vOo0yav0HXPdA7f93vd5JNTGIAdCG_WIYkW8,1158
-dashscope/version.py,sha256=qiatipDCHB37xXqNBOc2sezBvX8WXTRFhAGZHwi0CXc,23
+dashscope/version.py,sha256=VqyRgjiBsROG0SjVyQSaBPufjG1-xO7kqvhm7iGUJGA,23
 dashscope/aigc/__init__.py,sha256=s-MCA87KYiVumYtKtJi5IMN7xelSF6TqEU3s3_7RF-Y,327
 dashscope/aigc/code_generation.py,sha256=bizJb3zGZx3pB74FKMIcnOi_6jkxpKgx__6urzqhQ_E,10627
 dashscope/aigc/conversation.py,sha256=_sAWhQjLgJENqRAXh-i2dw8bt_i69fJv9KZYVIi4CEg,14090
@@ -16,7 +16,7 @@ dashscope/api_entities/aiohttp_request.py,sha256=ZFbdpJh7SwHnBzbYLhqr_FdcDVRgLVM
 dashscope/api_entities/api_request_data.py,sha256=JUMcfpJjKXEZLCBSFIDpgoaeQYk5uK9-CwhM4OHIHFQ,5463
 dashscope/api_entities/api_request_factory.py,sha256=MCJOGgUzaWTaLZ5d8m8dck7QdSUNX7XLbKYyB3pT23E,4067
 dashscope/api_entities/base_request.py,sha256=cXUL7xqSV8wBr5d-1kx65AO3IsRR9A_ps6Lok-v-MKM,926
-dashscope/api_entities/dashscope_response.py,sha256=1KdBib5xOftcKXLzTETe5LElGy2mB8IG8E3JZrGOaAY,15814
+dashscope/api_entities/dashscope_response.py,sha256=Bp1T7HwVlkOvpMNg-AEjz-BScxhLUXMXlE8ApXTtfhQ,17872
 dashscope/api_entities/http_request.py,sha256=MzaTznVJUbyA8u6cLegxVSEM3JWlAhPHbSh4uDCX0-A,9506
 dashscope/api_entities/websocket_request.py,sha256=zU7OskAHaNlKcR9s_6Hlnhr5N3oam4w0sUD5E9N-4BQ,14586
 dashscope/app/__init__.py,sha256=OOV2rFy0QlA9Gu3XVPtWJoBwK1J11BdGhkEdX_sdYGU,68
@@ -50,6 +50,8 @@ dashscope/nlp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dashscope/nlp/understanding.py,sha256=uVkf_4iULnlnuGmEX3taKiHgzxu173vvgVwY5EO2C2Y,2803
 dashscope/protocol/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dashscope/protocol/websocket.py,sha256=z-v6PGx3L4zYBANuC48s7SWSQSwRCDoh0zcfhv9Bf8U,561
+dashscope/rerank/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dashscope/rerank/text_rerank.py,sha256=1L-RLUxMCvNhbMud1FUG6YFWT7ZV979fzhMEuVjJ1oI,2398
 dashscope/resources/qwen.tiktoken,sha256=srG437XMXwJLr8NzEhxquj9m-aWgJp4kNHCh3hajMYY,2561218
 dashscope/tokenizers/__init__.py,sha256=Oy5FMT37Non6e1YxdHQ89U93Dy3CG1Ez0gBa771KZo0,200
 dashscope/tokenizers/qwen_tokenizer.py,sha256=dCnT9-9NrqPS85bEhjlPULUfDADVRhlleYwM_ILgCeI,4111
@@ -58,9 +60,9 @@ dashscope/tokenizers/tokenizer.py,sha256=y6P91qTCYo__pEx_0VHAcj9YECfbUdRqZU1fdGT
 dashscope/tokenizers/tokenizer_base.py,sha256=REDhzRyDT13iequ61-a6_KcTy0GFKlihQve5HkyoyRs,656
 dashscope/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dashscope/utils/oss_utils.py,sha256=iCF5fLqIXDCS2zkE96t2DEUxCI76ArnQH2DiY2hgHu0,6522
-dashscope-1.15.0.dist-info/LICENSE,sha256=Izp5L1DF1Mbza6qojkqNNWlE_mYLnr4rmzx2EBF8YFw,11413
-dashscope-1.15.0.dist-info/METADATA,sha256=Fgl_zE_G36nWNnB7UuE5Yh-soXFqps3ysxWqs-K_T3k,6659
-dashscope-1.15.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-dashscope-1.15.0.dist-info/entry_points.txt,sha256=raEp5dOuj8whJ7yqZlDM8WQ5p2RfnGrGNo0QLQEnatY,50
-dashscope-1.15.0.dist-info/top_level.txt,sha256=woqavFJK9zas5xTqynmALqOtlafghjsk63Xk86powTU,10
-dashscope-1.15.0.dist-info/RECORD,,
+dashscope-1.16.0.dist-info/LICENSE,sha256=Izp5L1DF1Mbza6qojkqNNWlE_mYLnr4rmzx2EBF8YFw,11413
+dashscope-1.16.0.dist-info/METADATA,sha256=3cCTPzfYufBwbOtgXaSRwzo7mv6uEOHTjTuMAv9yPD4,6659
+dashscope-1.16.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+dashscope-1.16.0.dist-info/entry_points.txt,sha256=raEp5dOuj8whJ7yqZlDM8WQ5p2RfnGrGNo0QLQEnatY,50
+dashscope-1.16.0.dist-info/top_level.txt,sha256=woqavFJK9zas5xTqynmALqOtlafghjsk63Xk86powTU,10
+dashscope-1.16.0.dist-info/RECORD,,