Skip to content

refactor: Add applicationId in generate prompt #4028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhanweizhang7 merged 1 commit into from
Sep 12, 2025
Merged

refactor: Add applicationId in generate prompt #4028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/application/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
path('workspace/<str:workspace_id>/application/<str:application_id>/speech_to_text', views.SpeechToText.as_view()),
path('workspace/<str:workspace_id>/application/<str:application_id>/play_demo_text', views.PlayDemoText.as_view()),
path('workspace/<str:workspace_id>/application/<str:application_id>/mcp_tools', views.McpServers.as_view()),
path('workspace/<str:workspace_id>/application/model/<str:model_id>/prompt_generate', views.PromptGenerateView.as_view()),
path('workspace/<str:workspace_id>/application/<str:application_id>/model/<str:model_id>/prompt_generate', views.PromptGenerateView.as_view()),
path('chat_message/<str:chat_id>', views.ChatView.as_view()),

]
Copy link
Contributor Author

@shaohuzhang1 shaohuzhang1 Sep 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your code is correct and free of errors. The only change you made between lines 34 and 35 is an additional slash (/) in path definition for the /model/<str:model_id>/prompt_generate URL pattern.

Optimization suggestion: Consider using regular expressions to capture specific paths more accurately if needed, but since this route does not require complex capturing rules, it remains straightforward and efficient.

24 changes: 21 additions & 3 deletions apps/application/views/application_chat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
@desc:
"""
import uuid_utils.compat as uuid
from django.db.models import QuerySet

from django.utils.translation import gettext_lazy as _
from drf_spectacular.utils import extend_schema
Expand All @@ -15,17 +16,25 @@

from application.api.application_chat import ApplicationChatQueryAPI, ApplicationChatQueryPageAPI, \
ApplicationChatExportAPI
from application.models import ChatUserType
from application.models import ChatUserType, Application
from application.serializers.application_chat import ApplicationChatQuerySerializers
from chat.api.chat_api import ChatAPI, PromptGenerateAPI
from chat.api.chat_authentication_api import ChatOpenAPI
from chat.serializers.chat import OpenChatSerializers, ChatSerializers, DebugChatSerializers, PromptGenerateSerializer
from common.auth import TokenAuth
from common.auth.authentication import has_permissions
from common.constants.permission_constants import PermissionConstants, RoleConstants, ViewPermission, CompareConstants
from common.log.log import log
from common.result import result
from common.utils.common import query_params_to_single_dict

def get_application_operation_object(application_id):
application_model = QuerySet(model=Application).filter(id=application_id).first()
if application_model is not None:
return {
'name': application_model.name
}
return {}

class ApplicationChat(APIView):
authentication_classes = [TokenAuth]
Expand Down Expand Up @@ -146,6 +155,7 @@ def post(self, request: Request, chat_id: str):
return DebugChatSerializers(data={'chat_id': chat_id}).chat(request.data)

class PromptGenerateView(APIView):
authentication_classes = [TokenAuth]

@extend_schema(
methods=['POST'],
Expand All @@ -157,5 +167,13 @@ class PromptGenerateView(APIView):
responses=None,
tags=[_('Application')] # type: ignore
)
def post(self, request: Request, workspace_id: str, model_id:str):
return PromptGenerateSerializer(data={'workspace_id': workspace_id, 'model_id': model_id}).generate_prompt(instance=request.data)
@has_permissions(PermissionConstants.APPLICATION_EDIT.get_workspace_application_permission(),
PermissionConstants.APPLICATION_EDIT.get_workspace_permission_workspace_manage_role(),
ViewPermission([RoleConstants.USER.get_workspace_role()],
[PermissionConstants.APPLICATION.get_workspace_application_permission()],
CompareConstants.AND),
RoleConstants.WORKSPACE_MANAGE.get_workspace_role())
@log(menu='Application', operate='Generate prompt',
get_operation_object=lambda r, k: get_application_operation_object(k.get('application_id')))
def post(self, request: Request, workspace_id: str, model_id:str, application_id: str):
return PromptGenerateSerializer(data={'workspace_id': workspace_id, 'model_id': model_id, 'application_id': application_id}).generate_prompt(instance=request.data)
Copy link
Contributor Author

@shaohuzhang1 shaohuzhang1 Sep 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The provided code appears to be clean, well-documented, and follows best practices for Django API development using DRF Spectacular for schema generation. However, there are a couple of minor optimizations and improvements that can be made:

Suggestions:

  1. Comments: Ensure all @extend_schema annotations have comments explaining their purpose (e.g., what they generate).
  2. Consistent Indentation: The last line of the post method in PromptGenerateView should not have an extra empty line at the end.

Revised Code with Improvements:

--- original_code.txt	2023-09-18 12:52:48.778866 +0100
+++ current_code.txt	2023-09-18 12:53:48.723767 +0100
@@ -146,6 +146,7 @@ def post(self, request: Request, chat_id: str):
         return DebugChatSerializers(data={'chat_id': chat_id}).chat(request.data)

 class PromptGenerateView(APIView):
+    authentication_classes = [TokenAuth]

     @extend_schema(
         methods=['POST'],
@@ -157,5 +158,13 @@ class PromptGenerateView(APIView):
         responses=None,
         tags=[_('Application')]  # type: ignore
     )
-    def post(self, request: Request, workspace_id: str, model_id:str):
-        return PromptGenerateSerializer(data={'workspace_id': workspace_id, 'model_id': model_id}).generate_prompt(instance=request.data)
\ No newline at end of file
+    @has_permissions(PermissionConstants.APPLICATION_EDIT.get_workspace_application_permission(),
+                     PermissionConstants.APPLICATION_EDIT.get_workspace_permission_workspace_manage_role(),
+                     ViewPermission([RoleConstants.USER.get_workspace_role()],
+                                    [PermissionConstants.APPLICATION.get_workspace_application_permission()],
+                                    CompareConstants.AND),
+                     RoleConstants.WORKSPACE_MANAGE.get_workspace_role())
+    @log(menu='Application', operate='Generate prompt',
+         get_operation_object=lambda r, k: get_application_operation_object(k.get('application_id')))
+    def post(self, request: Request, workspace_id: str, model_id:str, application_id: str):
+        return PromptGenerateSerializer(data={'workspace_id': workspace_id, 'model_id': model_id, 'application_id': application_id}).generate_prompt(instance=request.data)

These improvements ensure the code is more readable and maintainable.

10 changes: 9 additions & 1 deletion apps/chat/api/chat_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,15 @@ def get_parameters():
description="模型id",
type=OpenApiTypes.STR,
location='path',
required=True,)
required=True,
),
OpenApiParameter(
name="application_id",
description="应用id",
type=OpenApiTypes.STR,
location='path',
required=True,
),
]

@staticmethod
Copy link
Contributor Author

@shaohuzhang1 shaohuzhang1 Sep 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code you provided is a part of an API documentation generated by Swagger/OpenAPI. It includes several minor improvements and corrections:

  1. Whitespace Consistency: The spaces around required were incorrect; they should be aligned with the parameter values.

  2. Type Hinting: The usage of type= instead of types= in the OpenApiParameter definition was incorrect. This should not cause any functional issues but can lead to confusion if used incorrectly elsewhere.

  3. Documentation Improvements: The comments and descriptions within the code are clear, which is good practice for maintaining readability.

  4. Code Formatting: Overall, there are no syntax errors or major issues, and the formatting meets standard conventions.

If you have specific areas of concern or need further assistance, feel free to ask!

Expand Down
1 change: 1 addition & 0 deletions apps/chat/serializers/chat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ def chat(self, instance: dict, base_to_response: BaseToResponse = SystemToRespon
class PromptGenerateSerializer(serializers.Serializer):
workspace_id = serializers.CharField(required=False, label=_('Workspace ID'))
model_id = serializers.CharField(required=False, allow_blank=True, allow_null=True, label=_("Model"))
application_id = serializers.CharField(required=False, allow_blank=True, allow_null=True, label=_("Application"))

def generate_prompt(self, instance: dict, with_valid=True):
if with_valid:
Expand Down
Loading