use field

reorder

simplify

nit

nit

add assert

nit

Author: asukaminato0721

api/controllers/console/app/app.py

@@ -31,7 +31,6 @@
 from fields.workflow_fields import workflow_partial_fields as _workflow_partial_fields_dict
 from libs.helper import AppIconUrlField, TimestampField
 from libs.login import current_account_with_tenant, login_required
-from libs.validators import validate_description_length
 from models import App, Workflow
 from services.app_dsl_service import AppDslService, ImportMode
 from services.app_service import AppService
@@ -76,51 +75,30 @@ def validate_tag_ids(cls, value: str | list[str] | None) -> list[str] | None:
 
 class CreateAppPayload(BaseModel):
     name: str = Field(..., min_length=1, description="App name")
-    description: str | None = Field(default=None, description="App description (max 400 chars)")
+    description: str | None = Field(default=None, description="App description (max 400 chars)", max_length=400)
     mode: Literal["chat", "agent-chat", "advanced-chat", "workflow", "completion"] = Field(..., description="App mode")
     icon_type: str | None = Field(default=None, description="Icon type")
     icon: str | None = Field(default=None, description="Icon")
     icon_background: str | None = Field(default=None, description="Icon background color")
 
-    @field_validator("description")
-    @classmethod
-    def validate_description(cls, value: str | None) -> str | None:
-        if value is None:
-            return value
-        return validate_description_length(value)
-
 
 class UpdateAppPayload(BaseModel):
     name: str = Field(..., min_length=1, description="App name")
-    description: str | None = Field(default=None, description="App description (max 400 chars)")
+    description: str | None = Field(default=None, description="App description (max 400 chars)", max_length=400)
     icon_type: str | None = Field(default=None, description="Icon type")
     icon: str | None = Field(default=None, description="Icon")
     icon_background: str | None = Field(default=None, description="Icon background color")
     use_icon_as_answer_icon: bool | None = Field(default=None, description="Use icon as answer icon")
     max_active_requests: int | None = Field(default=None, description="Maximum active requests")
 
-    @field_validator("description")
-    @classmethod
-    def validate_description(cls, value: str | None) -> str | None:
-        if value is None:
-            return value
-        return validate_description_length(value)
-
 
 class CopyAppPayload(BaseModel):
     name: str | None = Field(default=None, description="Name for the copied app")
-    description: str | None = Field(default=None, description="Description for the copied app")
+    description: str | None = Field(default=None, description="Description for the copied app", max_length=400)
     icon_type: str | None = Field(default=None, description="Icon type")
     icon: str | None = Field(default=None, description="Icon")
     icon_background: str | None = Field(default=None, description="Icon background color")
 
-    @field_validator("description")
-    @classmethod
-    def validate_description(cls, value: str | None) -> str | None:
-        if value is None:
-            return value
-        return validate_description_length(value)
-
 
 class AppExportQuery(BaseModel):
     include_secret: bool = Field(default=False, description="Include secrets in export")

api/controllers/console/datasets/datasets.py

@@ -2,7 +2,7 @@
 
 from flask import request
 from flask_restx import Resource, fields, marshal, marshal_with
-from pydantic import BaseModel, field_validator
+from pydantic import BaseModel, Field, field_validator
 from sqlalchemy import select
 from werkzeug.exceptions import Forbidden, NotFound
 
@@ -50,7 +50,6 @@
 )
 from fields.document_fields import document_status_fields
 from libs.login import current_account_with_tenant, login_required
-from libs.validators import validate_description_length
 from models import ApiToken, Dataset, Document, DocumentSegment, UploadFile
 from models.dataset import DatasetPermissionEnum
 from models.provider_ids import ModelProviderID
@@ -109,12 +108,6 @@ def _get_or_create_model(model_name: str, field_def):
 related_app_list_model = _get_or_create_model("RelatedAppList", related_app_list_copy)
 
 
-def _validate_name(name: str) -> str:
-    if not name or len(name) < 1 or len(name) > 40:
-        raise ValueError("Name must be between 1 to 40 characters.")
-    return name
-
-
 def _validate_indexing_technique(value: str | None) -> str | None:
     if value is None:
         return value
@@ -124,24 +117,14 @@ def _validate_indexing_technique(value: str | None) -> str | None:
 
 
 class DatasetCreatePayload(BaseModel):
-    name: str
-    description: str = ""
+    name: str = Field(..., min_length=1, max_length=40)
+    description: str = Field("", max_length=400)
     indexing_technique: str | None = None
     permission: DatasetPermissionEnum | None = DatasetPermissionEnum.ONLY_ME
     provider: str = "vendor"
     external_knowledge_api_id: str | None = None
     external_knowledge_id: str | None = None
 
-    @field_validator("name")
-    @classmethod
-    def validate_name(cls, value: str) -> str:
-        return _validate_name(value)
-
-    @field_validator("description", mode="before")
-    @classmethod
-    def validate_description(cls, value: Any) -> str:
-        return validate_description_length(value or "")
-
     @field_validator("indexing_technique")
     @classmethod
     def validate_indexing(cls, value: str | None) -> str | None:
@@ -156,8 +139,8 @@ def validate_provider(cls, value: str) -> str:
 
 
 class DatasetUpdatePayload(BaseModel):
-    name: str | None = None
-    description: str | None = None
+    name: str | None = Field(None, min_length=1, max_length=40)
+    description: str | None = Field(None, max_length=400)
     permission: DatasetPermissionEnum | None = None
     indexing_technique: str | None = None
     embedding_model: str | None = None
@@ -169,18 +152,6 @@ class DatasetUpdatePayload(BaseModel):
     external_knowledge_api_id: str | None = None
     icon_info: dict[str, Any] | None = None
 
-    @field_validator("name")
-    @classmethod
-    def validate_name(cls, value: str | None) -> str | None:
-        return _validate_name(value) if value is not None else value
-
-    @field_validator("description", mode="before")
-    @classmethod
-    def validate_description(cls, value: Any) -> Any:
-        if value is None:
-            return value
-        return validate_description_length(value)
-
     @field_validator("indexing_technique")
     @classmethod
     def validate_indexing(cls, value: str | None) -> str | None:
@@ -451,22 +422,21 @@ def patch(self, dataset_id):
 
         payload = DatasetUpdatePayload.model_validate(console_ns.payload or {})
         payload_data = payload.model_dump(exclude_unset=True)
-        payload_raw = console_ns.payload or {}
         current_user, current_tenant_id = current_account_with_tenant()
 
         # check embedding model setting
         if (
-            payload_raw.get("indexing_technique") == "high_quality"
-            and payload_raw.get("embedding_model_provider") is not None
-            and payload_raw.get("embedding_model") is not None
+            payload.indexing_technique == "high_quality"
+            and payload.embedding_model_provider is not None
+            and payload.embedding_model is not None
         ):
             DatasetService.check_embedding_model_setting(
-                dataset.tenant_id, payload_raw.get("embedding_model_provider"), payload_raw.get("embedding_model")
+                dataset.tenant_id, payload.embedding_model_provider, payload.embedding_model
             )
 
         # The role of the current user in the ta table must be admin, owner, editor, or dataset_operator
         DatasetPermissionService.check_permission(
-            current_user, dataset, payload_data.get("permission"), payload_data.get("partial_member_list")
+            current_user, dataset, payload.permission, payload.partial_member_list
         )
 
         dataset = DatasetService.update_dataset(dataset_id_str, payload_data, current_user)
@@ -477,15 +447,10 @@ def patch(self, dataset_id):
         result_data = cast(dict[str, Any], marshal(dataset, dataset_detail_fields))
         tenant_id = current_tenant_id
 
-        if (
-            payload_data.get("partial_member_list")
-            and payload_data.get("permission") == DatasetPermissionEnum.PARTIAL_TEAM
-        ):
-            DatasetPermissionService.update_partial_member_list(
-                tenant_id, dataset_id_str, payload_data.get("partial_member_list")
-            )
+        if payload.partial_member_list is not None and payload.permission == DatasetPermissionEnum.PARTIAL_TEAM:
+            DatasetPermissionService.update_partial_member_list(tenant_id, dataset_id_str, payload.partial_member_list)
         # clear partial member list when permission is only_me or all_team_members
-        elif payload_data.get("permission") in {DatasetPermissionEnum.ONLY_ME, DatasetPermissionEnum.ALL_TEAM}:
+        elif payload.permission in {DatasetPermissionEnum.ONLY_ME, DatasetPermissionEnum.ALL_TEAM}:
             DatasetPermissionService.clear_partial_member_list(dataset_id_str)
 
         partial_member_list = DatasetPermissionService.get_dataset_partial_member_list(dataset_id_str)

api/controllers/console/datasets/external.py

@@ -1,6 +1,6 @@
 from flask import request
 from flask_restx import Resource, fields, marshal
-from pydantic import BaseModel, field_validator
+from pydantic import BaseModel, Field
 from werkzeug.exceptions import Forbidden, InternalServerError, NotFound
 
 import services
@@ -73,34 +73,18 @@ def _build_dataset_detail_model():
     dataset_detail_model = _build_dataset_detail_model()
 
 
-def _validate_name(name: str) -> str:
-    if not name or len(name) < 1 or len(name) > 100:
-        raise ValueError("Name must be between 1 to 100 characters.")
-    return name
-
-
 class ExternalKnowledgeApiPayload(BaseModel):
-    name: str
+    name: str = Field(..., min_length=1, max_length=40)
     settings: dict[str, object]
 
-    @field_validator("name")
-    @classmethod
-    def validate_name(cls, value: str) -> str:
-        return _validate_name(value)
-
 
 class ExternalDatasetCreatePayload(BaseModel):
     external_knowledge_api_id: str
     external_knowledge_id: str
-    name: str
-    description: str | None = None
+    name: str = Field(..., min_length=1, max_length=40)
+    description: str | None = Field(None, max_length=400)
     external_retrieval_model: dict[str, object] | None = None
 
-    @field_validator("name")
-    @classmethod
-    def validate_dataset_name(cls, value: str) -> str:
-        return _validate_name(value)
-
 
 class ExternalHitTestingPayload(BaseModel):
     query: str
@@ -312,6 +296,8 @@ def post(self, dataset_id):
         HitTestingService.hit_testing_args_check(payload.model_dump())
 
         try:
+            assert payload.external_retrieval_model is not None
+            assert payload.metadata_filtering_conditions is not None
             response = HitTestingService.external_retrieve(
                 dataset=dataset,
                 query=payload.query,

api/controllers/console/datasets/rag_pipeline/rag_pipeline.py

@@ -22,18 +22,6 @@
 logger = logging.getLogger(__name__)
 
 
-def _validate_name(name: str) -> str:
-    if not name or len(name) < 1 or len(name) > 40:
-        raise ValueError("Name must be between 1 to 40 characters.")
-    return name
-
-
-def _validate_description_length(description: str) -> str:
-    if len(description) > 400:
-        raise ValueError("Description cannot exceed 400 characters.")
-    return description
-
-
 @console_ns.route("/rag/pipeline/templates")
 class PipelineTemplateListApi(Resource):
     @setup_required
@@ -62,8 +50,8 @@ def get(self, template_id: str):
 
 
 class Payload(BaseModel):
-    name: str = Field(min_length=1, max_length=40)
-    description: str = Field(default="")
+    name: str = Field(..., min_length=1, max_length=40)
+    description: str = Field(default="", max_length=400)
     icon_info: dict[str, object] | None = None
 
 

api/controllers/console/datasets/rag_pipeline/rag_pipeline_import.py

@@ -50,7 +50,6 @@ def post(self):
         # Check user role first
         current_user, _ = current_account_with_tenant()
         payload = RagPipelineImportPayload.model_validate(console_ns.payload or {})
-        args = payload.model_dump()
 
         # Create service with session
         with Session(db.engine) as session:

api/controllers/console/datasets/rag_pipeline/rag_pipeline_workflow.py

@@ -671,14 +671,8 @@ def get(self, pipeline: Pipeline):
         """
         current_user, _ = current_account_with_tenant()
 
-        query = WorkflowListQuery.model_validate(
-            {
-                "page": request.args.get("page", type=int, default=1),
-                "limit": request.args.get("limit", type=int, default=10),
-                "user_id": request.args.get("user_id"),
-                "named_only": request.args.get("named_only"),
-            }
-        )
+        query = WorkflowListQuery.model_validate(request.args.to_dict())
+
         page = query.page
         limit = query.limit
         user_id = query.user_id
@@ -687,7 +681,6 @@ def get(self, pipeline: Pipeline):
         if user_id:
             if user_id != current_user.id:
                 raise Forbidden()
-            user_id = cast(str, user_id)
 
         rag_pipeline_service = RagPipelineService()
         with Session(db.engine) as session:

api/controllers/console/explore/saved_message.py

@@ -15,6 +15,19 @@
 from services.errors.message import MessageNotExistsError
 from services.saved_message_service import SavedMessageService
 
+
+class SavedMessageListQuery(BaseModel):
+    last_id: UUID | None = None
+    limit: int = Field(default=20, ge=1, le=100)
+
+
+class SavedMessageCreatePayload(BaseModel):
+    message_id: UUID
+
+
+register_schema_models(console_ns, SavedMessageListQuery, SavedMessageCreatePayload)
+
+
 feedback_fields = {"rating": fields.String}
 
 message_fields = {
@@ -44,12 +57,7 @@ def get(self, installed_app):
         if app_model.mode != "completion":
             raise NotCompletionAppError()
 
-        args = SavedMessageListQuery.model_validate(
-            {
-                "last_id": request.args.get("last_id"),
-                "limit": request.args.get("limit", default=20, type=int),
-            }
-        )
+        args = SavedMessageListQuery.model_validate(request.args.to_dict())
 
         return SavedMessageService.pagination_by_last_id(
             app_model,
@@ -91,15 +99,3 @@ def delete(self, installed_app, message_id):
         SavedMessageService.delete(app_model, current_user, message_id)
 
         return {"result": "success"}, 204
-
-
-class SavedMessageListQuery(BaseModel):
-    last_id: UUID | None = None
-    limit: int = Field(default=20, ge=1, le=100)
-
-
-class SavedMessageCreatePayload(BaseModel):
-    message_id: UUID
-
-
-register_schema_models(console_ns, SavedMessageListQuery, SavedMessageCreatePayload)

api/controllers/inner_api/mail.py

@@ -28,11 +28,11 @@ class BaseMail(Resource):
     @inner_api_ns.expect(inner_api_ns.models[InnerMailPayload.__name__])
     def post(self):
         args = InnerMailPayload.model_validate(inner_api_ns.payload or {})
-        send_inner_email_task.delay(  # type: ignore
+        send_inner_email_task.delay(
             to=args.to,
             subject=args.subject,
             body=args.body,
-            substitutions=args.substitutions,
+            substitutions=args.substitutions,  # type: ignore
         )
         return {"message": "success"}, 200