dashscope 1.8.0__py3-none-any.whl → 1.25.6__py3-none-any.whl

dashscope/cli.py

@@ -1,13 +1,16 @@
 #!/usr/bin/env python
 import argparse
+import json
 import sys
 import time
+import os
 from http import HTTPStatus
 
 import dashscope
 from dashscope.aigc import Generation
 from dashscope.common.constants import (DeploymentStatus, FilePurpose,
                                         TaskStatus)
+from dashscope.utils.oss_utils import OssUtils
 
 
 def print_failed_message(rsp):
@@ -44,7 +47,10 @@ class FineTunes:
             params['learning_rate'] = args.learning_rate
         if args.prompt_loss is not None:
             params['prompt_loss'] = args.prompt_loss
-        rsp = dashscope.FineTune.call(
+        if args.params:
+            params.update(args.params)
+
+        rsp = dashscope.FineTunes.call(
             model=args.model,
             training_file_ids=args.training_file_ids,
             validation_file_ids=args.validation_file_ids,
@@ -61,7 +67,7 @@ class FineTunes:
     def wait(cls, job_id):
         try:
             while True:
-                rsp = dashscope.FineTune.get(job_id)
+                rsp = dashscope.FineTunes.get(job_id)
                 if rsp.status_code == HTTPStatus.OK:
                     if rsp.output['status'] == TaskStatus.FAILED:
                         print('Fine-tune FAILED!')
@@ -90,7 +96,7 @@ class FineTunes:
 
     @classmethod
     def get(cls, args):
-        rsp = dashscope.FineTune.get(args.job)
+        rsp = dashscope.FineTunes.get(args.job)
         if rsp.status_code == HTTPStatus.OK:
             if rsp.output['status'] == TaskStatus.FAILED:
                 print('Fine-tune failed!')
@@ -106,8 +112,8 @@ class FineTunes:
 
     @classmethod
     def list(cls, args):
-        rsp = dashscope.FineTune.list(page=args.start_page,
-                                      page_size=args.page_size)
+        rsp = dashscope.FineTunes.list(page=args.start_page,
+                                       page_size=args.page_size)
         if rsp.status_code == HTTPStatus.OK:
             if rsp.output is not None:
                 for job in rsp.output['jobs']:
@@ -128,7 +134,7 @@ class FineTunes:
     @classmethod
     def stream_events(cls, job_id):
         # check job status if job is completed, get log.
-        rsp = dashscope.FineTune.get(job_id)
+        rsp = dashscope.FineTunes.get(job_id)
         if rsp.status_code == HTTPStatus.OK:
             if rsp.output['status'] in [
                     TaskStatus.FAILED, TaskStatus.CANCELED,
@@ -143,7 +149,7 @@ class FineTunes:
             return
         # start streaming events.
         try:
-            stream_events = dashscope.FineTune.stream_events(job_id)
+            stream_events = dashscope.FineTunes.stream_events(job_id)
             for rsp in stream_events:
                 if rsp.status_code == HTTPStatus.OK:
                     print(rsp.output)
@@ -163,7 +169,7 @@ class FineTunes:
         start = 1
         n_line = 1000  # 1000 line per request
         while True:
-            rsp = dashscope.FineTune.logs(job_id, start, n_line)
+            rsp = dashscope.FineTunes.logs(job_id, offset=start, line=n_line)
             if rsp.status_code == HTTPStatus.OK:
                 for line in rsp.output['logs']:
                     print(line)
@@ -176,7 +182,7 @@ class FineTunes:
 
     @classmethod
     def cancel(cls, args):
-        rsp = dashscope.FineTune.cancel(args.job)
+        rsp = dashscope.FineTunes.cancel(args.job)
         if rsp.status_code == HTTPStatus.OK:
             print('Cancel fine-tune job: %s success!')
         else:
@@ -184,19 +190,49 @@ class FineTunes:
 
     @classmethod
     def delete(cls, args):
-        rsp = dashscope.FineTune.delete(args.job)
+        rsp = dashscope.FineTunes.delete(args.job)
         if rsp.status_code == HTTPStatus.OK:
             print('fine_tune job: %s delete success' % args.job)
         else:
             print_failed_message(rsp)
 
+class Oss:
+    @classmethod
+    def upload(cls, args):
+        print('Start oss.upload: model=%s, file=%s, api_key=%s' % (args.model, args.file, args.api_key))
+        if not args.file or not args.model:
+            print('Please specify the model and file path')
+            return
+
+        file_path = os.path.expanduser(args.file)
+        if not os.path.exists(file_path):
+            print('File %s does not exist' % file_path)
+            return
+
+        api_key = os.environ.get('DASHSCOPE_API_KEY', args.api_key)
+        if not api_key:
+            print('Please set your DashScope API key as environment variable '
+                  'DASHSCOPE_API_KEY or pass it as argument by -k/--api_key')
+            return
+
+        oss_url, _ = OssUtils.upload(model=args.model,
+                                     file_path=file_path,
+                                     api_key=api_key,
+                                     base_address=args.base_url)
+
+        if not oss_url:
+            print('Failed to upload file: %s' % file_path)
+            return
+
+        print('Uploaded oss url: %s' % oss_url)
 
 class Files:
     @classmethod
     def upload(cls, args):
-        rsp = dashscope.File.upload(file_path=args.file,
-                                    purpose=args.purpose,
-                                    description=args.description)
+        rsp = dashscope.Files.upload(file_path=args.file,
+                                     purpose=args.purpose,
+                                     description=args.description,
+                                     base_address=args.base_url)
         print(rsp)
         if rsp.status_code == HTTPStatus.OK:
             print('Upload success, file id: %s' %
@@ -206,32 +242,31 @@ class Files:
 
     @classmethod
     def get(cls, args):
-        rsp = dashscope.File.get(file_id=args.id)
+        rsp = dashscope.Files.get(file_id=args.id, base_address=args.base_url)
         if rsp.status_code == HTTPStatus.OK:
-            print('file_id: %s, name: %s, description: %s' %
-                  (rsp.output['file_id'], rsp.output['name'],
-                   rsp.output['description']))
+            if rsp.output:
+                print('file info:\n%s' % json.dumps(rsp.output, ensure_ascii=False, indent=4))
+            else:
+                print('There is no uploaded file.')
         else:
             print_failed_message(rsp)
 
     @classmethod
     def list(cls, args):
-        rsp = dashscope.File.list(page=args.start_page,
-                                  page_size=args.page_size)
+        rsp = dashscope.Files.list(page=args.start_page,
+                                   page_size=args.page_size,
+                                   base_address=args.base_url)
         if rsp.status_code == HTTPStatus.OK:
-            if rsp.output is not None:
-                for f in rsp.output['files']:
-                    print('file_id: %s, name: %s, description: %s, time: %s' %
-                          (f['file_id'], f['name'], f['description'],
-                           f['gmt_create']))
+            if rsp.output:
+                print('file list info:\n%s' % json.dumps(rsp.output, ensure_ascii=False, indent=4))
             else:
-                print('There is no uploaded file.')
+                print('There is no uploaded files.')
         else:
             print_failed_message(rsp)
 
     @classmethod
     def delete(cls, args):
-        rsp = dashscope.File.delete(args.id)
+        rsp = dashscope.Files.delete(args.id, base_address=args.base_url)
         if rsp.status_code == HTTPStatus.OK:
             print('Delete success')
         else:
@@ -241,15 +276,15 @@ class Files:
 class Deployments:
     @classmethod
     def call(cls, args):
-        rsp = dashscope.Deployment.call(model=args.model,
-                                        capacity=args.capacity,
-                                        suffix=args.suffix)
+        rsp = dashscope.Deployments.call(model=args.model,
+                                         capacity=args.capacity,
+                                         suffix=args.suffix)
         if rsp.status_code == HTTPStatus.OK:
             deployed_model = rsp.output['deployed_model']
             print('Create model: %s deployment' % deployed_model)
             try:
                 while True:  # wait for deployment ok.
-                    status = dashscope.Deployment.get(deployed_model)
+                    status = dashscope.Deployments.get(deployed_model)
                     if status.status_code == HTTPStatus.OK:
                         if status.output['status'] in [
                                 DeploymentStatus.PENDING,
@@ -273,7 +308,7 @@ class Deployments:
 
     @classmethod
     def get(cls, args):
-        rsp = dashscope.Deployment.get(args.deploy)
+        rsp = dashscope.Deployments.get(args.deploy)
         if rsp.status_code == HTTPStatus.OK:
             print('Deployed model: %s capacity: %s status: %s' %
                   (rsp.output['deployed_model'], rsp.output['capacity'],
@@ -283,11 +318,12 @@ class Deployments:
 
     @classmethod
     def list(cls, args):
-        rsp = dashscope.Deployment.list(page_no=args.start_page,
-                                        page_size=args.page_size)
+        rsp = dashscope.Deployments.list(page_no=args.start_page,
+                                         page_size=args.page_size)
         if rsp.status_code == HTTPStatus.OK:
             if rsp.output is not None:
-                if 'deployments' not in rsp.output:
+                if 'deployments' not in rsp.output or len(
+                        rsp.output['deployments']) == 0:
                     print('There is no deployed model!')
                     return
                 for deployment in rsp.output['deployments']:
@@ -301,7 +337,7 @@ class Deployments:
 
     @classmethod
     def update(cls, args):
-        rsp = dashscope.Deployment.update(args.deployed_model, args.version)
+        rsp = dashscope.Deployments.update(args.deployed_model, args.version)
         if rsp.status_code == HTTPStatus.OK:
             if rsp.output is not None:
                 if 'deployments' not in rsp.output:
@@ -318,7 +354,7 @@ class Deployments:
 
     @classmethod
     def scale(cls, args):
-        rsp = dashscope.Deployment.scale(args.deployed_model, args.capacity)
+        rsp = dashscope.Deployments.scale(args.deployed_model, args.capacity)
         if rsp.status_code == HTTPStatus.OK:
             if rsp.output is not None:
                 print('Deployed_model: %s, model: %s, status: %s' %
@@ -331,13 +367,28 @@ class Deployments:
 
     @classmethod
     def delete(cls, args):
-        rsp = dashscope.Deployment.delete(args.deploy)
+        rsp = dashscope.Deployments.delete(args.deploy)
         if rsp.status_code == HTTPStatus.OK:
             print('Deployed model: %s delete success' % args.deploy)
         else:
             print_failed_message(rsp)
 
 
+# from: https://gist.github.com/vadimkantorov/37518ff88808af840884355c845049ea
+class ParseKVAction(argparse.Action):
+    def __call__(self, parser, namespace, values, option_string=None):
+        setattr(namespace, self.dest, dict())
+        for each in values:
+            try:
+                key, value = each.split('=')
+                getattr(namespace, self.dest)[key] = value
+            except ValueError as ex:
+                message = '\nTraceback: {}'.format(ex)
+                message += "\nError on '{}' || It should be 'key=value'".format(
+                    each)
+                raise argparse.ArgumentError(self, str(message))
+
+
 def main():
     parser = argparse.ArgumentParser(
         prog='dashscope', description='dashscope command line tools.')
@@ -409,6 +460,13 @@ def main():
                                 type=float,
                                 required=False,
                                 help='The fine-tune prompt loss.')
+    fine_tune_call.add_argument(
+        '--hyper_parameters',
+        nargs='+',
+        dest='params',
+        action=ParseKVAction,
+        help='Extra hyper parameters accepts by key1=value1 key2=value2',
+        metavar='KEY1=VALUE1')
     fine_tune_call.set_defaults(func=FineTunes.call)
     fine_tune_get = sub_parsers.add_parser('fine_tunes.get')
     fine_tune_get.add_argument('-j',
@@ -451,6 +509,37 @@ def main():
                                   help='The fine-tune job id.')
     fine_tune_cancel.set_defaults(func=FineTunes.cancel)
 
+    oss_upload = sub_parsers.add_parser('oss.upload')
+    oss_upload.add_argument(
+        '-f',
+        '--file',
+        type=str,
+        required=True,
+        help='The file path to upload',
+    )
+    oss_upload.add_argument(
+        '-m',
+        '--model',
+        type=str,
+        required=True,
+        help='The model name',
+    )
+    oss_upload.add_argument(
+        '-k',
+        '--api_key',
+        type=str,
+        required=False,
+        help='The dashscope api key',
+    )
+    oss_upload.add_argument(
+        '-u',
+        '--base_url',
+        type=str,
+        help='The base url.',
+        required=False,
+    )
+    oss_upload.set_defaults(func=Oss.upload)
+
     file_upload = sub_parsers.add_parser('files.upload')
     file_upload.add_argument(
         '-f',
@@ -475,21 +564,45 @@ def main():
         help='The file description.',
         required=False,
     )
+    file_upload.add_argument(
+        '-u',
+        '--base_url',
+        type=str,
+        help='The base url.',
+        required=False,
+    )
     file_upload.set_defaults(func=Files.upload)
+
     file_get = sub_parsers.add_parser('files.get')
     file_get.add_argument('-i',
                           '--id',
                           type=str,
                           required=True,
                           help='The file ID')
+    file_get.add_argument(
+        '-u',
+        '--base_url',
+        type=str,
+        help='The base url.',
+        required=False,
+    )
     file_get.set_defaults(func=Files.get)
+
     file_delete = sub_parsers.add_parser('files.delete')
     file_delete.add_argument('-i',
                              '--id',
                              type=str,
                              required=True,
                              help='The files ID')
+    file_delete.add_argument(
+        '-u',
+        '--base_url',
+        type=str,
+        help='The base url.',
+        required=False,
+    )
     file_delete.set_defaults(func=Files.delete)
+
     file_list = sub_parsers.add_parser('files.list')
     file_list.add_argument('-s',
                            '--start_page',
@@ -501,6 +614,13 @@ def main():
                            type=int,
                            default=10,
                            help='The page size, default 10')
+    file_list.add_argument(
+        '-u',
+        '--base_url',
+        type=str,
+        help='The base url.',
+        required=False,
+    )
     file_list.set_defaults(func=Files.list)
 
     deployments_call = sub_parsers.add_parser('deployments.call')