fluent api (#27093)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

api/controllers/service_api/app/annotation.py

@@ -15,19 +15,19 @@ from models.model import App
 from services.annotation_service import AppAnnotationService
 
 # Define parsers for annotation API
-annotation_create_parser = reqparse.RequestParser()
-annotation_create_parser.add_argument("question", required=True, type=str, location="json", help="Annotation question")
-annotation_create_parser.add_argument("answer", required=True, type=str, location="json", help="Annotation answer")
+annotation_create_parser = (
+    reqparse.RequestParser()
+    .add_argument("question", required=True, type=str, location="json", help="Annotation question")
+    .add_argument("answer", required=True, type=str, location="json", help="Annotation answer")
+)
 
-annotation_reply_action_parser = reqparse.RequestParser()
-annotation_reply_action_parser.add_argument(
-    "score_threshold", required=True, type=float, location="json", help="Score threshold for annotation matching"
-)
-annotation_reply_action_parser.add_argument(
-    "embedding_provider_name", required=True, type=str, location="json", help="Embedding provider name"
-)
-annotation_reply_action_parser.add_argument(
-    "embedding_model_name", required=True, type=str, location="json", help="Embedding model name"
+annotation_reply_action_parser = (
+    reqparse.RequestParser()
+    .add_argument(
+        "score_threshold", required=True, type=float, location="json", help="Score threshold for annotation matching"
+    )
+    .add_argument("embedding_provider_name", required=True, type=str, location="json", help="Embedding provider name")
+    .add_argument("embedding_model_name", required=True, type=str, location="json", help="Embedding model name")
 )
 
 

api/controllers/service_api/app/audio.py

@@ -85,11 +85,13 @@ class AudioApi(Resource):
 
 
 # Define parser for text-to-audio API
-text_to_audio_parser = reqparse.RequestParser()
-text_to_audio_parser.add_argument("message_id", type=str, required=False, location="json", help="Message ID")
-text_to_audio_parser.add_argument("voice", type=str, location="json", help="Voice to use for TTS")
-text_to_audio_parser.add_argument("text", type=str, location="json", help="Text to convert to audio")
-text_to_audio_parser.add_argument("streaming", type=bool, location="json", help="Enable streaming response")
+text_to_audio_parser = (
+    reqparse.RequestParser()
+    .add_argument("message_id", type=str, required=False, location="json", help="Message ID")
+    .add_argument("voice", type=str, location="json", help="Voice to use for TTS")
+    .add_argument("text", type=str, location="json", help="Text to convert to audio")
+    .add_argument("streaming", type=bool, location="json", help="Enable streaming response")
+)
 
 
 @service_api_ns.route("/text-to-audio")

api/controllers/service_api/app/completion.py

@@ -37,40 +37,34 @@ logger = logging.getLogger(__name__)
 
 
 # Define parser for completion API
-completion_parser = reqparse.RequestParser()
-completion_parser.add_argument(
-    "inputs", type=dict, required=True, location="json", help="Input parameters for completion"
-)
-completion_parser.add_argument("query", type=str, location="json", default="", help="The query string")
-completion_parser.add_argument("files", type=list, required=False, location="json", help="List of file attachments")
-completion_parser.add_argument(
-    "response_mode", type=str, choices=["blocking", "streaming"], location="json", help="Response mode"
-)
-completion_parser.add_argument(
-    "retriever_from", type=str, required=False, default="dev", location="json", help="Retriever source"
+completion_parser = (
+    reqparse.RequestParser()
+    .add_argument("inputs", type=dict, required=True, location="json", help="Input parameters for completion")
+    .add_argument("query", type=str, location="json", default="", help="The query string")
+    .add_argument("files", type=list, required=False, location="json", help="List of file attachments")
+    .add_argument("response_mode", type=str, choices=["blocking", "streaming"], location="json", help="Response mode")
+    .add_argument("retriever_from", type=str, required=False, default="dev", location="json", help="Retriever source")
 )
 
 # Define parser for chat API
-chat_parser = reqparse.RequestParser()
-chat_parser.add_argument("inputs", type=dict, required=True, location="json", help="Input parameters for chat")
-chat_parser.add_argument("query", type=str, required=True, location="json", help="The chat query")
-chat_parser.add_argument("files", type=list, required=False, location="json", help="List of file attachments")
-chat_parser.add_argument(
-    "response_mode", type=str, choices=["blocking", "streaming"], location="json", help="Response mode"
+chat_parser = (
+    reqparse.RequestParser()
+    .add_argument("inputs", type=dict, required=True, location="json", help="Input parameters for chat")
+    .add_argument("query", type=str, required=True, location="json", help="The chat query")
+    .add_argument("files", type=list, required=False, location="json", help="List of file attachments")
+    .add_argument("response_mode", type=str, choices=["blocking", "streaming"], location="json", help="Response mode")
+    .add_argument("conversation_id", type=uuid_value, location="json", help="Existing conversation ID")
+    .add_argument("retriever_from", type=str, required=False, default="dev", location="json", help="Retriever source")
+    .add_argument(
+        "auto_generate_name",
+        type=bool,
+        required=False,
+        default=True,
+        location="json",
+        help="Auto generate conversation name",
+    )
+    .add_argument("workflow_id", type=str, required=False, location="json", help="Workflow ID for advanced chat")
 )
-chat_parser.add_argument("conversation_id", type=uuid_value, location="json", help="Existing conversation ID")
-chat_parser.add_argument(
-    "retriever_from", type=str, required=False, default="dev", location="json", help="Retriever source"
-)
-chat_parser.add_argument(
-    "auto_generate_name",
-    type=bool,
-    required=False,
-    default=True,
-    location="json",
-    help="Auto generate conversation name",
-)
-chat_parser.add_argument("workflow_id", type=str, required=False, location="json", help="Workflow ID for advanced chat")
 
 
 @service_api_ns.route("/completion-messages")

api/controllers/service_api/app/conversation.py

@@ -24,48 +24,63 @@ from models.model import App, AppMode, EndUser
 from services.conversation_service import ConversationService
 
 # Define parsers for conversation APIs
-conversation_list_parser = reqparse.RequestParser()
-conversation_list_parser.add_argument(
-    "last_id", type=uuid_value, location="args", help="Last conversation ID for pagination"
-)
-conversation_list_parser.add_argument(
-    "limit",
-    type=int_range(1, 100),
-    required=False,
-    default=20,
-    location="args",
-    help="Number of conversations to return",
-)
-conversation_list_parser.add_argument(
-    "sort_by",
-    type=str,
-    choices=["created_at", "-created_at", "updated_at", "-updated_at"],
-    required=False,
-    default="-updated_at",
-    location="args",
-    help="Sort order for conversations",
+conversation_list_parser = (
+    reqparse.RequestParser()
+    .add_argument("last_id", type=uuid_value, location="args", help="Last conversation ID for pagination")
+    .add_argument(
+        "limit",
+        type=int_range(1, 100),
+        required=False,
+        default=20,
+        location="args",
+        help="Number of conversations to return",
+    )
+    .add_argument(
+        "sort_by",
+        type=str,
+        choices=["created_at", "-created_at", "updated_at", "-updated_at"],
+        required=False,
+        default="-updated_at",
+        location="args",
+        help="Sort order for conversations",
+    )
 )
 
-conversation_rename_parser = reqparse.RequestParser()
-conversation_rename_parser.add_argument("name", type=str, required=False, location="json", help="New conversation name")
-conversation_rename_parser.add_argument(
-    "auto_generate", type=bool, required=False, default=False, location="json", help="Auto-generate conversation name"
+conversation_rename_parser = (
+    reqparse.RequestParser()
+    .add_argument("name", type=str, required=False, location="json", help="New conversation name")
+    .add_argument(
+        "auto_generate",
+        type=bool,
+        required=False,
+        default=False,
+        location="json",
+        help="Auto-generate conversation name",
+    )
 )
 
-conversation_variables_parser = reqparse.RequestParser()
-conversation_variables_parser.add_argument(
-    "last_id", type=uuid_value, location="args", help="Last variable ID for pagination"
-)
-conversation_variables_parser.add_argument(
-    "limit", type=int_range(1, 100), required=False, default=20, location="args", help="Number of variables to return"
+conversation_variables_parser = (
+    reqparse.RequestParser()
+    .add_argument("last_id", type=uuid_value, location="args", help="Last variable ID for pagination")
+    .add_argument(
+        "limit",
+        type=int_range(1, 100),
+        required=False,
+        default=20,
+        location="args",
+        help="Number of variables to return",
+    )
 )
 
-conversation_variable_update_parser = reqparse.RequestParser()
-# using lambda is for passing the already-typed value without modification
-# if no lambda, it will be converted to string
-# the string cannot be converted using json.loads
-conversation_variable_update_parser.add_argument(
-    "value", required=True, location="json", type=lambda x: x, help="New value for the conversation variable"
+conversation_variable_update_parser = reqparse.RequestParser().add_argument(
+    # using lambda is for passing the already-typed value without modification
+    # if no lambda, it will be converted to string
+    # the string cannot be converted using json.loads
+    "value",
+    required=True,
+    location="json",
+    type=lambda x: x,
+    help="New value for the conversation variable",
 )
 
 

api/controllers/service_api/app/file_preview.py

@@ -18,8 +18,7 @@ logger = logging.getLogger(__name__)
 
 
 # Define parser for file preview API
-file_preview_parser = reqparse.RequestParser()
-file_preview_parser.add_argument(
+file_preview_parser = reqparse.RequestParser().add_argument(
     "as_attachment", type=bool, required=False, default=False, location="args", help="Download as attachment"
 )
 

api/controllers/service_api/app/message.py

@@ -26,25 +26,37 @@ logger = logging.getLogger(__name__)
 
 
 # Define parsers for message APIs
-message_list_parser = reqparse.RequestParser()
-message_list_parser.add_argument(
-    "conversation_id", required=True, type=uuid_value, location="args", help="Conversation ID"
-)
-message_list_parser.add_argument("first_id", type=uuid_value, location="args", help="First message ID for pagination")
-message_list_parser.add_argument(
-    "limit", type=int_range(1, 100), required=False, default=20, location="args", help="Number of messages to return"
+message_list_parser = (
+    reqparse.RequestParser()
+    .add_argument("conversation_id", required=True, type=uuid_value, location="args", help="Conversation ID")
+    .add_argument("first_id", type=uuid_value, location="args", help="First message ID for pagination")
+    .add_argument(
+        "limit",
+        type=int_range(1, 100),
+        required=False,
+        default=20,
+        location="args",
+        help="Number of messages to return",
+    )
 )
 
-message_feedback_parser = reqparse.RequestParser()
-message_feedback_parser.add_argument(
-    "rating", type=str, choices=["like", "dislike", None], location="json", help="Feedback rating"
+message_feedback_parser = (
+    reqparse.RequestParser()
+    .add_argument("rating", type=str, choices=["like", "dislike", None], location="json", help="Feedback rating")
+    .add_argument("content", type=str, location="json", help="Feedback content")
 )
-message_feedback_parser.add_argument("content", type=str, location="json", help="Feedback content")
 
-feedback_list_parser = reqparse.RequestParser()
-feedback_list_parser.add_argument("page", type=int, default=1, location="args", help="Page number")
-feedback_list_parser.add_argument(
-    "limit", type=int_range(1, 101), required=False, default=20, location="args", help="Number of feedbacks per page"
+feedback_list_parser = (
+    reqparse.RequestParser()
+    .add_argument("page", type=int, default=1, location="args", help="Page number")
+    .add_argument(
+        "limit",
+        type=int_range(1, 101),
+        required=False,
+        default=20,
+        location="args",
+        help="Number of feedbacks per page",
+    )
 )
 
 

api/controllers/service_api/app/workflow.py

@@ -42,32 +42,36 @@ from services.workflow_app_service import WorkflowAppService
 logger = logging.getLogger(__name__)
 
 # Define parsers for workflow APIs
-workflow_run_parser = reqparse.RequestParser()
-workflow_run_parser.add_argument("inputs", type=dict, required=True, nullable=False, location="json")
-workflow_run_parser.add_argument("files", type=list, required=False, location="json")
-workflow_run_parser.add_argument("response_mode", type=str, choices=["blocking", "streaming"], location="json")
+workflow_run_parser = (
+    reqparse.RequestParser()
+    .add_argument("inputs", type=dict, required=True, nullable=False, location="json")
+    .add_argument("files", type=list, required=False, location="json")
+    .add_argument("response_mode", type=str, choices=["blocking", "streaming"], location="json")
+)
 
-workflow_log_parser = reqparse.RequestParser()
-workflow_log_parser.add_argument("keyword", type=str, location="args")
-workflow_log_parser.add_argument("status", type=str, choices=["succeeded", "failed", "stopped"], location="args")
-workflow_log_parser.add_argument("created_at__before", type=str, location="args")
-workflow_log_parser.add_argument("created_at__after", type=str, location="args")
-workflow_log_parser.add_argument(
-    "created_by_end_user_session_id",
-    type=str,
-    location="args",
-    required=False,
-    default=None,
+workflow_log_parser = (
+    reqparse.RequestParser()
+    .add_argument("keyword", type=str, location="args")
+    .add_argument("status", type=str, choices=["succeeded", "failed", "stopped"], location="args")
+    .add_argument("created_at__before", type=str, location="args")
+    .add_argument("created_at__after", type=str, location="args")
+    .add_argument(
+        "created_by_end_user_session_id",
+        type=str,
+        location="args",
+        required=False,
+        default=None,
+    )
+    .add_argument(
+        "created_by_account",
+        type=str,
+        location="args",
+        required=False,
+        default=None,
+    )
+    .add_argument("page", type=int_range(1, 99999), default=1, location="args")
+    .add_argument("limit", type=int_range(1, 100), default=20, location="args")
 )
-workflow_log_parser.add_argument(
-    "created_by_account",
-    type=str,
-    location="args",
-    required=False,
-    default=None,
-)
-workflow_log_parser.add_argument("page", type=int_range(1, 99999), default=1, location="args")
-workflow_log_parser.add_argument("limit", type=int_range(1, 100), default=20, location="args")
 
 workflow_run_fields = {
     "id": fields.String,

api/controllers/service_api/dataset/dataset.py

@@ -33,119 +33,118 @@ def _validate_name(name):
 
 
 # Define parsers for dataset operations
-dataset_create_parser = reqparse.RequestParser()
-dataset_create_parser.add_argument(
-    "name",
-    nullable=False,
-    required=True,
-    help="type is required. Name must be between 1 to 40 characters.",
-    type=_validate_name,
-)
-dataset_create_parser.add_argument(
-    "description",
-    type=validate_description_length,
-    nullable=True,
-    required=False,
-    default="",
-)
-dataset_create_parser.add_argument(
-    "indexing_technique",
-    type=str,
-    location="json",
-    choices=Dataset.INDEXING_TECHNIQUE_LIST,
-    help="Invalid indexing technique.",
-)
-dataset_create_parser.add_argument(
-    "permission",
-    type=str,
-    location="json",
-    choices=(DatasetPermissionEnum.ONLY_ME, DatasetPermissionEnum.ALL_TEAM, DatasetPermissionEnum.PARTIAL_TEAM),
-    help="Invalid permission.",
-    required=False,
-    nullable=False,
-)
-dataset_create_parser.add_argument(
-    "external_knowledge_api_id",
-    type=str,
-    nullable=True,
-    required=False,
-    default="_validate_name",
-)
-dataset_create_parser.add_argument(
-    "provider",
-    type=str,
-    nullable=True,
-    required=False,
-    default="vendor",
-)
-dataset_create_parser.add_argument(
-    "external_knowledge_id",
-    type=str,
-    nullable=True,
-    required=False,
-)
-dataset_create_parser.add_argument("retrieval_model", type=dict, required=False, nullable=True, location="json")
-dataset_create_parser.add_argument("embedding_model", type=str, required=False, nullable=True, location="json")
-dataset_create_parser.add_argument("embedding_model_provider", type=str, required=False, nullable=True, location="json")
-
-dataset_update_parser = reqparse.RequestParser()
-dataset_update_parser.add_argument(
-    "name",
-    nullable=False,
-    help="type is required. Name must be between 1 to 40 characters.",
-    type=_validate_name,
-)
-dataset_update_parser.add_argument(
-    "description", location="json", store_missing=False, type=validate_description_length
-)
-dataset_update_parser.add_argument(
-    "indexing_technique",
-    type=str,
-    location="json",
-    choices=Dataset.INDEXING_TECHNIQUE_LIST,
-    nullable=True,
-    help="Invalid indexing technique.",
-)
-dataset_update_parser.add_argument(
-    "permission",
-    type=str,
-    location="json",
-    choices=(DatasetPermissionEnum.ONLY_ME, DatasetPermissionEnum.ALL_TEAM, DatasetPermissionEnum.PARTIAL_TEAM),
-    help="Invalid permission.",
-)
-dataset_update_parser.add_argument("embedding_model", type=str, location="json", help="Invalid embedding model.")
-dataset_update_parser.add_argument(
-    "embedding_model_provider", type=str, location="json", help="Invalid embedding model provider."
-)
-dataset_update_parser.add_argument("retrieval_model", type=dict, location="json", help="Invalid retrieval model.")
-dataset_update_parser.add_argument("partial_member_list", type=list, location="json", help="Invalid parent user list.")
-dataset_update_parser.add_argument(
-    "external_retrieval_model",
-    type=dict,
-    required=False,
-    nullable=True,
-    location="json",
-    help="Invalid external retrieval model.",
-)
-dataset_update_parser.add_argument(
-    "external_knowledge_id",
-    type=str,
-    required=False,
-    nullable=True,
-    location="json",
-    help="Invalid external knowledge id.",
-)
-dataset_update_parser.add_argument(
-    "external_knowledge_api_id",
-    type=str,
-    required=False,
-    nullable=True,
-    location="json",
-    help="Invalid external knowledge api id.",
+dataset_create_parser = (
+    reqparse.RequestParser()
+    .add_argument(
+        "name",
+        nullable=False,
+        required=True,
+        help="type is required. Name must be between 1 to 40 characters.",
+        type=_validate_name,
+    )
+    .add_argument(
+        "description",
+        type=validate_description_length,
+        nullable=True,
+        required=False,
+        default="",
+    )
+    .add_argument(
+        "indexing_technique",
+        type=str,
+        location="json",
+        choices=Dataset.INDEXING_TECHNIQUE_LIST,
+        help="Invalid indexing technique.",
+    )
+    .add_argument(
+        "permission",
+        type=str,
+        location="json",
+        choices=(DatasetPermissionEnum.ONLY_ME, DatasetPermissionEnum.ALL_TEAM, DatasetPermissionEnum.PARTIAL_TEAM),
+        help="Invalid permission.",
+        required=False,
+        nullable=False,
+    )
+    .add_argument(
+        "external_knowledge_api_id",
+        type=str,
+        nullable=True,
+        required=False,
+        default="_validate_name",
+    )
+    .add_argument(
+        "provider",
+        type=str,
+        nullable=True,
+        required=False,
+        default="vendor",
+    )
+    .add_argument(
+        "external_knowledge_id",
+        type=str,
+        nullable=True,
+        required=False,
+    )
+    .add_argument("retrieval_model", type=dict, required=False, nullable=True, location="json")
+    .add_argument("embedding_model", type=str, required=False, nullable=True, location="json")
+    .add_argument("embedding_model_provider", type=str, required=False, nullable=True, location="json")
 )
 
-tag_create_parser = reqparse.RequestParser()
-tag_create_parser.add_argument(
+dataset_update_parser = (
+    reqparse.RequestParser()
+    .add_argument(
+        "name",
+        nullable=False,
+        help="type is required. Name must be between 1 to 40 characters.",
+        type=_validate_name,
+    )
+    .add_argument("description", location="json", store_missing=False, type=validate_description_length)
+    .add_argument(
+        "indexing_technique",
+        type=str,
+        location="json",
+        choices=Dataset.INDEXING_TECHNIQUE_LIST,
+        nullable=True,
+        help="Invalid indexing technique.",
+    )
+    .add_argument(
+        "permission",
+        type=str,
+        location="json",
+        choices=(DatasetPermissionEnum.ONLY_ME, DatasetPermissionEnum.ALL_TEAM, DatasetPermissionEnum.PARTIAL_TEAM),
+        help="Invalid permission.",
+    )
+    .add_argument("embedding_model", type=str, location="json", help="Invalid embedding model.")
+    .add_argument("embedding_model_provider", type=str, location="json", help="Invalid embedding model provider.")
+    .add_argument("retrieval_model", type=dict, location="json", help="Invalid retrieval model.")
+    .add_argument("partial_member_list", type=list, location="json", help="Invalid parent user list.")
+    .add_argument(
+        "external_retrieval_model",
+        type=dict,
+        required=False,
+        nullable=True,
+        location="json",
+        help="Invalid external retrieval model.",
+    )
+    .add_argument(
+        "external_knowledge_id",
+        type=str,
+        required=False,
+        nullable=True,
+        location="json",
+        help="Invalid external knowledge id.",
+    )
+    .add_argument(
+        "external_knowledge_api_id",
+        type=str,
+        required=False,
+        nullable=True,
+        location="json",
+        help="Invalid external knowledge api id.",
+    )
+)
+
+tag_create_parser = reqparse.RequestParser().add_argument(
     "name",
     nullable=False,
     required=True,
@@ -155,32 +154,37 @@ tag_create_parser.add_argument(
     else (_ for _ in ()).throw(ValueError("Name must be between 1 to 50 characters.")),
 )
 
-tag_update_parser = reqparse.RequestParser()
-tag_update_parser.add_argument(
-    "name",
-    nullable=False,
-    required=True,
-    help="Name must be between 1 to 50 characters.",
-    type=lambda x: x
-    if x and 1 <= len(x) <= 50
-    else (_ for _ in ()).throw(ValueError("Name must be between 1 to 50 characters.")),
-)
-tag_update_parser.add_argument("tag_id", nullable=False, required=True, help="Id of a tag.", type=str)
-
-tag_delete_parser = reqparse.RequestParser()
-tag_delete_parser.add_argument("tag_id", nullable=False, required=True, help="Id of a tag.", type=str)
-
-tag_binding_parser = reqparse.RequestParser()
-tag_binding_parser.add_argument(
-    "tag_ids", type=list, nullable=False, required=True, location="json", help="Tag IDs is required."
-)
-tag_binding_parser.add_argument(
-    "target_id", type=str, nullable=False, required=True, location="json", help="Target Dataset ID is required."
+tag_update_parser = (
+    reqparse.RequestParser()
+    .add_argument(
+        "name",
+        nullable=False,
+        required=True,
+        help="Name must be between 1 to 50 characters.",
+        type=lambda x: x
+        if x and 1 <= len(x) <= 50
+        else (_ for _ in ()).throw(ValueError("Name must be between 1 to 50 characters.")),
+    )
+    .add_argument("tag_id", nullable=False, required=True, help="Id of a tag.", type=str)
 )
 
-tag_unbinding_parser = reqparse.RequestParser()
-tag_unbinding_parser.add_argument("tag_id", type=str, nullable=False, required=True, help="Tag ID is required.")
-tag_unbinding_parser.add_argument("target_id", type=str, nullable=False, required=True, help="Target ID is required.")
+tag_delete_parser = reqparse.RequestParser().add_argument(
+    "tag_id", nullable=False, required=True, help="Id of a tag.", type=str
+)
+
+tag_binding_parser = (
+    reqparse.RequestParser()
+    .add_argument("tag_ids", type=list, nullable=False, required=True, location="json", help="Tag IDs is required.")
+    .add_argument(
+        "target_id", type=str, nullable=False, required=True, location="json", help="Target Dataset ID is required."
+    )
+)
+
+tag_unbinding_parser = (
+    reqparse.RequestParser()
+    .add_argument("tag_id", type=str, nullable=False, required=True, help="Tag ID is required.")
+    .add_argument("target_id", type=str, nullable=False, required=True, help="Target ID is required.")
+)
 
 
 @service_api_ns.route("/datasets")

api/controllers/service_api/dataset/document.py

@@ -35,37 +35,31 @@ from services.entities.knowledge_entities.knowledge_entities import KnowledgeCon
 from services.file_service import FileService
 
 # Define parsers for document operations
-document_text_create_parser = reqparse.RequestParser()
-document_text_create_parser.add_argument("name", type=str, required=True, nullable=False, location="json")
-document_text_create_parser.add_argument("text", type=str, required=True, nullable=False, location="json")
-document_text_create_parser.add_argument("process_rule", type=dict, required=False, nullable=True, location="json")
-document_text_create_parser.add_argument("original_document_id", type=str, required=False, location="json")
-document_text_create_parser.add_argument(
-    "doc_form", type=str, default="text_model", required=False, nullable=False, location="json"
-)
-document_text_create_parser.add_argument(
-    "doc_language", type=str, default="English", required=False, nullable=False, location="json"
-)
-document_text_create_parser.add_argument(
-    "indexing_technique", type=str, choices=Dataset.INDEXING_TECHNIQUE_LIST, nullable=False, location="json"
-)
-document_text_create_parser.add_argument("retrieval_model", type=dict, required=False, nullable=True, location="json")
-document_text_create_parser.add_argument("embedding_model", type=str, required=False, nullable=True, location="json")
-document_text_create_parser.add_argument(
-    "embedding_model_provider", type=str, required=False, nullable=True, location="json"
+document_text_create_parser = (
+    reqparse.RequestParser()
+    .add_argument("name", type=str, required=True, nullable=False, location="json")
+    .add_argument("text", type=str, required=True, nullable=False, location="json")
+    .add_argument("process_rule", type=dict, required=False, nullable=True, location="json")
+    .add_argument("original_document_id", type=str, required=False, location="json")
+    .add_argument("doc_form", type=str, default="text_model", required=False, nullable=False, location="json")
+    .add_argument("doc_language", type=str, default="English", required=False, nullable=False, location="json")
+    .add_argument(
+        "indexing_technique", type=str, choices=Dataset.INDEXING_TECHNIQUE_LIST, nullable=False, location="json"
+    )
+    .add_argument("retrieval_model", type=dict, required=False, nullable=True, location="json")
+    .add_argument("embedding_model", type=str, required=False, nullable=True, location="json")
+    .add_argument("embedding_model_provider", type=str, required=False, nullable=True, location="json")
 )
 
-document_text_update_parser = reqparse.RequestParser()
-document_text_update_parser.add_argument("name", type=str, required=False, nullable=True, location="json")
-document_text_update_parser.add_argument("text", type=str, required=False, nullable=True, location="json")
-document_text_update_parser.add_argument("process_rule", type=dict, required=False, nullable=True, location="json")
-document_text_update_parser.add_argument(
-    "doc_form", type=str, default="text_model", required=False, nullable=False, location="json"
+document_text_update_parser = (
+    reqparse.RequestParser()
+    .add_argument("name", type=str, required=False, nullable=True, location="json")
+    .add_argument("text", type=str, required=False, nullable=True, location="json")
+    .add_argument("process_rule", type=dict, required=False, nullable=True, location="json")
+    .add_argument("doc_form", type=str, default="text_model", required=False, nullable=False, location="json")
+    .add_argument("doc_language", type=str, default="English", required=False, nullable=False, location="json")
+    .add_argument("retrieval_model", type=dict, required=False, nullable=False, location="json")
 )
-document_text_update_parser.add_argument(
-    "doc_language", type=str, default="English", required=False, nullable=False, location="json"
-)
-document_text_update_parser.add_argument("retrieval_model", type=dict, required=False, nullable=False, location="json")
 
 
 @service_api_ns.route(

api/controllers/service_api/dataset/metadata.py

@@ -15,21 +15,17 @@ from services.entities.knowledge_entities.knowledge_entities import (
 from services.metadata_service import MetadataService
 
 # Define parsers for metadata APIs
-metadata_create_parser = reqparse.RequestParser()
-metadata_create_parser.add_argument(
-    "type", type=str, required=True, nullable=False, location="json", help="Metadata type"
-)
-metadata_create_parser.add_argument(
-    "name", type=str, required=True, nullable=False, location="json", help="Metadata name"
+metadata_create_parser = (
+    reqparse.RequestParser()
+    .add_argument("type", type=str, required=True, nullable=False, location="json", help="Metadata type")
+    .add_argument("name", type=str, required=True, nullable=False, location="json", help="Metadata name")
 )
 
-metadata_update_parser = reqparse.RequestParser()
-metadata_update_parser.add_argument(
+metadata_update_parser = reqparse.RequestParser().add_argument(
     "name", type=str, required=True, nullable=False, location="json", help="New metadata name"
 )
 
-document_metadata_parser = reqparse.RequestParser()
-document_metadata_parser.add_argument(
+document_metadata_parser = reqparse.RequestParser().add_argument(
     "operation_data", type=list, required=True, nullable=False, location="json", help="Metadata operation data"
 )
 

api/controllers/service_api/dataset/rag_pipeline/rag_pipeline_workflow.py

@@ -91,11 +91,13 @@ class DatasourceNodeRunApi(DatasetApiResource):
     def post(self, tenant_id: str, dataset_id: str, node_id: str):
         """Resource for getting datasource plugins."""
         # Get query parameter to determine published or draft
-        parser: RequestParser = reqparse.RequestParser()
-        parser.add_argument("inputs", type=dict, required=True, nullable=False, location="json")
-        parser.add_argument("datasource_type", type=str, required=True, location="json")
-        parser.add_argument("credential_id", type=str, required=False, location="json")
-        parser.add_argument("is_published", type=bool, required=True, location="json")
+        parser: RequestParser = (
+            reqparse.RequestParser()
+            .add_argument("inputs", type=dict, required=True, nullable=False, location="json")
+            .add_argument("datasource_type", type=str, required=True, location="json")
+            .add_argument("credential_id", type=str, required=False, location="json")
+            .add_argument("is_published", type=bool, required=True, location="json")
+        )
         args: ParseResult = parser.parse_args()
 
         datasource_node_run_api_entity = DatasourceNodeRunApiEntity.model_validate(args)
@@ -147,19 +149,21 @@ class PipelineRunApi(DatasetApiResource):
     )
     def post(self, tenant_id: str, dataset_id: str):
         """Resource for running a rag pipeline."""
-        parser: RequestParser = reqparse.RequestParser()
-        parser.add_argument("inputs", type=dict, required=True, nullable=False, location="json")
-        parser.add_argument("datasource_type", type=str, required=True, location="json")
-        parser.add_argument("datasource_info_list", type=list, required=True, location="json")
-        parser.add_argument("start_node_id", type=str, required=True, location="json")
-        parser.add_argument("is_published", type=bool, required=True, default=True, location="json")
-        parser.add_argument(
-            "response_mode",
-            type=str,
-            required=True,
-            choices=["streaming", "blocking"],
-            default="blocking",
-            location="json",
+        parser: RequestParser = (
+            reqparse.RequestParser()
+            .add_argument("inputs", type=dict, required=True, nullable=False, location="json")
+            .add_argument("datasource_type", type=str, required=True, location="json")
+            .add_argument("datasource_info_list", type=list, required=True, location="json")
+            .add_argument("start_node_id", type=str, required=True, location="json")
+            .add_argument("is_published", type=bool, required=True, default=True, location="json")
+            .add_argument(
+                "response_mode",
+                type=str,
+                required=True,
+                choices=["streaming", "blocking"],
+                default="blocking",
+                location="json",
+            )
         )
         args: ParseResult = parser.parse_args()
 

api/controllers/service_api/dataset/segment.py

@@ -24,26 +24,34 @@ from services.errors.chunk import ChildChunkDeleteIndexError as ChildChunkDelete
 from services.errors.chunk import ChildChunkIndexingError as ChildChunkIndexingServiceError
 
 # Define parsers for segment operations
-segment_create_parser = reqparse.RequestParser()
-segment_create_parser.add_argument("segments", type=list, required=False, nullable=True, location="json")
+segment_create_parser = reqparse.RequestParser().add_argument(
+    "segments", type=list, required=False, nullable=True, location="json"
+)
 
-segment_list_parser = reqparse.RequestParser()
-segment_list_parser.add_argument("status", type=str, action="append", default=[], location="args")
-segment_list_parser.add_argument("keyword", type=str, default=None, location="args")
+segment_list_parser = (
+    reqparse.RequestParser()
+    .add_argument("status", type=str, action="append", default=[], location="args")
+    .add_argument("keyword", type=str, default=None, location="args")
+)
 
-segment_update_parser = reqparse.RequestParser()
-segment_update_parser.add_argument("segment", type=dict, required=False, nullable=True, location="json")
+segment_update_parser = reqparse.RequestParser().add_argument(
+    "segment", type=dict, required=False, nullable=True, location="json"
+)
 
-child_chunk_create_parser = reqparse.RequestParser()
-child_chunk_create_parser.add_argument("content", type=str, required=True, nullable=False, location="json")
+child_chunk_create_parser = reqparse.RequestParser().add_argument(
+    "content", type=str, required=True, nullable=False, location="json"
+)
 
-child_chunk_list_parser = reqparse.RequestParser()
-child_chunk_list_parser.add_argument("limit", type=int, default=20, location="args")
-child_chunk_list_parser.add_argument("keyword", type=str, default=None, location="args")
-child_chunk_list_parser.add_argument("page", type=int, default=1, location="args")
+child_chunk_list_parser = (
+    reqparse.RequestParser()
+    .add_argument("limit", type=int, default=20, location="args")
+    .add_argument("keyword", type=str, default=None, location="args")
+    .add_argument("page", type=int, default=1, location="args")
+)
 
-child_chunk_update_parser = reqparse.RequestParser()
-child_chunk_update_parser.add_argument("content", type=str, required=True, nullable=False, location="json")
+child_chunk_update_parser = reqparse.RequestParser().add_argument(
+    "content", type=str, required=True, nullable=False, location="json"
+)
 
 
 @service_api_ns.route("/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/segments")