File size: 4,477 Bytes
cbc00ce | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | # -*- coding: utf-8 -*-
# Copyright (c) Alibaba, Inc. and its affiliates.
import os
from dashscope.api_entities.dashscope_response import DashScopeAPIResponse
from dashscope.client.base_api import (
DeleteMixin,
FileUploadMixin,
GetMixin,
ListMixin,
)
from dashscope.common.constants import FilePurpose
from dashscope.common.error import InvalidFileFormat
from dashscope.common.utils import is_validate_fine_tune_file
class Files(FileUploadMixin, ListMixin, DeleteMixin, GetMixin):
SUB_PATH = "files"
@classmethod
def upload( # pylint: disable=arguments-renamed
cls,
file_path: str, # type: ignore[override]
purpose: str = FilePurpose.fine_tune, # type: ignore[override]
description: str = None, # type: ignore[override]
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""Upload file for model fine-tune or other tasks.
Args:
file_path (str): The local file name to upload.
purpose (str): The purpose of the file[fine-tune|inference]
description (str, optional): The file description message.
api_key (str, optional): The api key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The upload information
"""
if purpose == FilePurpose.fine_tune:
if not is_validate_fine_tune_file(file_path):
raise InvalidFileFormat(
f"The file {file_path} is not in valid jsonl format",
)
with open(file_path, "rb") as f:
return super().upload( # type: ignore[return-value]
files=[
(
"files",
(
os.path.basename(f.name),
f,
None,
),
),
],
descriptions=[description]
if description is not None
else None,
api_key=api_key,
workspace=workspace,
**kwargs,
)
@classmethod
def list( # type: ignore[override]
cls,
page=1,
page_size=10,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""List uploaded files.
Args:
api_key (str, optional):
The api api_key, can be None,
if None, will get by default rule(TODO: api key doc).
page (int, optional): Page number. Defaults to 1.
page_size (int, optional): Items per page. Defaults to 10.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The fine-tune jobs in the result.
"""
return super().list( # type: ignore[return-value]
page,
page_size,
api_key,
workspace=workspace,
**kwargs,
)
@classmethod
def get( # type: ignore[override]
cls,
file_id: str,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""Get the file info.
Args:
file_id (str): The file id.
api_key (str, optional): The api key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The job info
"""
# type: ignore
return super().get(file_id, api_key, workspace=workspace, **kwargs) # type: ignore[return-value] # pylint: disable=line-too-long # noqa: E501
@classmethod
def delete( # type: ignore[override]
cls,
file_id: str,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""Delete uploaded file.
Args:
file_id (str): The file id want to delete.
api_key (str, optional): The api key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: Delete result.
""" # type: ignore
return super().delete(file_id, api_key, workspace=workspace, **kwargs) # type: ignore[return-value] # pylint: disable=line-too-long # noqa: E501
|