From 41dd3c4f3d5bba0d0818d04cb7e298630e33725f Mon Sep 17 00:00:00 2001 From: shaohuzhang1 <80892890+shaohuzhang1@users.noreply.github.com> Date: Mon, 26 May 2025 18:39:53 +0800 Subject: [PATCH] feat: application view init (#3147) --- apps/application/api/application_api.py | 41 +++++ apps/application/serializers/application.py | 182 ++++++++++++++++++++ apps/application/views/application.py | 32 ++++ apps/maxkb/settings/base.py | 3 +- 4 files changed, 257 insertions(+), 1 deletion(-) create mode 100644 apps/application/api/application_api.py create mode 100644 apps/application/serializers/application.py create mode 100644 apps/application/views/application.py diff --git a/apps/application/api/application_api.py b/apps/application/api/application_api.py new file mode 100644 index 000000000..677e7ad99 --- /dev/null +++ b/apps/application/api/application_api.py @@ -0,0 +1,41 @@ +# coding=utf-8 +""" + @project: MaxKB + @Author：虎虎 + @file： application.py + @date：2025/5/26 16:59 + @desc: +""" +from django.utils.translation import gettext_lazy as _ +from drf_spectacular.types import OpenApiTypes +from drf_spectacular.utils import OpenApiParameter +from rest_framework import serializers + +from application.serializers.application import ApplicationCreateSerializer +from common.mixins.api_mixin import APIMixin + + +class ApplicationCreateRequest(ApplicationCreateSerializer.SimplateRequest): + work_flow = serializers.DictField(required=True, label=_("Workflow Objects")) + + +class ApplicationCreateAPI(APIMixin): + @staticmethod + def get_parameters(): + return [ + OpenApiParameter( + name="workspace_id", + description="工作空间id", + type=OpenApiTypes.STR, + location='path', + required=True, + ) + ] + + @staticmethod + def get_request(): + return ApplicationCreateRequest + + @staticmethod + def get_response(): + return FolderCreateResponse diff --git a/apps/application/serializers/application.py b/apps/application/serializers/application.py new file mode 100644 index 000000000..f9f3c661d --- /dev/null +++ b/apps/application/serializers/application.py @@ -0,0 +1,182 @@ +# coding=utf-8 +""" + @project: MaxKB + @Author：虎虎 + @file： application.py + @date：2025/5/26 17:03 + @desc: +""" +import re +from typing import Dict + +import uuid_utils.compat as uuid +from django.core import validators +from django.db import models +from django.db.models import QuerySet +from django.utils.translation import gettext_lazy as _ +from rest_framework import serializers + +from application.models.application import Application, ApplicationTypeChoices +from common.exception.app_exception import AppApiException +from knowledge.models import Knowledge +from models_provider.models import Model + + +class NoReferencesChoices(models.TextChoices): + """订单类型""" + ai_questioning = 'ai_questioning', 'ai回答' + designated_answer = 'designated_answer', '指定回答' + + +class NoReferencesSetting(serializers.Serializer): + status = serializers.ChoiceField(required=True, choices=NoReferencesChoices.choices, + label=_("No reference status")) + value = serializers.CharField(required=True, label=_("Prompt word")) + + +class KnowledgeSettingSerializer(serializers.Serializer): + top_n = serializers.FloatField(required=True, max_value=10000, min_value=1, + label=_("Reference segment number")) + similarity = serializers.FloatField(required=True, max_value=1, min_value=0, + label=_("Acquaintance")) + max_paragraph_char_number = serializers.IntegerField(required=True, min_value=500, max_value=100000, + label=_("Maximum number of quoted characters")) + search_mode = serializers.CharField(required=True, validators=[ + validators.RegexValidator(regex=re.compile("^embedding|keywords|blend$"), + message=_("The type only supports embedding|keywords|blend"), code=500) + ], label=_("Retrieval Mode")) + + no_references_setting = NoReferencesSetting(required=True, + label=_("Segment settings not referenced")) + + +class ModelKnowledgeAssociation(serializers.Serializer): + user_id = serializers.UUIDField(required=True, label=_("User ID")) + model_id = serializers.CharField(required=False, allow_null=True, allow_blank=True, + label=_("Model id")) + Knowledge_id_list = serializers.ListSerializer(required=False, child=serializers.UUIDField(required=True, + label=_( + "Knowledge base id")), + label=_("Knowledge Base List")) + + def is_valid(self, *, raise_exception=True): + super().is_valid(raise_exception=True) + model_id = self.data.get('model_id') + user_id = self.data.get('user_id') + if model_id is not None and len(model_id) > 0: + if not QuerySet(Model).filter(id=model_id).exists(): + raise AppApiException(500, f'{_("Model does not exist")}【{model_id}】') + knowledge_id_list = list(set(self.data.get('knowledge_id_list'))) + exist_knowledge_id_list = [str(knowledge.id) for knowledge in + QuerySet(Knowledge).filter(id__in=knowledge_id_list, user_id=user_id)] + for knowledge_id in knowledge_id_list: + if not exist_knowledge_id_list.__contains__(knowledge_id): + raise AppApiException(500, f'{_("The knowledge base id does not exist")}【{knowledge_id}】') + + +class ModelSettingSerializer(serializers.Serializer): + prompt = serializers.CharField(required=False, allow_null=True, allow_blank=True, max_length=102400, + label=_("Prompt word")) + system = serializers.CharField(required=False, allow_null=True, allow_blank=True, max_length=102400, + label=_("Role prompts")) + no_references_prompt = serializers.CharField(required=True, max_length=102400, allow_null=True, allow_blank=True, + label=_("No citation segmentation prompt")) + reasoning_content_enable = serializers.BooleanField(required=False, + label=_("Thinking process switch")) + reasoning_content_start = serializers.CharField(required=False, allow_null=True, default="", + allow_blank=True, max_length=256, + trim_whitespace=False, + label=_("The thinking process begins to mark")) + reasoning_content_end = serializers.CharField(required=False, allow_null=True, allow_blank=True, default="", + max_length=256, + trim_whitespace=False, + label=_("End of thinking process marker")) + + +class ApplicationCreateSerializer(serializers.Serializer): + class WorkflowRequest(serializers.Serializer): + name = serializers.CharField(required=True, max_length=64, min_length=1, + label=_("Application Name")) + desc = serializers.CharField(required=False, allow_null=True, allow_blank=True, + max_length=256, min_length=1, + label=_("Application Description")) + work_flow = serializers.DictField(required=True, label=_("Workflow Objects")) + prologue = serializers.CharField(required=False, allow_null=True, allow_blank=True, max_length=102400, + label=_("Opening remarks")) + + @staticmethod + def to_application_model(user_id: str, application: Dict): + default_workflow = application.get('work_flow') + for node in default_workflow.get('nodes'): + if node.get('id') == 'base-node': + node.get('properties')['node_data']['desc'] = application.get('desc') + node.get('properties')['node_data']['name'] = application.get('name') + node.get('properties')['node_data']['prologue'] = application.get('prologue') + return Application(id=uuid.uuid7(), + name=application.get('name'), + desc=application.get('desc'), + prologue="", + dialogue_number=0, + user_id=user_id, model_id=None, + knowledge_setting={}, + model_setting={}, + problem_optimization=False, + type=ApplicationTypeChoices.WORK_FLOW, + stt_model_enable=application.get('stt_model_enable', False), + stt_model_id=application.get('stt_model', None), + tts_model_id=application.get('tts_model', None), + tts_model_enable=application.get('tts_model_enable', False), + tts_model_params_setting=application.get('tts_model_params_setting', {}), + tts_type=application.get('tts_type', None), + file_upload_enable=application.get('file_upload_enable', False), + file_upload_setting=application.get('file_upload_setting', {}), + work_flow=default_workflow + ) + + class SimplateRequest(serializers.Serializer): + name = serializers.CharField(required=True, max_length=64, min_length=1, + label=_("application name")) + desc = serializers.CharField(required=False, allow_null=True, allow_blank=True, + max_length=256, min_length=1, + label=_("application describe")) + model_id = serializers.CharField(required=False, allow_null=True, allow_blank=True, + label=_("Model")) + dialogue_number = serializers.IntegerField(required=True, + min_value=0, + max_value=1024, + label=_("Historical chat records")) + prologue = serializers.CharField(required=False, allow_null=True, allow_blank=True, max_length=102400, + label=_("Opening remarks")) + knowledge_id_list = serializers.ListSerializer(required=False, child=serializers.UUIDField(required=True), + allow_null=True, + label=_("Related Knowledge Base")) + # 数据集相关设置 + knowledge_setting = KnowledgeSettingSerializer(required=True) + # 模型相关设置 + model_setting = ModelSettingSerializer(required=True) + # 问题补全 + problem_optimization = serializers.BooleanField(required=True, + label=_("Question completion")) + problem_optimization_prompt = serializers.CharField(required=False, max_length=102400, + label=_("Question completion prompt")) + # 应用类型 + type = serializers.CharField(required=True, label=_("Application Type"), + validators=[ + validators.RegexValidator(regex=re.compile("^SIMPLE|WORK_FLOW$"), + message=_( + "Application type only supports SIMPLE|WORK_FLOW"), + code=500) + ] + ) + model_params_setting = serializers.DictField(required=False, + label=_('Model parameters')) + + def is_valid(self, *, user_id=None, raise_exception=False): + super().is_valid(raise_exception=True) + ModelKnowledgeAssociation(data={'user_id': user_id, 'model_id': self.data.get('model_id'), + 'knowledge_id_list': self.data.get('knowledge_id_list')}).is_valid() + + +class ApplicationSerializer(serializers.Serializer): + def insert(self): + pass diff --git a/apps/application/views/application.py b/apps/application/views/application.py new file mode 100644 index 000000000..eae8044a5 --- /dev/null +++ b/apps/application/views/application.py @@ -0,0 +1,32 @@ +# coding=utf-8 +""" + @project: MaxKB + @Author：虎虎 + @file： application.py + @date：2025/5/26 16:51 + @desc: +""" +from django.utils.translation import gettext_lazy as _ +from drf_spectacular.utils import extend_schema +from rest_framework.request import Request +from rest_framework.views import APIView + +from application.api.application_api import ApplicationCreateAPI +from application.serializers.application import ApplicationSerializer +from common import result + + +class Application(APIView): + + @extend_schema( + methods=['POST'], + description=_('Create an application'), + summary=_('Create an application'), + operation_id=_('Create an application'), # type: ignore + parameters=ApplicationCreateAPI.get_parameters(), + request=ApplicationCreateAPI.get_request(), + responses=ApplicationCreateAPI.get_response(), + tags=[_('Application')] # type: ignore + ) + def post(self, request: Request): + return result.success(ApplicationSerializer.insert(request.data)) diff --git a/apps/maxkb/settings/base.py b/apps/maxkb/settings/base.py index a87635514..d44a5b6c2 100644 --- a/apps/maxkb/settings/base.py +++ b/apps/maxkb/settings/base.py @@ -44,7 +44,8 @@ INSTALLED_APPS = [ 'common', 'system_manage', 'models_provider', - 'django_celery_beat' + 'django_celery_beat', + 'application' ] MIDDLEWARE = [