dify

dify/api/fields/_value_type_serializer.py

@@ -0,0 +1,18 @@
+from typing import TypedDict
+
+from core.variables.segments import Segment
+from core.variables.types import SegmentType
+
+
+class _VarTypedDict(TypedDict, total=False):
+    value_type: SegmentType
+
+
+def serialize_value_type(v: _VarTypedDict | Segment) -> str:
+    if isinstance(v, Segment):
+        return v.value_type.exposed_type().value
+    else:
+        value_type = v.get("value_type")
+        if value_type is None:
+            raise ValueError("value_type is required but not provided")
+        return value_type.exposed_type().value

dify/api/fields/annotation_fields.py

@@ -0,0 +1,36 @@
+from flask_restx import Api, Namespace, fields
+
+from libs.helper import TimestampField
+
+annotation_fields = {
+    "id": fields.String,
+    "question": fields.String,
+    "answer": fields.Raw(attribute="content"),
+    "hit_count": fields.Integer,
+    "created_at": TimestampField,
+    # 'account': fields.Nested(simple_account_fields, allow_null=True)
+}
+
+
+def build_annotation_model(api_or_ns: Api | Namespace):
+    """Build the annotation model for the API or Namespace."""
+    return api_or_ns.model("Annotation", annotation_fields)
+
+
+annotation_list_fields = {
+    "data": fields.List(fields.Nested(annotation_fields)),
+}
+
+annotation_hit_history_fields = {
+    "id": fields.String,
+    "source": fields.String,
+    "score": fields.Float,
+    "question": fields.String,
+    "created_at": TimestampField,
+    "match": fields.String(attribute="annotation_question"),
+    "response": fields.String(attribute="annotation_content"),
+}
+
+annotation_hit_history_list_fields = {
+    "data": fields.List(fields.Nested(annotation_hit_history_fields)),
+}

dify/api/fields/api_based_extension_fields.py

@@ -0,0 +1,23 @@
+from flask_restx import fields
+
+from libs.helper import TimestampField
+
+
+class HiddenAPIKey(fields.Raw):
+    def output(self, key, obj, **kwargs):
+        api_key = obj.api_key
+        # If the length of the api_key is less than 8 characters, show the first and last characters
+        if len(api_key) <= 8:
+            return api_key[0] + "******" + api_key[-1]
+        # If the api_key is greater than 8 characters, show the first three and the last three characters
+        else:
+            return api_key[:3] + "******" + api_key[-3:]
+
+
+api_based_extension_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "api_endpoint": fields.String,
+    "api_key": HiddenAPIKey,
+    "created_at": TimestampField,
+}

dify/api/fields/app_fields.py

@@ -0,0 +1,248 @@
+import json
+
+from flask_restx import fields
+
+from fields.workflow_fields import workflow_partial_fields
+from libs.helper import AppIconUrlField, TimestampField
+
+
+class JsonStringField(fields.Raw):
+    def format(self, value):
+        if isinstance(value, str):
+            try:
+                return json.loads(value)
+            except (json.JSONDecodeError, TypeError):
+                return value
+        return value
+
+
+app_detail_kernel_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "description": fields.String,
+    "mode": fields.String(attribute="mode_compatible_with_agent"),
+    "icon_type": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "icon_url": AppIconUrlField,
+}
+
+related_app_list = {
+    "data": fields.List(fields.Nested(app_detail_kernel_fields)),
+    "total": fields.Integer,
+}
+
+model_config_fields = {
+    "opening_statement": fields.String,
+    "suggested_questions": fields.Raw(attribute="suggested_questions_list"),
+    "suggested_questions_after_answer": fields.Raw(attribute="suggested_questions_after_answer_dict"),
+    "speech_to_text": fields.Raw(attribute="speech_to_text_dict"),
+    "text_to_speech": fields.Raw(attribute="text_to_speech_dict"),
+    "retriever_resource": fields.Raw(attribute="retriever_resource_dict"),
+    "annotation_reply": fields.Raw(attribute="annotation_reply_dict"),
+    "more_like_this": fields.Raw(attribute="more_like_this_dict"),
+    "sensitive_word_avoidance": fields.Raw(attribute="sensitive_word_avoidance_dict"),
+    "external_data_tools": fields.Raw(attribute="external_data_tools_list"),
+    "model": fields.Raw(attribute="model_dict"),
+    "user_input_form": fields.Raw(attribute="user_input_form_list"),
+    "dataset_query_variable": fields.String,
+    "pre_prompt": fields.String,
+    "agent_mode": fields.Raw(attribute="agent_mode_dict"),
+    "prompt_type": fields.String,
+    "chat_prompt_config": fields.Raw(attribute="chat_prompt_config_dict"),
+    "completion_prompt_config": fields.Raw(attribute="completion_prompt_config_dict"),
+    "dataset_configs": fields.Raw(attribute="dataset_configs_dict"),
+    "file_upload": fields.Raw(attribute="file_upload_dict"),
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+}
+
+tag_fields = {"id": fields.String, "name": fields.String, "type": fields.String}
+
+app_detail_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "description": fields.String,
+    "mode": fields.String(attribute="mode_compatible_with_agent"),
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "enable_site": fields.Boolean,
+    "enable_api": fields.Boolean,
+    "model_config": fields.Nested(model_config_fields, attribute="app_model_config", allow_null=True),
+    "workflow": fields.Nested(workflow_partial_fields, allow_null=True),
+    "tracing": fields.Raw,
+    "use_icon_as_answer_icon": fields.Boolean,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+    "access_mode": fields.String,
+    "tags": fields.List(fields.Nested(tag_fields)),
+}
+
+prompt_config_fields = {
+    "prompt_template": fields.String,
+}
+
+model_config_partial_fields = {
+    "model": fields.Raw(attribute="model_dict"),
+    "pre_prompt": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+}
+
+app_partial_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "max_active_requests": fields.Raw(),
+    "description": fields.String(attribute="desc_or_prompt"),
+    "mode": fields.String(attribute="mode_compatible_with_agent"),
+    "icon_type": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "icon_url": AppIconUrlField,
+    "model_config": fields.Nested(model_config_partial_fields, attribute="app_model_config", allow_null=True),
+    "workflow": fields.Nested(workflow_partial_fields, allow_null=True),
+    "use_icon_as_answer_icon": fields.Boolean,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+    "tags": fields.List(fields.Nested(tag_fields)),
+    "access_mode": fields.String,
+    "create_user_name": fields.String,
+    "author_name": fields.String,
+    "has_draft_trigger": fields.Boolean,
+}
+
+
+app_pagination_fields = {
+    "page": fields.Integer,
+    "limit": fields.Integer(attribute="per_page"),
+    "total": fields.Integer,
+    "has_more": fields.Boolean(attribute="has_next"),
+    "data": fields.List(fields.Nested(app_partial_fields), attribute="items"),
+}
+
+template_fields = {
+    "name": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "description": fields.String,
+    "mode": fields.String,
+    "model_config": fields.Nested(model_config_fields),
+}
+
+template_list_fields = {
+    "data": fields.List(fields.Nested(template_fields)),
+}
+
+site_fields = {
+    "access_token": fields.String(attribute="code"),
+    "code": fields.String,
+    "title": fields.String,
+    "icon_type": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "icon_url": AppIconUrlField,
+    "description": fields.String,
+    "default_language": fields.String,
+    "chat_color_theme": fields.String,
+    "chat_color_theme_inverted": fields.Boolean,
+    "customize_domain": fields.String,
+    "copyright": fields.String,
+    "privacy_policy": fields.String,
+    "custom_disclaimer": fields.String,
+    "customize_token_strategy": fields.String,
+    "prompt_public": fields.Boolean,
+    "app_base_url": fields.String,
+    "show_workflow_steps": fields.Boolean,
+    "use_icon_as_answer_icon": fields.Boolean,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+}
+
+deleted_tool_fields = {
+    "type": fields.String,
+    "tool_name": fields.String,
+    "provider_id": fields.String,
+}
+
+app_detail_fields_with_site = {
+    "id": fields.String,
+    "name": fields.String,
+    "description": fields.String,
+    "mode": fields.String(attribute="mode_compatible_with_agent"),
+    "icon_type": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "icon_url": AppIconUrlField,
+    "enable_site": fields.Boolean,
+    "enable_api": fields.Boolean,
+    "model_config": fields.Nested(model_config_fields, attribute="app_model_config", allow_null=True),
+    "workflow": fields.Nested(workflow_partial_fields, allow_null=True),
+    "api_base_url": fields.String,
+    "use_icon_as_answer_icon": fields.Boolean,
+    "max_active_requests": fields.Integer,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+    "deleted_tools": fields.List(fields.Nested(deleted_tool_fields)),
+    "access_mode": fields.String,
+    "tags": fields.List(fields.Nested(tag_fields)),
+    "site": fields.Nested(site_fields),
+}
+
+
+app_site_fields = {
+    "app_id": fields.String,
+    "access_token": fields.String(attribute="code"),
+    "code": fields.String,
+    "title": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "description": fields.String,
+    "default_language": fields.String,
+    "customize_domain": fields.String,
+    "copyright": fields.String,
+    "privacy_policy": fields.String,
+    "custom_disclaimer": fields.String,
+    "customize_token_strategy": fields.String,
+    "prompt_public": fields.Boolean,
+    "show_workflow_steps": fields.Boolean,
+    "use_icon_as_answer_icon": fields.Boolean,
+}
+
+leaked_dependency_fields = {"type": fields.String, "value": fields.Raw, "current_identifier": fields.String}
+
+app_import_fields = {
+    "id": fields.String,
+    "status": fields.String,
+    "app_id": fields.String,
+    "app_mode": fields.String,
+    "current_dsl_version": fields.String,
+    "imported_dsl_version": fields.String,
+    "error": fields.String,
+}
+
+app_import_check_dependencies_fields = {
+    "leaked_dependencies": fields.List(fields.Nested(leaked_dependency_fields)),
+}
+
+app_server_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "server_code": fields.String,
+    "description": fields.String,
+    "status": fields.String,
+    "parameters": JsonStringField,
+    "created_at": TimestampField,
+    "updated_at": TimestampField,
+}

dify/api/fields/conversation_fields.py

@@ -0,0 +1,236 @@
+from flask_restx import Api, Namespace, fields
+
+from fields.member_fields import simple_account_fields
+from libs.helper import TimestampField
+
+from .raws import FilesContainedField
+
+
+class MessageTextField(fields.Raw):
+    def format(self, value):
+        return value[0]["text"] if value else ""
+
+
+feedback_fields = {
+    "rating": fields.String,
+    "content": fields.String,
+    "from_source": fields.String,
+    "from_end_user_id": fields.String,
+    "from_account": fields.Nested(simple_account_fields, allow_null=True),
+}
+
+annotation_fields = {
+    "id": fields.String,
+    "question": fields.String,
+    "content": fields.String,
+    "account": fields.Nested(simple_account_fields, allow_null=True),
+    "created_at": TimestampField,
+}
+
+annotation_hit_history_fields = {
+    "annotation_id": fields.String(attribute="id"),
+    "annotation_create_account": fields.Nested(simple_account_fields, allow_null=True),
+    "created_at": TimestampField,
+}
+
+message_file_fields = {
+    "id": fields.String,
+    "filename": fields.String,
+    "type": fields.String,
+    "url": fields.String,
+    "mime_type": fields.String,
+    "size": fields.Integer,
+    "transfer_method": fields.String,
+    "belongs_to": fields.String(default="user"),
+    "upload_file_id": fields.String(default=None),
+}
+
+
+def build_message_file_model(api_or_ns: Api | Namespace):
+    """Build the message file fields for the API or Namespace."""
+    return api_or_ns.model("MessageFile", message_file_fields)
+
+
+agent_thought_fields = {
+    "id": fields.String,
+    "chain_id": fields.String,
+    "message_id": fields.String,
+    "position": fields.Integer,
+    "thought": fields.String,
+    "tool": fields.String,
+    "tool_labels": fields.Raw,
+    "tool_input": fields.String,
+    "created_at": TimestampField,
+    "observation": fields.String,
+    "files": fields.List(fields.String),
+}
+
+message_detail_fields = {
+    "id": fields.String,
+    "conversation_id": fields.String,
+    "inputs": FilesContainedField,
+    "query": fields.String,
+    "message": fields.Raw,
+    "message_tokens": fields.Integer,
+    "answer": fields.String(attribute="re_sign_file_url_answer"),
+    "answer_tokens": fields.Integer,
+    "provider_response_latency": fields.Float,
+    "from_source": fields.String,
+    "from_end_user_id": fields.String,
+    "from_account_id": fields.String,
+    "feedbacks": fields.List(fields.Nested(feedback_fields)),
+    "workflow_run_id": fields.String,
+    "annotation": fields.Nested(annotation_fields, allow_null=True),
+    "annotation_hit_history": fields.Nested(annotation_hit_history_fields, allow_null=True),
+    "created_at": TimestampField,
+    "agent_thoughts": fields.List(fields.Nested(agent_thought_fields)),
+    "message_files": fields.List(fields.Nested(message_file_fields)),
+    "metadata": fields.Raw(attribute="message_metadata_dict"),
+    "status": fields.String,
+    "error": fields.String,
+    "parent_message_id": fields.String,
+}
+
+feedback_stat_fields = {"like": fields.Integer, "dislike": fields.Integer}
+status_count_fields = {"success": fields.Integer, "failed": fields.Integer, "partial_success": fields.Integer}
+model_config_fields = {
+    "opening_statement": fields.String,
+    "suggested_questions": fields.Raw,
+    "model": fields.Raw,
+    "user_input_form": fields.Raw,
+    "pre_prompt": fields.String,
+    "agent_mode": fields.Raw,
+}
+
+simple_model_config_fields = {
+    "model": fields.Raw(attribute="model_dict"),
+    "pre_prompt": fields.String,
+}
+
+simple_message_detail_fields = {
+    "inputs": FilesContainedField,
+    "query": fields.String,
+    "message": MessageTextField,
+    "answer": fields.String,
+}
+
+conversation_fields = {
+    "id": fields.String,
+    "status": fields.String,
+    "from_source": fields.String,
+    "from_end_user_id": fields.String,
+    "from_end_user_session_id": fields.String(),
+    "from_account_id": fields.String,
+    "from_account_name": fields.String,
+    "read_at": TimestampField,
+    "created_at": TimestampField,
+    "updated_at": TimestampField,
+    "annotation": fields.Nested(annotation_fields, allow_null=True),
+    "model_config": fields.Nested(simple_model_config_fields),
+    "user_feedback_stats": fields.Nested(feedback_stat_fields),
+    "admin_feedback_stats": fields.Nested(feedback_stat_fields),
+    "message": fields.Nested(simple_message_detail_fields, attribute="first_message"),
+}
+
+conversation_pagination_fields = {
+    "page": fields.Integer,
+    "limit": fields.Integer(attribute="per_page"),
+    "total": fields.Integer,
+    "has_more": fields.Boolean(attribute="has_next"),
+    "data": fields.List(fields.Nested(conversation_fields), attribute="items"),
+}
+
+conversation_message_detail_fields = {
+    "id": fields.String,
+    "status": fields.String,
+    "from_source": fields.String,
+    "from_end_user_id": fields.String,
+    "from_account_id": fields.String,
+    "created_at": TimestampField,
+    "model_config": fields.Nested(model_config_fields),
+    "message": fields.Nested(message_detail_fields, attribute="first_message"),
+}
+
+conversation_with_summary_fields = {
+    "id": fields.String,
+    "status": fields.String,
+    "from_source": fields.String,
+    "from_end_user_id": fields.String,
+    "from_end_user_session_id": fields.String,
+    "from_account_id": fields.String,
+    "from_account_name": fields.String,
+    "name": fields.String,
+    "summary": fields.String(attribute="summary_or_query"),
+    "read_at": TimestampField,
+    "created_at": TimestampField,
+    "updated_at": TimestampField,
+    "annotated": fields.Boolean,
+    "model_config": fields.Nested(simple_model_config_fields),
+    "message_count": fields.Integer,
+    "user_feedback_stats": fields.Nested(feedback_stat_fields),
+    "admin_feedback_stats": fields.Nested(feedback_stat_fields),
+    "status_count": fields.Nested(status_count_fields),
+}
+
+conversation_with_summary_pagination_fields = {
+    "page": fields.Integer,
+    "limit": fields.Integer(attribute="per_page"),
+    "total": fields.Integer,
+    "has_more": fields.Boolean(attribute="has_next"),
+    "data": fields.List(fields.Nested(conversation_with_summary_fields), attribute="items"),
+}
+
+conversation_detail_fields = {
+    "id": fields.String,
+    "status": fields.String,
+    "from_source": fields.String,
+    "from_end_user_id": fields.String,
+    "from_account_id": fields.String,
+    "created_at": TimestampField,
+    "updated_at": TimestampField,
+    "annotated": fields.Boolean,
+    "introduction": fields.String,
+    "model_config": fields.Nested(model_config_fields),
+    "message_count": fields.Integer,
+    "user_feedback_stats": fields.Nested(feedback_stat_fields),
+    "admin_feedback_stats": fields.Nested(feedback_stat_fields),
+}
+
+simple_conversation_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "inputs": FilesContainedField,
+    "status": fields.String,
+    "introduction": fields.String,
+    "created_at": TimestampField,
+    "updated_at": TimestampField,
+}
+
+conversation_delete_fields = {
+    "result": fields.String,
+}
+
+conversation_infinite_scroll_pagination_fields = {
+    "limit": fields.Integer,
+    "has_more": fields.Boolean,
+    "data": fields.List(fields.Nested(simple_conversation_fields)),
+}
+
+
+def build_conversation_infinite_scroll_pagination_model(api_or_ns: Api | Namespace):
+    """Build the conversation infinite scroll pagination model for the API or Namespace."""
+    simple_conversation_model = build_simple_conversation_model(api_or_ns)
+
+    copied_fields = conversation_infinite_scroll_pagination_fields.copy()
+    copied_fields["data"] = fields.List(fields.Nested(simple_conversation_model))
+    return api_or_ns.model("ConversationInfiniteScrollPagination", copied_fields)
+
+
+def build_conversation_delete_model(api_or_ns: Api | Namespace):
+    """Build the conversation delete model for the API or Namespace."""
+    return api_or_ns.model("ConversationDelete", conversation_delete_fields)
+
+
+def build_simple_conversation_model(api_or_ns: Api | Namespace):
+    """Build the simple conversation model for the API or Namespace."""
+    return api_or_ns.model("SimpleConversation", simple_conversation_fields)

dify/api/fields/conversation_variable_fields.py

@@ -0,0 +1,45 @@
+from flask_restx import Api, Namespace, fields
+
+from libs.helper import TimestampField
+
+from ._value_type_serializer import serialize_value_type
+
+conversation_variable_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "value_type": fields.String(attribute=serialize_value_type),
+    "value": fields.String,
+    "description": fields.String,
+    "created_at": TimestampField,
+    "updated_at": TimestampField,
+}
+
+paginated_conversation_variable_fields = {
+    "page": fields.Integer,
+    "limit": fields.Integer,
+    "total": fields.Integer,
+    "has_more": fields.Boolean,
+    "data": fields.List(fields.Nested(conversation_variable_fields), attribute="data"),
+}
+
+conversation_variable_infinite_scroll_pagination_fields = {
+    "limit": fields.Integer,
+    "has_more": fields.Boolean,
+    "data": fields.List(fields.Nested(conversation_variable_fields)),
+}
+
+
+def build_conversation_variable_model(api_or_ns: Api | Namespace):
+    """Build the conversation variable model for the API or Namespace."""
+    return api_or_ns.model("ConversationVariable", conversation_variable_fields)
+
+
+def build_conversation_variable_infinite_scroll_pagination_model(api_or_ns: Api | Namespace):
+    """Build the conversation variable infinite scroll pagination model for the API or Namespace."""
+    # Build the nested variable model first
+    conversation_variable_model = build_conversation_variable_model(api_or_ns)
+
+    copied_fields = conversation_variable_infinite_scroll_pagination_fields.copy()
+    copied_fields["data"] = fields.List(fields.Nested(conversation_variable_model))
+
+    return api_or_ns.model("ConversationVariableInfiniteScrollPagination", copied_fields)

dify/api/fields/data_source_fields.py

@@ -0,0 +1,55 @@
+from flask_restx import fields
+
+from libs.helper import TimestampField
+
+integrate_icon_fields = {"type": fields.String, "url": fields.String, "emoji": fields.String}
+
+integrate_page_fields = {
+    "page_name": fields.String,
+    "page_id": fields.String,
+    "page_icon": fields.Nested(integrate_icon_fields, allow_null=True),
+    "is_bound": fields.Boolean,
+    "parent_id": fields.String,
+    "type": fields.String,
+}
+
+integrate_workspace_fields = {
+    "workspace_name": fields.String,
+    "workspace_id": fields.String,
+    "workspace_icon": fields.String,
+    "pages": fields.List(fields.Nested(integrate_page_fields)),
+}
+
+integrate_notion_info_list_fields = {
+    "notion_info": fields.List(fields.Nested(integrate_workspace_fields)),
+}
+
+integrate_page_fields = {
+    "page_name": fields.String,
+    "page_id": fields.String,
+    "page_icon": fields.Nested(integrate_icon_fields, allow_null=True),
+    "parent_id": fields.String,
+    "type": fields.String,
+}
+
+integrate_workspace_fields = {
+    "workspace_name": fields.String,
+    "workspace_id": fields.String,
+    "workspace_icon": fields.String,
+    "pages": fields.List(fields.Nested(integrate_page_fields)),
+    "total": fields.Integer,
+}
+
+integrate_fields = {
+    "id": fields.String,
+    "provider": fields.String,
+    "created_at": TimestampField,
+    "is_bound": fields.Boolean,
+    "disabled": fields.Boolean,
+    "link": fields.String,
+    "source_info": fields.Nested(integrate_workspace_fields),
+}
+
+integrate_list_fields = {
+    "data": fields.List(fields.Nested(integrate_fields)),
+}

dify/api/fields/dataset_fields.py

@@ -0,0 +1,116 @@
+from flask_restx import fields
+
+from libs.helper import TimestampField
+
+dataset_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "description": fields.String,
+    "permission": fields.String,
+    "data_source_type": fields.String,
+    "indexing_technique": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+}
+
+reranking_model_fields = {"reranking_provider_name": fields.String, "reranking_model_name": fields.String}
+
+keyword_setting_fields = {"keyword_weight": fields.Float}
+
+vector_setting_fields = {
+    "vector_weight": fields.Float,
+    "embedding_model_name": fields.String,
+    "embedding_provider_name": fields.String,
+}
+
+weighted_score_fields = {
+    "weight_type": fields.String,
+    "keyword_setting": fields.Nested(keyword_setting_fields),
+    "vector_setting": fields.Nested(vector_setting_fields),
+}
+
+dataset_retrieval_model_fields = {
+    "search_method": fields.String,
+    "reranking_enable": fields.Boolean,
+    "reranking_mode": fields.String,
+    "reranking_model": fields.Nested(reranking_model_fields),
+    "weights": fields.Nested(weighted_score_fields, allow_null=True),
+    "top_k": fields.Integer,
+    "score_threshold_enabled": fields.Boolean,
+    "score_threshold": fields.Float,
+}
+external_retrieval_model_fields = {
+    "top_k": fields.Integer,
+    "score_threshold": fields.Float,
+    "score_threshold_enabled": fields.Boolean,
+}
+
+tag_fields = {"id": fields.String, "name": fields.String, "type": fields.String}
+
+external_knowledge_info_fields = {
+    "external_knowledge_id": fields.String,
+    "external_knowledge_api_id": fields.String,
+    "external_knowledge_api_name": fields.String,
+    "external_knowledge_api_endpoint": fields.String,
+}
+
+doc_metadata_fields = {"id": fields.String, "name": fields.String, "type": fields.String}
+
+icon_info_fields = {
+    "icon_type": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "icon_url": fields.String,
+}
+
+dataset_detail_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "description": fields.String,
+    "provider": fields.String,
+    "permission": fields.String,
+    "data_source_type": fields.String,
+    "indexing_technique": fields.String,
+    "app_count": fields.Integer,
+    "document_count": fields.Integer,
+    "word_count": fields.Integer,
+    "created_by": fields.String,
+    "author_name": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+    "embedding_model": fields.String,
+    "embedding_model_provider": fields.String,
+    "embedding_available": fields.Boolean,
+    "retrieval_model_dict": fields.Nested(dataset_retrieval_model_fields),
+    "tags": fields.List(fields.Nested(tag_fields)),
+    "doc_form": fields.String,
+    "external_knowledge_info": fields.Nested(external_knowledge_info_fields),
+    "external_retrieval_model": fields.Nested(external_retrieval_model_fields, allow_null=True),
+    "doc_metadata": fields.List(fields.Nested(doc_metadata_fields)),
+    "built_in_field_enabled": fields.Boolean,
+    "pipeline_id": fields.String,
+    "runtime_mode": fields.String,
+    "chunk_structure": fields.String,
+    "icon_info": fields.Nested(icon_info_fields),
+    "is_published": fields.Boolean,
+    "total_documents": fields.Integer,
+    "total_available_documents": fields.Integer,
+    "enable_api": fields.Boolean,
+}
+
+dataset_query_detail_fields = {
+    "id": fields.String,
+    "content": fields.String,
+    "source": fields.String,
+    "source_app_id": fields.String,
+    "created_by_role": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+}
+
+dataset_metadata_fields = {
+    "id": fields.String,
+    "type": fields.String,
+    "name": fields.String,
+}

dify/api/fields/document_fields.py

@@ -0,0 +1,86 @@
+from flask_restx import fields
+
+from fields.dataset_fields import dataset_fields
+from libs.helper import TimestampField
+
+document_metadata_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "type": fields.String,
+    "value": fields.String,
+}
+
+document_fields = {
+    "id": fields.String,
+    "position": fields.Integer,
+    "data_source_type": fields.String,
+    "data_source_info": fields.Raw(attribute="data_source_info_dict"),
+    "data_source_detail_dict": fields.Raw(attribute="data_source_detail_dict"),
+    "dataset_process_rule_id": fields.String,
+    "name": fields.String,
+    "created_from": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "tokens": fields.Integer,
+    "indexing_status": fields.String,
+    "error": fields.String,
+    "enabled": fields.Boolean,
+    "disabled_at": TimestampField,
+    "disabled_by": fields.String,
+    "archived": fields.Boolean,
+    "display_status": fields.String,
+    "word_count": fields.Integer,
+    "hit_count": fields.Integer,
+    "doc_form": fields.String,
+    "doc_metadata": fields.List(fields.Nested(document_metadata_fields), attribute="doc_metadata_details"),
+}
+
+document_with_segments_fields = {
+    "id": fields.String,
+    "position": fields.Integer,
+    "data_source_type": fields.String,
+    "data_source_info": fields.Raw(attribute="data_source_info_dict"),
+    "data_source_detail_dict": fields.Raw(attribute="data_source_detail_dict"),
+    "dataset_process_rule_id": fields.String,
+    "process_rule_dict": fields.Raw(attribute="process_rule_dict"),
+    "name": fields.String,
+    "created_from": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "tokens": fields.Integer,
+    "indexing_status": fields.String,
+    "error": fields.String,
+    "enabled": fields.Boolean,
+    "disabled_at": TimestampField,
+    "disabled_by": fields.String,
+    "archived": fields.Boolean,
+    "display_status": fields.String,
+    "word_count": fields.Integer,
+    "hit_count": fields.Integer,
+    "completed_segments": fields.Integer,
+    "total_segments": fields.Integer,
+    "doc_metadata": fields.List(fields.Nested(document_metadata_fields), attribute="doc_metadata_details"),
+}
+
+dataset_and_document_fields = {
+    "dataset": fields.Nested(dataset_fields),
+    "documents": fields.List(fields.Nested(document_fields)),
+    "batch": fields.String,
+}
+
+document_status_fields = {
+    "id": fields.String,
+    "indexing_status": fields.String,
+    "processing_started_at": TimestampField,
+    "parsing_completed_at": TimestampField,
+    "cleaning_completed_at": TimestampField,
+    "splitting_completed_at": TimestampField,
+    "completed_at": TimestampField,
+    "paused_at": TimestampField,
+    "error": fields.String,
+    "stopped_at": TimestampField,
+    "completed_segments": fields.Integer,
+    "total_segments": fields.Integer,
+}
+
+document_status_fields_list = {"data": fields.List(fields.Nested(document_status_fields))}

dify/api/fields/end_user_fields.py

@@ -0,0 +1,12 @@
+from flask_restx import Api, Namespace, fields
+
+simple_end_user_fields = {
+    "id": fields.String,
+    "type": fields.String,
+    "is_anonymous": fields.Boolean,
+    "session_id": fields.String,
+}
+
+
+def build_simple_end_user_model(api_or_ns: Api | Namespace):
+    return api_or_ns.model("SimpleEndUser", simple_end_user_fields)

dify/api/fields/file_fields.py

@@ -0,0 +1,91 @@
+from flask_restx import Api, Namespace, fields
+
+from libs.helper import TimestampField
+
+upload_config_fields = {
+    "file_size_limit": fields.Integer,
+    "batch_count_limit": fields.Integer,
+    "image_file_size_limit": fields.Integer,
+    "video_file_size_limit": fields.Integer,
+    "audio_file_size_limit": fields.Integer,
+    "workflow_file_upload_limit": fields.Integer,
+}
+
+
+def build_upload_config_model(api_or_ns: Api | Namespace):
+    """Build the upload config model for the API or Namespace.
+
+    Args:
+        api_or_ns: Flask-RestX Api or Namespace instance
+
+    Returns:
+        The registered model
+    """
+    return api_or_ns.model("UploadConfig", upload_config_fields)
+
+
+file_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "size": fields.Integer,
+    "extension": fields.String,
+    "mime_type": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "preview_url": fields.String,
+    "source_url": fields.String,
+}
+
+
+def build_file_model(api_or_ns: Api | Namespace):
+    """Build the file model for the API or Namespace.
+
+    Args:
+        api_or_ns: Flask-RestX Api or Namespace instance
+
+    Returns:
+        The registered model
+    """
+    return api_or_ns.model("File", file_fields)
+
+
+remote_file_info_fields = {
+    "file_type": fields.String(attribute="file_type"),
+    "file_length": fields.Integer(attribute="file_length"),
+}
+
+
+def build_remote_file_info_model(api_or_ns: Api | Namespace):
+    """Build the remote file info model for the API or Namespace.
+
+    Args:
+        api_or_ns: Flask-RestX Api or Namespace instance
+
+    Returns:
+        The registered model
+    """
+    return api_or_ns.model("RemoteFileInfo", remote_file_info_fields)
+
+
+file_fields_with_signed_url = {
+    "id": fields.String,
+    "name": fields.String,
+    "size": fields.Integer,
+    "extension": fields.String,
+    "url": fields.String,
+    "mime_type": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+}
+
+
+def build_file_with_signed_url_model(api_or_ns: Api | Namespace):
+    """Build the file with signed URL model for the API or Namespace.
+
+    Args:
+        api_or_ns: Flask-RestX Api or Namespace instance
+
+    Returns:
+        The registered model
+    """
+    return api_or_ns.model("FileWithSignedUrl", file_fields_with_signed_url)

dify/api/fields/hit_testing_fields.py

@@ -0,0 +1,51 @@
+from flask_restx import fields
+
+from libs.helper import TimestampField
+
+document_fields = {
+    "id": fields.String,
+    "data_source_type": fields.String,
+    "name": fields.String,
+    "doc_type": fields.String,
+    "doc_metadata": fields.Raw,
+}
+
+segment_fields = {
+    "id": fields.String,
+    "position": fields.Integer,
+    "document_id": fields.String,
+    "content": fields.String,
+    "sign_content": fields.String,
+    "answer": fields.String,
+    "word_count": fields.Integer,
+    "tokens": fields.Integer,
+    "keywords": fields.List(fields.String),
+    "index_node_id": fields.String,
+    "index_node_hash": fields.String,
+    "hit_count": fields.Integer,
+    "enabled": fields.Boolean,
+    "disabled_at": TimestampField,
+    "disabled_by": fields.String,
+    "status": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "indexing_at": TimestampField,
+    "completed_at": TimestampField,
+    "error": fields.String,
+    "stopped_at": TimestampField,
+    "document": fields.Nested(document_fields),
+}
+
+child_chunk_fields = {
+    "id": fields.String,
+    "content": fields.String,
+    "position": fields.Integer,
+    "score": fields.Float,
+}
+
+hit_testing_record_fields = {
+    "segment": fields.Nested(segment_fields),
+    "child_chunks": fields.List(fields.Nested(child_chunk_fields)),
+    "score": fields.Float,
+    "tsne_position": fields.Raw,
+}

dify/api/fields/installed_app_fields.py

@@ -0,0 +1,26 @@
+from flask_restx import fields
+
+from libs.helper import AppIconUrlField, TimestampField
+
+app_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "mode": fields.String,
+    "icon_type": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "icon_url": AppIconUrlField,
+    "use_icon_as_answer_icon": fields.Boolean,
+}
+
+installed_app_fields = {
+    "id": fields.String,
+    "app": fields.Nested(app_fields),
+    "app_owner_tenant_id": fields.String,
+    "is_pinned": fields.Boolean,
+    "last_used_at": TimestampField,
+    "editable": fields.Boolean,
+    "uninstallable": fields.Boolean,
+}
+
+installed_app_list_fields = {"installed_apps": fields.List(fields.Nested(installed_app_fields))}

dify/api/fields/member_fields.py

@@ -0,0 +1,44 @@
+from flask_restx import Api, Namespace, fields
+
+from libs.helper import AvatarUrlField, TimestampField
+
+simple_account_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "email": fields.String,
+}
+
+
+def build_simple_account_model(api_or_ns: Api | Namespace):
+    return api_or_ns.model("SimpleAccount", simple_account_fields)
+
+
+account_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "avatar": fields.String,
+    "avatar_url": AvatarUrlField,
+    "email": fields.String,
+    "is_password_set": fields.Boolean,
+    "interface_language": fields.String,
+    "interface_theme": fields.String,
+    "timezone": fields.String,
+    "last_login_at": TimestampField,
+    "last_login_ip": fields.String,
+    "created_at": TimestampField,
+}
+
+account_with_role_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "avatar": fields.String,
+    "avatar_url": AvatarUrlField,
+    "email": fields.String,
+    "last_login_at": TimestampField,
+    "last_active_at": TimestampField,
+    "created_at": TimestampField,
+    "role": fields.String,
+    "status": fields.String,
+}
+
+account_with_role_list_fields = {"accounts": fields.List(fields.Nested(account_with_role_fields))}

dify/api/fields/message_fields.py

@@ -0,0 +1,77 @@
+from flask_restx import Api, Namespace, fields
+
+from fields.conversation_fields import message_file_fields
+from libs.helper import TimestampField
+
+from .raws import FilesContainedField
+
+feedback_fields = {
+    "rating": fields.String,
+}
+
+
+def build_feedback_model(api_or_ns: Api | Namespace):
+    """Build the feedback model for the API or Namespace."""
+    return api_or_ns.model("Feedback", feedback_fields)
+
+
+agent_thought_fields = {
+    "id": fields.String,
+    "chain_id": fields.String,
+    "message_id": fields.String,
+    "position": fields.Integer,
+    "thought": fields.String,
+    "tool": fields.String,
+    "tool_labels": fields.Raw,
+    "tool_input": fields.String,
+    "created_at": TimestampField,
+    "observation": fields.String,
+    "files": fields.List(fields.String),
+}
+
+
+def build_agent_thought_model(api_or_ns: Api | Namespace):
+    """Build the agent thought model for the API or Namespace."""
+    return api_or_ns.model("AgentThought", agent_thought_fields)
+
+
+retriever_resource_fields = {
+    "id": fields.String,
+    "message_id": fields.String,
+    "position": fields.Integer,
+    "dataset_id": fields.String,
+    "dataset_name": fields.String,
+    "document_id": fields.String,
+    "document_name": fields.String,
+    "data_source_type": fields.String,
+    "segment_id": fields.String,
+    "score": fields.Float,
+    "hit_count": fields.Integer,
+    "word_count": fields.Integer,
+    "segment_position": fields.Integer,
+    "index_node_hash": fields.String,
+    "content": fields.String,
+    "created_at": TimestampField,
+}
+
+message_fields = {
+    "id": fields.String,
+    "conversation_id": fields.String,
+    "parent_message_id": fields.String,
+    "inputs": FilesContainedField,
+    "query": fields.String,
+    "answer": fields.String(attribute="re_sign_file_url_answer"),
+    "feedback": fields.Nested(feedback_fields, attribute="user_feedback", allow_null=True),
+    "retriever_resources": fields.List(fields.Nested(retriever_resource_fields)),
+    "created_at": TimestampField,
+    "agent_thoughts": fields.List(fields.Nested(agent_thought_fields)),
+    "message_files": fields.List(fields.Nested(message_file_fields)),
+    "status": fields.String,
+    "error": fields.String,
+}
+
+message_infinite_scroll_pagination_fields = {
+    "limit": fields.Integer,
+    "has_more": fields.Boolean,
+    "data": fields.List(fields.Nested(message_fields)),
+}

dify/api/fields/rag_pipeline_fields.py

@@ -0,0 +1,164 @@
+from flask_restx import fields  # type: ignore
+
+from fields.workflow_fields import workflow_partial_fields
+from libs.helper import AppIconUrlField, TimestampField
+
+pipeline_detail_kernel_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "description": fields.String,
+    "icon_type": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "icon_url": AppIconUrlField,
+}
+
+related_app_list = {
+    "data": fields.List(fields.Nested(pipeline_detail_kernel_fields)),
+    "total": fields.Integer,
+}
+
+app_detail_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "description": fields.String,
+    "mode": fields.String(attribute="mode_compatible_with_agent"),
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "workflow": fields.Nested(workflow_partial_fields, allow_null=True),
+    "tracing": fields.Raw,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+}
+
+
+tag_fields = {"id": fields.String, "name": fields.String, "type": fields.String}
+
+app_partial_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "description": fields.String(attribute="desc_or_prompt"),
+    "icon_type": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "icon_url": AppIconUrlField,
+    "workflow": fields.Nested(workflow_partial_fields, allow_null=True),
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+    "tags": fields.List(fields.Nested(tag_fields)),
+}
+
+
+app_pagination_fields = {
+    "page": fields.Integer,
+    "limit": fields.Integer(attribute="per_page"),
+    "total": fields.Integer,
+    "has_more": fields.Boolean(attribute="has_next"),
+    "data": fields.List(fields.Nested(app_partial_fields), attribute="items"),
+}
+
+template_fields = {
+    "name": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "description": fields.String,
+    "mode": fields.String,
+}
+
+template_list_fields = {
+    "data": fields.List(fields.Nested(template_fields)),
+}
+
+site_fields = {
+    "access_token": fields.String(attribute="code"),
+    "code": fields.String,
+    "title": fields.String,
+    "icon_type": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "icon_url": AppIconUrlField,
+    "description": fields.String,
+    "default_language": fields.String,
+    "chat_color_theme": fields.String,
+    "chat_color_theme_inverted": fields.Boolean,
+    "customize_domain": fields.String,
+    "copyright": fields.String,
+    "privacy_policy": fields.String,
+    "custom_disclaimer": fields.String,
+    "customize_token_strategy": fields.String,
+    "prompt_public": fields.Boolean,
+    "app_base_url": fields.String,
+    "show_workflow_steps": fields.Boolean,
+    "use_icon_as_answer_icon": fields.Boolean,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+}
+
+deleted_tool_fields = {
+    "type": fields.String,
+    "tool_name": fields.String,
+    "provider_id": fields.String,
+}
+
+app_detail_fields_with_site = {
+    "id": fields.String,
+    "name": fields.String,
+    "description": fields.String,
+    "mode": fields.String(attribute="mode_compatible_with_agent"),
+    "icon_type": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "icon_url": AppIconUrlField,
+    "enable_site": fields.Boolean,
+    "enable_api": fields.Boolean,
+    "workflow": fields.Nested(workflow_partial_fields, allow_null=True),
+    "site": fields.Nested(site_fields),
+    "api_base_url": fields.String,
+    "use_icon_as_answer_icon": fields.Boolean,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+}
+
+
+app_site_fields = {
+    "app_id": fields.String,
+    "access_token": fields.String(attribute="code"),
+    "code": fields.String,
+    "title": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
+    "description": fields.String,
+    "default_language": fields.String,
+    "customize_domain": fields.String,
+    "copyright": fields.String,
+    "privacy_policy": fields.String,
+    "custom_disclaimer": fields.String,
+    "customize_token_strategy": fields.String,
+    "prompt_public": fields.Boolean,
+    "show_workflow_steps": fields.Boolean,
+    "use_icon_as_answer_icon": fields.Boolean,
+}
+
+leaked_dependency_fields = {"type": fields.String, "value": fields.Raw, "current_identifier": fields.String}
+
+pipeline_import_fields = {
+    "id": fields.String,
+    "status": fields.String,
+    "pipeline_id": fields.String,
+    "dataset_id": fields.String,
+    "current_dsl_version": fields.String,
+    "imported_dsl_version": fields.String,
+    "error": fields.String,
+}
+
+pipeline_import_check_dependencies_fields = {
+    "leaked_dependencies": fields.List(fields.Nested(leaked_dependency_fields)),
+}

dify/api/fields/raws.py

@@ -0,0 +1,17 @@
+from flask_restx import fields
+
+from core.file import File
+
+
+class FilesContainedField(fields.Raw):
+    def format(self, value):
+        return self._format_file_object(value)
+
+    def _format_file_object(self, v):
+        if isinstance(v, File):
+            return v.model_dump()
+        if isinstance(v, dict):
+            return {k: self._format_file_object(vv) for k, vv in v.items()}
+        if isinstance(v, list):
+            return [self._format_file_object(vv) for vv in v]
+        return v

dify/api/fields/segment_fields.py

@@ -0,0 +1,42 @@
+from flask_restx import fields
+
+from libs.helper import TimestampField
+
+child_chunk_fields = {
+    "id": fields.String,
+    "segment_id": fields.String,
+    "content": fields.String,
+    "position": fields.Integer,
+    "word_count": fields.Integer,
+    "type": fields.String,
+    "created_at": TimestampField,
+    "updated_at": TimestampField,
+}
+
+segment_fields = {
+    "id": fields.String,
+    "position": fields.Integer,
+    "document_id": fields.String,
+    "content": fields.String,
+    "sign_content": fields.String,
+    "answer": fields.String,
+    "word_count": fields.Integer,
+    "tokens": fields.Integer,
+    "keywords": fields.List(fields.String),
+    "index_node_id": fields.String,
+    "index_node_hash": fields.String,
+    "hit_count": fields.Integer,
+    "enabled": fields.Boolean,
+    "disabled_at": TimestampField,
+    "disabled_by": fields.String,
+    "status": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_at": TimestampField,
+    "updated_by": fields.String,
+    "indexing_at": TimestampField,
+    "completed_at": TimestampField,
+    "error": fields.String,
+    "stopped_at": TimestampField,
+    "child_chunks": fields.List(fields.Nested(child_chunk_fields)),
+}

dify/api/fields/tag_fields.py

@@ -0,0 +1,12 @@
+from flask_restx import Api, Namespace, fields
+
+dataset_tag_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "type": fields.String,
+    "binding_count": fields.String,
+}
+
+
+def build_dataset_tag_fields(api_or_ns: Api | Namespace):
+    return api_or_ns.model("DataSetTag", dataset_tag_fields)

dify/api/fields/workflow_app_log_fields.py

@@ -0,0 +1,53 @@
+from flask_restx import Api, Namespace, fields
+
+from fields.end_user_fields import build_simple_end_user_model, simple_end_user_fields
+from fields.member_fields import build_simple_account_model, simple_account_fields
+from fields.workflow_run_fields import build_workflow_run_for_log_model, workflow_run_for_log_fields
+from libs.helper import TimestampField
+
+workflow_app_log_partial_fields = {
+    "id": fields.String,
+    "workflow_run": fields.Nested(workflow_run_for_log_fields, attribute="workflow_run", allow_null=True),
+    "details": fields.Raw(attribute="details"),
+    "created_from": fields.String,
+    "created_by_role": fields.String,
+    "created_by_account": fields.Nested(simple_account_fields, attribute="created_by_account", allow_null=True),
+    "created_by_end_user": fields.Nested(simple_end_user_fields, attribute="created_by_end_user", allow_null=True),
+    "created_at": TimestampField,
+}
+
+
+def build_workflow_app_log_partial_model(api_or_ns: Api | Namespace):
+    """Build the workflow app log partial model for the API or Namespace."""
+    workflow_run_model = build_workflow_run_for_log_model(api_or_ns)
+    simple_account_model = build_simple_account_model(api_or_ns)
+    simple_end_user_model = build_simple_end_user_model(api_or_ns)
+
+    copied_fields = workflow_app_log_partial_fields.copy()
+    copied_fields["workflow_run"] = fields.Nested(workflow_run_model, attribute="workflow_run", allow_null=True)
+    copied_fields["created_by_account"] = fields.Nested(
+        simple_account_model, attribute="created_by_account", allow_null=True
+    )
+    copied_fields["created_by_end_user"] = fields.Nested(
+        simple_end_user_model, attribute="created_by_end_user", allow_null=True
+    )
+    return api_or_ns.model("WorkflowAppLogPartial", copied_fields)
+
+
+workflow_app_log_pagination_fields = {
+    "page": fields.Integer,
+    "limit": fields.Integer,
+    "total": fields.Integer,
+    "has_more": fields.Boolean,
+    "data": fields.List(fields.Nested(workflow_app_log_partial_fields)),
+}
+
+
+def build_workflow_app_log_pagination_model(api_or_ns: Api | Namespace):
+    """Build the workflow app log pagination model for the API or Namespace."""
+    # Build the nested partial model first
+    workflow_app_log_partial_model = build_workflow_app_log_partial_model(api_or_ns)
+
+    copied_fields = workflow_app_log_pagination_fields.copy()
+    copied_fields["data"] = fields.List(fields.Nested(workflow_app_log_partial_model))
+    return api_or_ns.model("WorkflowAppLogPagination", copied_fields)

dify/api/fields/workflow_fields.py

@@ -0,0 +1,100 @@
+from flask_restx import fields
+
+from core.helper import encrypter
+from core.variables import SecretVariable, SegmentType, Variable
+from fields.member_fields import simple_account_fields
+from libs.helper import TimestampField
+
+from ._value_type_serializer import serialize_value_type
+
+ENVIRONMENT_VARIABLE_SUPPORTED_TYPES = (SegmentType.STRING, SegmentType.NUMBER, SegmentType.SECRET)
+
+
+class EnvironmentVariableField(fields.Raw):
+    def format(self, value):
+        # Mask secret variables values in environment_variables
+        if isinstance(value, SecretVariable):
+            return {
+                "id": value.id,
+                "name": value.name,
+                "value": encrypter.full_mask_token(),
+                "value_type": value.value_type.value,
+                "description": value.description,
+            }
+        if isinstance(value, Variable):
+            return {
+                "id": value.id,
+                "name": value.name,
+                "value": value.value,
+                "value_type": value.value_type.exposed_type().value,
+                "description": value.description,
+            }
+        if isinstance(value, dict):
+            value_type_str = value.get("value_type")
+            if not isinstance(value_type_str, str):
+                raise TypeError(
+                    f"unexpected type for value_type field, value={value_type_str}, type={type(value_type_str)}"
+                )
+            value_type = SegmentType(value_type_str).exposed_type()
+            if value_type not in ENVIRONMENT_VARIABLE_SUPPORTED_TYPES:
+                raise ValueError(f"Unsupported environment variable value type: {value_type}")
+            return value
+
+
+conversation_variable_fields = {
+    "id": fields.String,
+    "name": fields.String,
+    "value_type": fields.String(attribute=serialize_value_type),
+    "value": fields.Raw,
+    "description": fields.String,
+}
+
+pipeline_variable_fields = {
+    "label": fields.String,
+    "variable": fields.String,
+    "type": fields.String,
+    "belong_to_node_id": fields.String,
+    "max_length": fields.Integer,
+    "required": fields.Boolean,
+    "unit": fields.String,
+    "default_value": fields.Raw,
+    "options": fields.List(fields.String),
+    "placeholder": fields.String,
+    "tooltips": fields.String,
+    "allowed_file_types": fields.List(fields.String),
+    "allow_file_extension": fields.List(fields.String),
+    "allow_file_upload_methods": fields.List(fields.String),
+}
+
+workflow_fields = {
+    "id": fields.String,
+    "graph": fields.Raw(attribute="graph_dict"),
+    "features": fields.Raw(attribute="features_dict"),
+    "hash": fields.String(attribute="unique_hash"),
+    "version": fields.String,
+    "marked_name": fields.String,
+    "marked_comment": fields.String,
+    "created_by": fields.Nested(simple_account_fields, attribute="created_by_account"),
+    "created_at": TimestampField,
+    "updated_by": fields.Nested(simple_account_fields, attribute="updated_by_account", allow_null=True),
+    "updated_at": TimestampField,
+    "tool_published": fields.Boolean,
+    "environment_variables": fields.List(EnvironmentVariableField()),
+    "conversation_variables": fields.List(fields.Nested(conversation_variable_fields)),
+    "rag_pipeline_variables": fields.List(fields.Nested(pipeline_variable_fields)),
+}
+
+workflow_partial_fields = {
+    "id": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+    "updated_by": fields.String,
+    "updated_at": TimestampField,
+}
+
+workflow_pagination_fields = {
+    "items": fields.List(fields.Nested(workflow_fields), attribute="items"),
+    "page": fields.Integer,
+    "limit": fields.Integer(attribute="limit"),
+    "has_more": fields.Boolean(attribute="has_more"),
+}

dify/api/fields/workflow_run_fields.py

@@ -0,0 +1,136 @@
+from flask_restx import Api, Namespace, fields
+
+from fields.end_user_fields import simple_end_user_fields
+from fields.member_fields import simple_account_fields
+from libs.helper import TimestampField
+
+workflow_run_for_log_fields = {
+    "id": fields.String,
+    "version": fields.String,
+    "status": fields.String,
+    "triggered_from": fields.String,
+    "error": fields.String,
+    "elapsed_time": fields.Float,
+    "total_tokens": fields.Integer,
+    "total_steps": fields.Integer,
+    "created_at": TimestampField,
+    "finished_at": TimestampField,
+    "exceptions_count": fields.Integer,
+}
+
+
+def build_workflow_run_for_log_model(api_or_ns: Api | Namespace):
+    return api_or_ns.model("WorkflowRunForLog", workflow_run_for_log_fields)
+
+
+workflow_run_for_list_fields = {
+    "id": fields.String,
+    "version": fields.String,
+    "status": fields.String,
+    "elapsed_time": fields.Float,
+    "total_tokens": fields.Integer,
+    "total_steps": fields.Integer,
+    "created_by_account": fields.Nested(simple_account_fields, attribute="created_by_account", allow_null=True),
+    "created_at": TimestampField,
+    "finished_at": TimestampField,
+    "exceptions_count": fields.Integer,
+    "retry_index": fields.Integer,
+}
+
+advanced_chat_workflow_run_for_list_fields = {
+    "id": fields.String,
+    "conversation_id": fields.String,
+    "message_id": fields.String,
+    "version": fields.String,
+    "status": fields.String,
+    "elapsed_time": fields.Float,
+    "total_tokens": fields.Integer,
+    "total_steps": fields.Integer,
+    "created_by_account": fields.Nested(simple_account_fields, attribute="created_by_account", allow_null=True),
+    "created_at": TimestampField,
+    "finished_at": TimestampField,
+    "exceptions_count": fields.Integer,
+    "retry_index": fields.Integer,
+}
+
+advanced_chat_workflow_run_pagination_fields = {
+    "limit": fields.Integer(attribute="limit"),
+    "has_more": fields.Boolean(attribute="has_more"),
+    "data": fields.List(fields.Nested(advanced_chat_workflow_run_for_list_fields), attribute="data"),
+}
+
+workflow_run_pagination_fields = {
+    "limit": fields.Integer(attribute="limit"),
+    "has_more": fields.Boolean(attribute="has_more"),
+    "data": fields.List(fields.Nested(workflow_run_for_list_fields), attribute="data"),
+}
+
+workflow_run_count_fields = {
+    "total": fields.Integer,
+    "running": fields.Integer,
+    "succeeded": fields.Integer,
+    "failed": fields.Integer,
+    "stopped": fields.Integer,
+    "partial_succeeded": fields.Integer(attribute="partial-succeeded"),
+}
+
+workflow_run_detail_fields = {
+    "id": fields.String,
+    "version": fields.String,
+    "graph": fields.Raw(attribute="graph_dict"),
+    "inputs": fields.Raw(attribute="inputs_dict"),
+    "status": fields.String,
+    "outputs": fields.Raw(attribute="outputs_dict"),
+    "error": fields.String,
+    "elapsed_time": fields.Float,
+    "total_tokens": fields.Integer,
+    "total_steps": fields.Integer,
+    "created_by_role": fields.String,
+    "created_by_account": fields.Nested(simple_account_fields, attribute="created_by_account", allow_null=True),
+    "created_by_end_user": fields.Nested(simple_end_user_fields, attribute="created_by_end_user", allow_null=True),
+    "created_at": TimestampField,
+    "finished_at": TimestampField,
+    "exceptions_count": fields.Integer,
+}
+
+retry_event_field = {
+    "elapsed_time": fields.Float,
+    "status": fields.String,
+    "inputs": fields.Raw(attribute="inputs"),
+    "process_data": fields.Raw(attribute="process_data"),
+    "outputs": fields.Raw(attribute="outputs"),
+    "metadata": fields.Raw(attribute="metadata"),
+    "llm_usage": fields.Raw(attribute="llm_usage"),
+    "error": fields.String,
+    "retry_index": fields.Integer,
+}
+
+
+workflow_run_node_execution_fields = {
+    "id": fields.String,
+    "index": fields.Integer,
+    "predecessor_node_id": fields.String,
+    "node_id": fields.String,
+    "node_type": fields.String,
+    "title": fields.String,
+    "inputs": fields.Raw(attribute="inputs_dict"),
+    "process_data": fields.Raw(attribute="process_data_dict"),
+    "outputs": fields.Raw(attribute="outputs_dict"),
+    "status": fields.String,
+    "error": fields.String,
+    "elapsed_time": fields.Float,
+    "execution_metadata": fields.Raw(attribute="execution_metadata_dict"),
+    "extras": fields.Raw,
+    "created_at": TimestampField,
+    "created_by_role": fields.String,
+    "created_by_account": fields.Nested(simple_account_fields, attribute="created_by_account", allow_null=True),
+    "created_by_end_user": fields.Nested(simple_end_user_fields, attribute="created_by_end_user", allow_null=True),
+    "finished_at": TimestampField,
+    "inputs_truncated": fields.Boolean,
+    "outputs_truncated": fields.Boolean,
+    "process_data_truncated": fields.Boolean,
+}
+
+workflow_run_node_execution_list_fields = {
+    "data": fields.List(fields.Nested(workflow_run_node_execution_fields)),
+}

dify/api/fields/workflow_trigger_fields.py

@@ -0,0 +1,25 @@
+from flask_restx import fields
+
+trigger_fields = {
+    "id": fields.String,
+    "trigger_type": fields.String,
+    "title": fields.String,
+    "node_id": fields.String,
+    "provider_name": fields.String,
+    "icon": fields.String,
+    "status": fields.String,
+    "created_at": fields.DateTime(dt_format="iso8601"),
+    "updated_at": fields.DateTime(dt_format="iso8601"),
+}
+
+triggers_list_fields = {"data": fields.List(fields.Nested(trigger_fields))}
+
+
+webhook_trigger_fields = {
+    "id": fields.String,
+    "webhook_id": fields.String,
+    "webhook_url": fields.String,
+    "webhook_debug_url": fields.String,
+    "node_id": fields.String,
+    "created_at": fields.DateTime(dt_format="iso8601"),
+}