FEAT: NEW WORKFLOW ENGINE (#3160)

Co-authored-by: Joel <iamjoel007@gmail.com>
Co-authored-by: Yeuoly <admin@srmxy.cn>
Co-authored-by: JzoNg <jzongcode@gmail.com>
Co-authored-by: StyleZhang <jasonapring2015@outlook.com>
Co-authored-by: jyong <jyong@dify.ai>
Co-authored-by: nite-knite <nkCoding@gmail.com>
Co-authored-by: jyong <718720800@qq.com>

api/fields/annotation_fields.py

@@ -2,20 +2,13 @@ from flask_restful import fields
 
 from libs.helper import TimestampField
 
-account_fields = {
-    'id': fields.String,
-    'name': fields.String,
-    'email': fields.String
-}
-
-
 annotation_fields = {
     "id": fields.String,
     "question": fields.String,
     "answer": fields.Raw(attribute='content'),
     "hit_count": fields.Integer,
     "created_at": TimestampField,
-    # 'account': fields.Nested(account_fields, allow_null=True)
+    # 'account': fields.Nested(simple_account_fields, allow_null=True)
 }
 
 annotation_list_fields = {

api/fields/app_fields.py

@@ -5,7 +5,8 @@ from libs.helper import TimestampField
 app_detail_kernel_fields = {
     'id': fields.String,
     'name': fields.String,
-    'mode': fields.String,
+    'description': fields.String,
+    'mode': fields.String(attribute='mode_compatible_with_agent'),
     'icon': fields.String,
     'icon_background': fields.String,
 }
@@ -36,21 +37,19 @@ model_config_fields = {
     '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_at': TimestampField
 }
 
 app_detail_fields = {
     'id': fields.String,
     'name': fields.String,
-    'mode': fields.String,
-    'is_agent': fields.Boolean,
+    '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,
-    'api_rpm': fields.Integer,
-    'api_rph': fields.Integer,
-    'is_demo': fields.Boolean,
-    'model_config': fields.Nested(model_config_fields, attribute='app_model_config'),
+    'model_config': fields.Nested(model_config_fields, attribute='app_model_config', allow_null=True),
     'created_at': TimestampField
 }
 
@@ -66,14 +65,11 @@ model_config_partial_fields = {
 app_partial_fields = {
     'id': fields.String,
     'name': fields.String,
-    'mode': fields.String,
-    'is_agent': fields.Boolean,
+    'description': fields.String(attribute='desc_or_prompt'),
+    'mode': fields.String(attribute='mode_compatible_with_agent'),
     'icon': fields.String,
     'icon_background': fields.String,
-    'enable_site': fields.Boolean,
-    'enable_api': fields.Boolean,
-    'is_demo': fields.Boolean,
-    'model_config': fields.Nested(model_config_partial_fields, attribute='app_model_config'),
+    'model_config': fields.Nested(model_config_partial_fields, attribute='app_model_config', allow_null=True),
     'created_at': TimestampField
 }
 
@@ -117,16 +113,13 @@ site_fields = {
 app_detail_fields_with_site = {
     'id': fields.String,
     'name': fields.String,
-    'mode': 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,
-    'api_rpm': fields.Integer,
-    'api_rph': fields.Integer,
-    'is_agent': fields.Boolean,
-    'is_demo': fields.Boolean,
-    'model_config': fields.Nested(model_config_fields, attribute='app_model_config'),
+    'model_config': fields.Nested(model_config_fields, attribute='app_model_config', allow_null=True),
     'site': fields.Nested(site_fields),
     'api_base_url': fields.String,
     'created_at': TimestampField,

api/fields/conversation_fields.py

@@ -1,5 +1,6 @@
 from flask_restful import fields
 
+from fields.member_fields import simple_account_fields
 from libs.helper import TimestampField
 
 
@@ -8,31 +9,25 @@ class MessageTextField(fields.Raw):
         return value[0]['text'] if value else ''
 
 
-account_fields = {
-    'id': fields.String,
-    'name': fields.String,
-    'email': fields.String
-}
-
 feedback_fields = {
     'rating': fields.String,
     'content': fields.String,
     'from_source': fields.String,
     'from_end_user_id': fields.String,
-    'from_account': fields.Nested(account_fields, allow_null=True),
+    'from_account': fields.Nested(simple_account_fields, allow_null=True),
 }
 
 annotation_fields = {
     'id': fields.String,
     'question': fields.String,
     'content': fields.String,
-    'account': fields.Nested(account_fields, allow_null=True),
+    '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(account_fields, allow_null=True),
+    'annotation_create_account': fields.Nested(simple_account_fields, allow_null=True),
     'created_at': TimestampField
 }
 
@@ -64,18 +59,22 @@ message_detail_fields = {
     'query': fields.String,
     'message': fields.Raw,
     'message_tokens': fields.Integer,
-    'answer': fields.String,
+    '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), attribute='files'),
+    'metadata': fields.Raw(attribute='message_metadata_dict'),
+    'status': fields.String,
+    'error': fields.String,
 }
 
 feedback_stat_fields = {

api/fields/end_user_fields.py

@@ -0,0 +1,8 @@
+from flask_restful import fields
+
+simple_end_user_fields = {
+    'id': fields.String,
+    'type': fields.String,
+    'is_anonymous': fields.Boolean,
+    'session_id': fields.String,
+}

api/fields/installed_app_fields.py

@@ -17,8 +17,7 @@ installed_app_fields = {
     'is_pinned': fields.Boolean,
     'last_used_at': TimestampField,
     'editable': fields.Boolean,
-    'uninstallable': fields.Boolean,
-    'is_agent': fields.Boolean,
+    'uninstallable': fields.Boolean
 }
 
 installed_app_list_fields = {

api/fields/member_fields.py

@@ -0,0 +1,38 @@
+from flask_restful import fields
+
+from libs.helper import TimestampField
+
+simple_account_fields = {
+    'id': fields.String,
+    'name': fields.String,
+    'email': fields.String
+}
+
+account_fields = {
+    'id': fields.String,
+    'name': fields.String,
+    'avatar': fields.String,
+    '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,
+    'email': fields.String,
+    'last_login_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))
+}

api/fields/message_fields.py

@@ -68,12 +68,14 @@ message_fields = {
     'conversation_id': fields.String,
     'inputs': fields.Raw,
     'query': fields.String,
-    'answer': 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), attribute='files')
+    'message_files': fields.List(fields.Nested(message_file_fields), attribute='files'),
+    'status': fields.String,
+    'error': fields.String,
 }
 
 message_infinite_scroll_pagination_fields = {

api/fields/workflow_app_log_fields.py

@@ -0,0 +1,24 @@
+from flask_restful import fields
+
+from fields.end_user_fields import simple_end_user_fields
+from fields.member_fields import simple_account_fields
+from fields.workflow_run_fields import 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),
+    "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
+}
+
+workflow_app_log_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(workflow_app_log_partial_fields), attribute='items')
+}

api/fields/workflow_fields.py

@@ -0,0 +1,14 @@
+from flask_restful import fields
+
+from fields.member_fields import simple_account_fields
+from libs.helper import TimestampField
+
+workflow_fields = {
+    'id': fields.String,
+    'graph': fields.Raw(attribute='graph_dict'),
+    'features': fields.Raw(attribute='features_dict'),
+    '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
+}

api/fields/workflow_run_fields.py

@@ -0,0 +1,102 @@
+from flask_restful import 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,
+    "error": fields.String,
+    "elapsed_time": fields.Float,
+    "total_tokens": fields.Integer,
+    "total_steps": fields.Integer,
+    "created_at": TimestampField,
+    "finished_at": TimestampField
+}
+
+workflow_run_for_list_fields = {
+    "id": fields.String,
+    "sequence_number": fields.Integer,
+    "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
+}
+
+advanced_chat_workflow_run_for_list_fields = {
+    "id": fields.String,
+    "conversation_id": fields.String,
+    "message_id": fields.String,
+    "sequence_number": fields.Integer,
+    "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
+}
+
+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_detail_fields = {
+    "id": fields.String,
+    "sequence_number": fields.Integer,
+    "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
+}
+
+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
+}
+
+workflow_run_node_execution_list_fields = {
+    'data': fields.List(fields.Nested(workflow_run_node_execution_fields)),
+}