refactor(django): 补充应用外壳层中文注释

This commit is contained in:
2026-05-30 00:53:43 +08:00
parent 43196f79e6
commit 0de6f6b2ff
11 changed files with 25 additions and 0 deletions

View File

@@ -5,6 +5,7 @@ from .models import AgentAuditLog, DemoBusinessRecord
@admin.register(AgentAuditLog)
class AgentAuditLogAdmin(admin.ModelAdmin):
"""便于在 Django Admin 中快速查看一次 Agent 执行的关键信息。"""
list_display = ("id", "scenario_name", "status", "model_name", "latency_ms", "created_at")
list_filter = ("status", "scenario_id")
search_fields = ("scenario_id", "scenario_name", "user_input", "final_answer")
@@ -12,6 +13,7 @@ class AgentAuditLogAdmin(admin.ModelAdmin):
@admin.register(DemoBusinessRecord)
class DemoBusinessRecordAdmin(admin.ModelAdmin):
"""管理工具查询依赖的示例业务记录。"""
list_display = ("id", "title", "scenario_id", "record_type", "created_at")
list_filter = ("scenario_id", "record_type")
search_fields = ("title", "scenario_id", "record_type")

View File

@@ -2,5 +2,6 @@ from django.apps import AppConfig
class AuditConfig(AppConfig):
"""Audit 模块应用配置。"""
default_auto_field = "django.db.models.BigAutoField"
name = "apps.audit"

View File

@@ -5,6 +5,7 @@ from . import views
app_name = "audit"
# V1 的审计功能由列表页和详情页组成,暂不拆分页或复杂筛选接口。
urlpatterns = [
path("", views.log_list, name="list"),
path("<int:log_id>/", views.log_detail, name="detail"),

View File

@@ -2,5 +2,6 @@ from django.apps import AppConfig
class ChatConfig(AppConfig):
"""Chat 模块应用配置。"""
default_auto_field = "django.db.models.BigAutoField"
name = "apps.chat"

View File

@@ -5,6 +5,7 @@ from . import views
app_name = "chat"
# 当前 V1 仅保留一个场景对话入口,场景详情合并在对话页中展示。
urlpatterns = [
path("<str:scenario_id>/", views.index, name="index"),
]

View File

@@ -5,6 +5,7 @@ from .models import UploadedDocument
@admin.register(UploadedDocument)
class UploadedDocumentAdmin(admin.ModelAdmin):
"""管理上传文档及其入库状态,便于后台排查问题。"""
list_display = ("id", "original_name", "scenario_id", "file_type", "status", "created_at")
list_filter = ("status", "scenario_id", "file_type")
search_fields = ("original_name", "scenario_id")

View File

@@ -2,5 +2,6 @@ from django.apps import AppConfig
class DocumentsConfig(AppConfig):
"""Documents 模块应用配置。"""
default_auto_field = "django.db.models.BigAutoField"
name = "apps.documents"

View File

@@ -5,6 +5,7 @@ from . import views
app_name = "documents"
# 文档模块对外暴露三个基础动作:列表、上传、手动入库。
urlpatterns = [
path("", views.document_list, name="list"),
path("upload/", views.upload, name="upload"),

View File

@@ -2,5 +2,6 @@ from django.apps import AppConfig
class ScenariosConfig(AppConfig):
"""Scenarios 模块应用配置。"""
default_auto_field = "django.db.models.BigAutoField"
name = "apps.scenarios"