UnisKB/apps/setting/views/model.py

266 lines
13 KiB
Python
Raw Normal View History

# coding=utf-8
"""
@project: maxkb
@Author
@file model.py
@date2023/11/2 13:55
@desc:
"""
from drf_yasg.utils import swagger_auto_schema
from rest_framework.decorators import action
from rest_framework.views import APIView
from rest_framework.views import Request
from common.auth import TokenAuth, has_permissions
from common.constants.permission_constants import PermissionConstants
from common.log.log import log
from common.response import result
from common.util.common import query_params_to_single_dict
from setting.models_provider.constants.model_provider_constants import ModelProvideConstants
from setting.serializers.provider_serializers import ProviderSerializer, ModelSerializer, \
get_default_model_params_setting
2023-12-01 09:30:06 +00:00
from setting.swagger_api.provide_api import ProvideApi, ModelCreateApi, ModelQueryApi, ModelEditApi
2025-01-13 03:15:51 +00:00
from django.utils.translation import gettext_lazy as _
class Model(APIView):
authentication_classes = [TokenAuth]
@action(methods=['POST'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Create model'),
operation_id=_('Create model'),
request_body=ModelCreateApi.get_request_body_api()
2025-01-13 03:15:51 +00:00
, tags=[_('model')])
@has_permissions(PermissionConstants.MODEL_CREATE)
@log(menu='model', operate='Create model')
def post(self, request: Request):
return result.success(
ModelSerializer.Create(data={**request.data, 'user_id': str(request.user.id)}).insert(request.user.id,
with_valid=True))
2024-03-22 09:56:56 +00:00
@action(methods=['PUT'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Download model, trial only with Ollama platform'),
operation_id=_('Download model, trial only with Ollama platform'),
2024-03-22 09:56:56 +00:00
request_body=ModelCreateApi.get_request_body_api()
2025-01-13 03:15:51 +00:00
, tags=[_('model')])
2024-03-22 09:56:56 +00:00
@has_permissions(PermissionConstants.MODEL_CREATE)
@log(menu='model', operate='Download model, trial only with Ollama platform')
2024-03-22 09:56:56 +00:00
def put(self, request: Request):
return result.success(
ModelSerializer.Create(data={**request.data, 'user_id': str(request.user.id)}).insert(request.user.id,
with_valid=True))
@action(methods=['GET'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Get model list'),
operation_id=_('Get model list'),
manual_parameters=ModelQueryApi.get_request_params_api()
2025-01-13 03:15:51 +00:00
, tags=[_('model')])
@has_permissions(PermissionConstants.MODEL_READ)
@log(menu='model', operate='Get model list')
def get(self, request: Request):
return result.success(
ModelSerializer.Query(
data={**query_params_to_single_dict(request.query_params), 'user_id': request.user.id}).list(
with_valid=True))
2024-03-22 09:56:56 +00:00
class ModelMeta(APIView):
authentication_classes = [TokenAuth]
@action(methods=['GET'], detail=False)
@swagger_auto_schema(operation_summary=_(
'Query model meta information, this interface does not carry authentication information'),
operation_id=_(
'Query model meta information, this interface does not carry authentication information'),
tags=[_('model')])
2024-03-22 09:56:56 +00:00
@has_permissions(PermissionConstants.MODEL_READ)
@log(menu='model',
operate='Query model meta information, this interface does not carry authentication information')
2024-03-22 09:56:56 +00:00
def get(self, request: Request, model_id: str):
return result.success(
ModelSerializer.Operate(data={'id': model_id, 'user_id': request.user.id}).one_meta(with_valid=True))
2024-07-19 08:13:44 +00:00
class PauseDownload(APIView):
authentication_classes = [TokenAuth]
@action(methods=['PUT'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Pause model download'),
operation_id=_('Pause model download'),
tags=[_('model')])
2024-07-19 08:13:44 +00:00
@has_permissions(PermissionConstants.MODEL_CREATE)
@log(menu='model',
operate='Pause model download')
2024-07-19 08:13:44 +00:00
def put(self, request: Request, model_id: str):
return result.success(
ModelSerializer.Operate(data={'id': model_id, 'user_id': request.user.id}).pause_download())
2024-08-23 09:46:05 +00:00
class ModelParamsForm(APIView):
authentication_classes = [TokenAuth]
@action(methods=['GET'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Get model parameter form'),
operation_id=_('Get model parameter form'),
2024-08-23 09:46:05 +00:00
manual_parameters=ProvideApi.ModelForm.get_request_params_api(),
2025-01-13 03:15:51 +00:00
tags=[_('model')])
2024-08-23 09:46:05 +00:00
@has_permissions(PermissionConstants.MODEL_READ)
@log(menu='model', operate='Get model parameter form')
2024-08-23 09:46:05 +00:00
def get(self, request: Request, model_id: str):
return result.success(
ModelSerializer.ModelParams(data={'id': model_id, 'user_id': request.user.id}).get_model_params())
2024-08-23 09:46:05 +00:00
@action(methods=['PUT'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Save model parameter form'),
operation_id=_('Save model parameter form'),
manual_parameters=ProvideApi.ModelForm.get_request_params_api(),
2025-01-13 03:15:51 +00:00
tags=[_('model')])
@has_permissions(PermissionConstants.MODEL_READ)
@log(menu='model', operate='Save model parameter form')
def put(self, request: Request, model_id: str):
return result.success(
ModelSerializer.ModelParamsForm(data={'id': model_id, 'user_id': request.user.id})
.save_model_params_form(request.data))
2023-12-01 09:30:06 +00:00
class Operate(APIView):
authentication_classes = [TokenAuth]
@action(methods=['PUT'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Update model'),
operation_id=_('Update model'),
2023-12-01 09:30:06 +00:00
request_body=ModelEditApi.get_request_body_api()
2025-01-13 03:15:51 +00:00
, tags=[_('model')])
2023-12-01 09:30:06 +00:00
@has_permissions(PermissionConstants.MODEL_CREATE)
@log(menu='model', operate='Update model')
2023-12-01 09:30:06 +00:00
def put(self, request: Request, model_id: str):
return result.success(
ModelSerializer.Operate(data={'id': model_id, 'user_id': request.user.id}).edit(request.data,
str(request.user.id)))
@action(methods=['DELETE'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Delete model'),
operation_id=_('Delete model'),
2023-12-01 09:30:06 +00:00
responses=result.get_default_response()
2025-01-13 03:15:51 +00:00
, tags=[_('model')])
2023-12-01 09:30:06 +00:00
@has_permissions(PermissionConstants.MODEL_DELETE)
@log(menu='model', operate='Delete model')
2023-12-01 09:30:06 +00:00
def delete(self, request: Request, model_id: str):
return result.success(
ModelSerializer.Operate(data={'id': model_id, 'user_id': request.user.id}).delete())
@action(methods=['GET'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Query model details'),
operation_id=_('Query model details'),
tags=[_('model')])
@log(menu='model', operate='Query model details')
2023-12-01 09:30:06 +00:00
@has_permissions(PermissionConstants.MODEL_READ)
def get(self, request: Request, model_id: str):
return result.success(
ModelSerializer.Operate(data={'id': model_id, 'user_id': request.user.id}).one(with_valid=True))
class Provide(APIView):
authentication_classes = [TokenAuth]
2023-12-01 09:30:06 +00:00
class Exec(APIView):
authentication_classes = [TokenAuth]
@action(methods=['POST'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Call the supplier function to obtain form data'),
operation_id=_('Call the supplier function to obtain form data'),
manual_parameters=ProvideApi.get_request_params_api(),
request_body=ProvideApi.get_request_body_api()
2025-01-13 03:15:51 +00:00
, tags=[_('model')])
@has_permissions(PermissionConstants.MODEL_READ)
@log(menu='model', operate='Call the supplier function to obtain form data')
def post(self, request: Request, provider: str, method: str):
return result.success(
ProviderSerializer(data={'provider': provider, 'method': method}).exec(request.data, with_valid=True))
@action(methods=['GET'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Get a list of model suppliers'),
operation_id=_('Get a list of model suppliers')
, tags=[_('model')])
@has_permissions(PermissionConstants.MODEL_READ)
@log(menu='model', operate='Get a list of model suppliers')
def get(self, request: Request):
model_type = request.query_params.get('model_type')
if model_type:
providers = []
for key in ModelProvideConstants.__members__:
if len([item for item in ModelProvideConstants[key].value.get_model_type_list() if
item['value'] == model_type]) > 0:
providers.append(ModelProvideConstants[key].value.get_model_provide_info().to_dict())
return result.success(providers)
return result.success(
[ModelProvideConstants[key].value.get_model_provide_info().to_dict() for key in
ModelProvideConstants.__members__])
class ModelTypeList(APIView):
authentication_classes = [TokenAuth]
@action(methods=['GET'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Get a list of model types'),
operation_id=_('Get a list of model types'),
manual_parameters=ProvideApi.ModelTypeList.get_request_params_api(),
responses=result.get_api_array_response(ProvideApi.ModelTypeList.get_response_body_api())
2025-01-13 03:15:51 +00:00
, tags=[_('model')])
@has_permissions(PermissionConstants.MODEL_READ)
@log(menu='model', operate='Get a list of model types')
def get(self, request: Request):
provider = request.query_params.get('provider')
return result.success(ModelProvideConstants[provider].value.get_model_type_list())
class ModelList(APIView):
authentication_classes = [TokenAuth]
@action(methods=['GET'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Get the model creation form'),
operation_id=_('Get the model creation form'),
manual_parameters=ProvideApi.ModelList.get_request_params_api(),
responses=result.get_api_array_response(ProvideApi.ModelList.get_response_body_api())
2025-01-13 03:15:51 +00:00
, tags=[_('model')]
)
@has_permissions(PermissionConstants.MODEL_READ)
@log(menu='model', operate='Get the model creation form')
def get(self, request: Request):
provider = request.query_params.get('provider')
model_type = request.query_params.get('model_type')
return result.success(
ModelProvideConstants[provider].value.get_model_list(
model_type))
class ModelParamsForm(APIView):
authentication_classes = [TokenAuth]
@action(methods=['GET'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Get model default parameters'),
operation_id=_('Get the model creation form'),
manual_parameters=ProvideApi.ModelList.get_request_params_api(),
responses=result.get_api_array_response(ProvideApi.ModelList.get_response_body_api())
2025-01-13 03:15:51 +00:00
, tags=[_('model')]
)
@has_permissions(PermissionConstants.MODEL_READ)
@log(menu='model', operate='Get model default parameters')
def get(self, request: Request):
provider = request.query_params.get('provider')
model_type = request.query_params.get('model_type')
model_name = request.query_params.get('model_name')
return result.success(get_default_model_params_setting(provider, model_type, model_name))
class ModelForm(APIView):
authentication_classes = [TokenAuth]
@action(methods=['GET'], detail=False)
2025-01-13 03:15:51 +00:00
@swagger_auto_schema(operation_summary=_('Get the model creation form'),
operation_id=_('Get the model creation form'),
manual_parameters=ProvideApi.ModelForm.get_request_params_api(),
2025-01-13 03:15:51 +00:00
tags=[_('model')])
@has_permissions(PermissionConstants.MODEL_READ)
@log(menu='model', operate='Get the model creation form')
def get(self, request: Request):
provider = request.query_params.get('provider')
model_type = request.query_params.get('model_type')
model_name = request.query_params.get('model_name')
return result.success(
ModelProvideConstants[provider].value.get_model_credential(model_type, model_name).to_form_list())