dashscope 1.18.1__py3-none-any.whl → 1.19.0__py3-none-any.whl

dashscope/customize/finetunes.py

@@ -0,0 +1,232 @@
+import time
+from http import HTTPStatus
+from typing import Iterator, Union
+
+from dashscope.client.base_api import (CancelMixin, CreateMixin, DeleteMixin,
+                                       GetStatusMixin, ListMixin, LogMixin,
+                                       StreamEventMixin)
+from dashscope.common.constants import TaskStatus
+from dashscope.customize.customize_types import (FineTune, FineTuneCancel,
+                                                 FineTuneDelete, FineTuneEvent,
+                                                 FineTuneList)
+
+
+class FineTunes(CreateMixin, CancelMixin, DeleteMixin, ListMixin,
+                GetStatusMixin, StreamEventMixin, LogMixin):
+    SUB_PATH = 'fine-tunes'
+
+    @classmethod
+    def call(cls,
+             model: str,
+             training_file_ids: Union[list, str],
+             validation_file_ids: Union[list, str] = None,
+             mode: str = None,
+             hyper_parameters: dict = {},
+             api_key: str = None,
+             workspace: str = None,
+             **kwargs) -> FineTune:
+        """Create fine-tune job
+
+        Args:
+            model (str): The model to be fine-tuned
+            training_file_ids (list, str): Ids of the fine-tune training data,
+                which can be pre-uploaded using the File API.
+            validation_file_ids ([list,str], optional): Ids of the fine-tune
+                validating data, which can be pre-uploaded using the File API.
+            mode (str): The fine-tune mode, sft or efficient_sft.
+            hyper_parameters (dict, optional): The fine-tune hyper parameters.
+                Defaults to empty.
+            api_key (str, optional): The api key. Defaults to None.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            FineTune: The request result.
+        """
+        if isinstance(training_file_ids, str):
+            training_file_ids = [training_file_ids]
+        if validation_file_ids and isinstance(validation_file_ids, str):
+            validation_file_ids = [validation_file_ids]
+        request = {
+            'model': model,
+            'training_file_ids': training_file_ids,
+            'validation_file_ids': validation_file_ids,
+            'hyper_parameters': hyper_parameters if hyper_parameters else {},
+        }
+        if mode is not None:
+            request['training_type'] = mode
+        if 'finetuned_output' in kwargs:
+            request['finetuned_output'] = kwargs['finetuned_output']
+        resp = super().call(request,
+                            api_key=api_key,
+                            workspace=workspace,
+                            **kwargs)
+        return FineTune(**resp)
+
+    @classmethod
+    def cancel(cls,
+               job_id: str,
+               api_key: str = None,
+               workspace: str = None,
+               **kwargs) -> FineTuneCancel:
+        """Cancel a running fine-tune job.
+
+        Args:
+            job_id (str): The fine-tune job id.
+            api_key (str, optional): The api api_key, can be None,
+                if None, will get by default rule(TODO: api key doc).
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            FineTune: The request result.
+        """
+        rsp = super().cancel(job_id,
+                             api_key=api_key,
+                             workspace=workspace,
+                             **kwargs)
+        return FineTuneCancel(**rsp)
+
+    @classmethod
+    def list(cls,
+             page_no=1,
+             page_size=10,
+             api_key: str = None,
+             workspace: str = None,
+             **kwargs) -> FineTuneList:
+        """List fine-tune job.
+
+        Args:
+            api_key (str, optional): The api key
+            page_no (int, optional): Page number. Defaults to 1.
+            page_size (int, optional): Items per page. Defaults to 10.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            FineTune: The fine-tune jobs in the result.
+        """
+        response = super().list(page_no=page_no,
+                                page_size=page_size,
+                                api_key=api_key,
+                                workspace=workspace,
+                                **kwargs)
+        return FineTuneList(**response)
+
+    @classmethod
+    def get(cls,
+            job_id: str,
+            api_key: str = None,
+            workspace: str = None,
+            **kwargs) -> FineTune:
+        """Get fine-tune job information.
+
+        Args:
+            job_id (str): The fine-tune job id
+            api_key (str, optional): The api key. Defaults to None.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            FineTune: The job info
+        """
+        response = super().get(job_id,
+                               api_key=api_key,
+                               workspace=workspace,
+                               **kwargs)
+        return FineTune(**response)
+
+    @classmethod
+    def delete(cls,
+               job_id: str,
+               api_key: str = None,
+               workspace: str = None,
+               **kwargs) -> FineTuneDelete:
+        """Delete a fine-tune job.
+
+        Args:
+            job_id (str): The fine-tune job id.
+            api_key (str, optional): The api key. Defaults to None.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            FineTune: The delete result.
+        """
+        rsp = super().delete(job_id,
+                             api_key=api_key,
+                             workspace=workspace,
+                             **kwargs)
+        return FineTuneDelete(**rsp)
+
+    @classmethod
+    def stream_events(cls,
+                      job_id: str,
+                      api_key: str = None,
+                      workspace: str = None,
+                      **kwargs) -> Iterator[FineTuneEvent]:
+        """Get fine-tune job events.
+
+        Args:
+            job_id (str): The fine-tune job id
+            api_key (str, optional): the api key. Defaults to None.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            FineTune: The job log events.
+        """
+        responses = super().stream_events(job_id,
+                                          api_key=api_key,
+                                          workspace=workspace,
+                                          **kwargs)
+        for rsp in responses:
+            yield FineTuneEvent(**rsp)
+
+    @classmethod
+    def logs(cls,
+             job_id: str,
+             *,
+             offset=1,
+             line=1000,
+             api_key: str = None,
+             workspace: str = None,
+             **kwargs) -> FineTune:
+        """Get log of the job.
+
+        Args:
+            job_id (str): The job id(used for fine-tune)
+            offset (int, optional): start log line. Defaults to 1.
+            line (int, optional): total line return. Defaults to 1000.
+            api_key (str, optional): The api key. Defaults to None.
+            workspace (str): The dashscope workspace id.
+
+        Returns:
+            FineTune: The response
+        """
+        return super().logs(job_id,
+                            offset=offset,
+                            line=line,
+                            workspace=workspace,
+                            api_key=api_key)
+
+    @classmethod
+    def wait(cls,
+             job_id: str,
+             api_key: str = None,
+             workspace: str = None,
+             **kwargs):
+        try:
+            while True:
+                rsp = FineTunes.get(job_id,
+                                    api_key=api_key,
+                                    workspace=workspace,
+                                    **kwargs)
+                if rsp.status_code == HTTPStatus.OK:
+                    if rsp.output['status'] in [
+                            TaskStatus.FAILED, TaskStatus.CANCELED,
+                            TaskStatus.SUCCEEDED
+                    ]:
+                        return rsp
+                    else:
+                        time.sleep(30)
+                else:
+                    return rsp
+        except Exception:
+            raise Exception(
+                'You can stream output via: dashscope fine_tunes.stream -j %s'
+                % job_id)

dashscope/models.py

@@ -2,14 +2,13 @@ from dashscope.api_entities.dashscope_response import DashScopeAPIResponse
 from dashscope.client.base_api import GetMixin, ListMixin
 
 
-class Model(ListMixin, GetMixin):
+class Models(ListMixin, GetMixin):
     SUB_PATH = 'models'
 
     @classmethod
     def get(cls,
             name: str,
             api_key: str = None,
-            workspace: str = None,
             **kwargs) -> DashScopeAPIResponse:
         """Get the model information.
 
@@ -21,14 +20,13 @@ class Model(ListMixin, GetMixin):
         Returns:
             DashScopeAPIResponse: The model information.
         """
-        return super().get(name, api_key, workspace=workspace, **kwargs)
+        return super().get(name, api_key, **kwargs)
 
     @classmethod
     def list(cls,
              page=1,
              page_size=10,
              api_key: str = None,
-             workspace: str = None,
              **kwargs) -> DashScopeAPIResponse:
         """List models.
 
@@ -40,8 +38,4 @@ class Model(ListMixin, GetMixin):
         Returns:
             DashScopeAPIResponse: The models.
         """
-        return super().list(api_key,
-                            page,
-                            page_size,
-                            workspace=workspace,
-                            **kwargs)
+        return super().list(page, page_size, api_key=api_key, **kwargs)

dashscope/version.py

@@ -1 +1 @@
-__version__ = '1.18.1'
+__version__ = '1.19.0'

{dashscope-1.18.1.dist-info → dashscope-1.19.0.dist-info}/METADATA

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

{dashscope-1.18.1.dist-info → dashscope-1.19.0.dist-info}/RECORD

@@ -1,16 +1,16 @@
-dashscope/__init__.py,sha256=HCJ9LaQb66YfHUlTuUEEJJ2_DF-9LaJa6OJZx_iKN8Q,2870
-dashscope/cli.py,sha256=4xNf9K9ncob-KUys2mkryUcqs_IpaiwoEP13rM2UyJk,23924
+dashscope/__init__.py,sha256=lIBZR5fWUiO1L62J_17Gri7Dwk9kCf2xhWl8eRw8bkQ,2933
+dashscope/cli.py,sha256=amegoTkGOs6TlHMdoo4JVOqBePo3lGs745rc7leEyrE,24020
 dashscope/deployment.py,sha256=ljmVi-ny6SjEs8v4oIGNWIw8UQTorE7dl5QJv7dEPIQ,5728
 dashscope/file.py,sha256=Dv2Fz3DLbcye2uuQxyQwRM7ky27OthouLXIpSQagQy4,3324
 dashscope/files.py,sha256=QgJjwhtn9F548nCA8jD8OvE6aQEj-20hZqJgYXsUdQU,3930
 dashscope/finetune.py,sha256=_tflDUvu0KagSoCzLaf0hofpG_P8NU6PylL8CPjVhrA,6243
 dashscope/model.py,sha256=UPOn1qMYFhX-ovXi3BMxZEBk8qOK7WLJOYHMbPZwYBo,1440
-dashscope/models.py,sha256=UPOn1qMYFhX-ovXi3BMxZEBk8qOK7WLJOYHMbPZwYBo,1440
-dashscope/version.py,sha256=I5ZqRqhAJhmCPjHV4Y-aZSwFiizEYHBBRN0cXvrD1-A,23
+dashscope/models.py,sha256=1-bc-Ue68zurgu_y6RhfFr9uzeQMF5AZq-C32lJGMGU,1224
+dashscope/version.py,sha256=PvMTFqtUFNQdVjEOjF4SwqihC40AoILowDbGracDUXA,23
 dashscope/aigc/__init__.py,sha256=s-MCA87KYiVumYtKtJi5IMN7xelSF6TqEU3s3_7RF-Y,327
 dashscope/aigc/code_generation.py,sha256=KAJVrGp6tiNFBBg64Ovs9RfcP5SrIhrbW3wdA89NKso,10885
 dashscope/aigc/conversation.py,sha256=xRoJlCR-IXHjSdkDrK74a9ut1FJg0FZhTNXZAJC18MA,14231
-dashscope/aigc/generation.py,sha256=9PMAhSy5Ht5eizUGXnDdk8Jl3yIDM4fR8eSxn1W4c-U,10051
+dashscope/aigc/generation.py,sha256=53oMCmN5ZbqeqAsKxmdunXlRh-XP8ZtnA7hB2id4Koo,17897
 dashscope/aigc/image_synthesis.py,sha256=7A5txSkKBkg5pN5F7IP5C90277Yk8fkKAWu30YhskdM,9994
 dashscope/aigc/multimodal_conversation.py,sha256=SlNnnsUPV19gdx8fYJAtsMFWPNGY6vhk5IGHZ5ZczpI,5369
 dashscope/api_entities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -19,33 +19,37 @@ dashscope/api_entities/api_request_data.py,sha256=JUMcfpJjKXEZLCBSFIDpgoaeQYk5uK
 dashscope/api_entities/api_request_factory.py,sha256=4p-qxMuvCA0CmUHdH19QaUCaHmlLHAM1X2Jd4YKt5c0,4661
 dashscope/api_entities/base_request.py,sha256=cXUL7xqSV8wBr5d-1kx65AO3IsRR9A_ps6Lok-v-MKM,926
 dashscope/api_entities/dashscope_response.py,sha256=Bp1T7HwVlkOvpMNg-AEjz-BScxhLUXMXlE8ApXTtfhQ,17872
-dashscope/api_entities/http_request.py,sha256=Y9z4PcRAPlp6Ozfz9P3IVP3y9cufhhIFjXaJOF6xCtQ,9043
+dashscope/api_entities/http_request.py,sha256=sSaHknlFOgSN4XLpOX0xztllPlwMms-dI7cLlOgCUig,16418
 dashscope/api_entities/websocket_request.py,sha256=IaydqRvOSr5IdSSpnX8Vc8rRoVldjfcrLvDxTnPep9g,14676
-dashscope/app/__init__.py,sha256=OOV2rFy0QlA9Gu3XVPtWJoBwK1J11BdGhkEdX_sdYGU,68
+dashscope/app/__init__.py,sha256=UiN_9i--z84Dw5wUehOh_Tkk_9Gq_td_Kbz1dobBEKg,62
 dashscope/app/application.py,sha256=AegGVsk3dDzYACoYRNNjo3eG-2wrDd0dlOjYHpF0r2Y,7949
-dashscope/app/application_response.py,sha256=pIuDSu_SAcX1Y_gK6ZYaadaMXV52XBZoM1uN4tTZ3FA,6739
+dashscope/app/application_response.py,sha256=AR_dEtfDsS7SqOyUqZmiosdgos1bDnXUvZn7XV_OzAs,6714
 dashscope/assistants/__init__.py,sha256=i9N5OxHgY7edlOhTdPyC0N5Uc0uMCkB2vbMPDCD1zX0,383
 dashscope/assistants/assistant_types.py,sha256=1jNL30TOlrkiYhvCaB3E8jkPLG8CnQ6I3tHpYXZCsD0,4211
 dashscope/assistants/assistants.py,sha256=NYahIDqhtnOcQOmnhZsjc5F5jvBUQcce8-fbrJXHVnQ,10833
 dashscope/assistants/files.py,sha256=pwLVJ_pjpRFWyfI_MRvhH7Si7FzGDj4ChzZgWTpLOhg,6699
 dashscope/audio/__init__.py,sha256=vlw0TFVRdeRWfzmJxhzarVUqkMs-DZNf4GiMtm3C8XE,45
 dashscope/audio/asr/__init__.py,sha256=-s180qWn_JPSpCo1q0aDJJ5HQ3zTzD4z5yUwsRqH4aU,275
-dashscope/audio/asr/asr_phrase_manager.py,sha256=4-tj9jxo5yUCcRktxXGgB_dggUk9oOtWGNyjBJj1wm8,7590
+dashscope/audio/asr/asr_phrase_manager.py,sha256=EjtbI3zz9UQGS1qv6Yb4zzEMj4OJJVXmwkqZyIrzvEA,7642
 dashscope/audio/asr/recognition.py,sha256=F2iz6hyXg16Z6DGlPwGpKfRNcAZIIsqXnNPtaZp4Fzo,17369
 dashscope/audio/asr/transcription.py,sha256=e5O1U51GT-OQPu-wWN2w_T7l6IopWuGMVkheOGdNCkk,8836
 dashscope/audio/tts/__init__.py,sha256=fbnieZX9yNFNh5BsxLpLXb63jlxzxrdCJakV3ignjlQ,194
 dashscope/audio/tts/speech_synthesizer.py,sha256=dnKx9FDDdO_ETHAjhK8zaMVaH6SfoTtN5YxXXqgY1JA,7571
 dashscope/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dashscope/client/base_api.py,sha256=UDxvwlxiR0KZwj_AI0jACfkLErJ55voure82OmOiDMk,41034
+dashscope/client/base_api.py,sha256=rww7uoDJtKxgiFQlBpZ8p__J0087cJWhvUxtdb3rrTE,41064
 dashscope/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dashscope/common/api_key.py,sha256=5Stp0odL5JSuIO3qJBp23QNppuGbqhhvKPS66qbMs0I,1986
-dashscope/common/base_type.py,sha256=wKqLGrr2o9bpI43ws1P0YCuJmoS17J9_Rw_uuYHjIFQ,4531
+dashscope/common/base_type.py,sha256=C9xP6WuN5pOzviZ2g3X2EPcigldtFE0VlaUmjyNnUUk,4619
 dashscope/common/constants.py,sha256=86Zc45f1-OEgNdLTu-4_Pl0U3wRyi5qFt4E7dLlaglU,2327
 dashscope/common/env.py,sha256=oQOZW5JyEeTSde394un2lpDJ5RBh4fMU9hBfbtrKKkc,869
 dashscope/common/error.py,sha256=Q7GRhniP-7ap4HBpU69frRdKgKLwmH4ySYxCtupsr60,2638
 dashscope/common/logging.py,sha256=ecGxylG3bWES_Xv5-BD6ep4_0Ciu7F6ZPBjiZtu9Jx4,984
 dashscope/common/message_manager.py,sha256=i5149WzDk6nWmdFaHzYx4USXMBeX18GKSI-F4fLwbN0,1097
 dashscope/common/utils.py,sha256=5jg7q5NE0LE1NigbpfrOkqXjPYqb-3jfFOh7g-nWB1Q,12017
+dashscope/customize/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dashscope/customize/customize_types.py,sha256=ZtEwSXA4dbjIYr5vgQQNkMuXyC2BNmznGuaF6b7jwr0,4803
+dashscope/customize/deployments.py,sha256=LIkM-hmJHcJZCKV6WJIPSXQ5CAhB5PUxnt5mqKbVbfE,5189
+dashscope/customize/finetunes.py,sha256=iFnEUMGY6FGogVClIJMEeFhUwfYi7gD05Iq1-eMP2M0,8311
 dashscope/embeddings/__init__.py,sha256=-dxHaoxZZVuP-wAGUIa3sNNh8CQwaeWj2UlqsDy1sV4,240
 dashscope/embeddings/batch_text_embedding.py,sha256=P32LFO9v7ehdJsl0c32In94hUET6K6AaGJ_pDRtFqco,8791
 dashscope/embeddings/batch_text_embedding_response.py,sha256=WziXlQsFIkL1kPc_7lRG1HtqgkO5vVThtnNqExJggNU,2000
@@ -76,9 +80,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=fi8-PPsN-iR-iv5k2NS5Z8nlWkpgUhr56FRWm4BDh4A,6984
-dashscope-1.18.1.dist-info/LICENSE,sha256=Izp5L1DF1Mbza6qojkqNNWlE_mYLnr4rmzx2EBF8YFw,11413
-dashscope-1.18.1.dist-info/METADATA,sha256=33M-0CZybEgQltO9zFJSM4xHpCSEzO2IabuoaJJFbdI,6609
-dashscope-1.18.1.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-dashscope-1.18.1.dist-info/entry_points.txt,sha256=raEp5dOuj8whJ7yqZlDM8WQ5p2RfnGrGNo0QLQEnatY,50
-dashscope-1.18.1.dist-info/top_level.txt,sha256=woqavFJK9zas5xTqynmALqOtlafghjsk63Xk86powTU,10
-dashscope-1.18.1.dist-info/RECORD,,
+dashscope-1.19.0.dist-info/LICENSE,sha256=Izp5L1DF1Mbza6qojkqNNWlE_mYLnr4rmzx2EBF8YFw,11413
+dashscope-1.19.0.dist-info/METADATA,sha256=_g9jJF6fHX67RDkeclS5Rfso_F-xgSP_lV8puUof84I,6609
+dashscope-1.19.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+dashscope-1.19.0.dist-info/entry_points.txt,sha256=raEp5dOuj8whJ7yqZlDM8WQ5p2RfnGrGNo0QLQEnatY,50
+dashscope-1.19.0.dist-info/top_level.txt,sha256=woqavFJK9zas5xTqynmALqOtlafghjsk63Xk86powTU,10
+dashscope-1.19.0.dist-info/RECORD,,