chore(api): Introduce Ruff Formatter. (#7291)

api/fields/annotation_fields.py

@@ -5,7 +5,7 @@ from libs.helper import TimestampField
 annotation_fields = {
     "id": fields.String,
     "question": fields.String,
-    "answer": fields.Raw(attribute='content'),
+    "answer": fields.Raw(attribute="content"),
     "hit_count": fields.Integer,
     "created_at": TimestampField,
     # 'account': fields.Nested(simple_account_fields, allow_null=True)
@@ -21,8 +21,8 @@ annotation_hit_history_fields = {
     "score": fields.Float,
     "question": fields.String,
     "created_at": TimestampField,
-    "match": fields.String(attribute='annotation_question'),
-    "response": fields.String(attribute='annotation_content')
+    "match": fields.String(attribute="annotation_question"),
+    "response": fields.String(attribute="annotation_content"),
 }
 
 annotation_hit_history_list_fields = {

api/fields/api_based_extension_fields.py

@@ -8,16 +8,16 @@ class HiddenAPIKey(fields.Raw):
         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]
+            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:]
+            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
+    "id": fields.String,
+    "name": fields.String,
+    "api_endpoint": fields.String,
+    "api_key": HiddenAPIKey,
+    "created_at": TimestampField,
 }

api/fields/app_fields.py

@@ -3,157 +3,153 @@ from flask_restful import fields
 from libs.helper import TimestampField
 
 app_detail_kernel_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,
+    "id": fields.String,
+    "name": fields.String,
+    "description": fields.String,
+    "mode": fields.String(attribute="mode_compatible_with_agent"),
+    "icon": fields.String,
+    "icon_background": fields.String,
 }
 
 related_app_list = {
-    'data': fields.List(fields.Nested(app_detail_kernel_fields)),
-    'total': fields.Integer,
+    "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_at': TimestampField
+    "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_at": TimestampField,
 }
 
 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),
-    'tracing': fields.Raw,
-    'created_at': TimestampField
+    "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),
+    "tracing": fields.Raw,
+    "created_at": TimestampField,
 }
 
 prompt_config_fields = {
-    'prompt_template': fields.String,
+    "prompt_template": fields.String,
 }
 
 model_config_partial_fields = {
-    'model': fields.Raw(attribute='model_dict'),
-    'pre_prompt': fields.String,
+    "model": fields.Raw(attribute="model_dict"),
+    "pre_prompt": fields.String,
 }
 
-tag_fields = {
-    'id': fields.String,
-    'name': fields.String,
-    'type': fields.String
-}
+tag_fields = {"id": fields.String, "name": fields.String, "type": fields.String}
 
 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': fields.String,
-    'icon_background': fields.String,
-    'model_config': fields.Nested(model_config_partial_fields, attribute='app_model_config', allow_null=True),
-    'created_at': TimestampField,
-    'tags': fields.List(fields.Nested(tag_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": fields.String,
+    "icon_background": fields.String,
+    "model_config": fields.Nested(model_config_partial_fields, attribute="app_model_config", allow_null=True),
+    "created_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')
+    "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),
+    "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)),
+    "data": fields.List(fields.Nested(template_fields)),
 }
 
 site_fields = {
-    '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,
-    '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,
+    "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,
+    "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,
 }
 
 app_detail_fields_with_site = {
-    '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),
-    'site': fields.Nested(site_fields),
-    'api_base_url': fields.String,
-    'created_at': TimestampField,
-    'deleted_tools': fields.List(fields.String),
+    "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),
+    "site": fields.Nested(site_fields),
+    "api_base_url": fields.String,
+    "created_at": TimestampField,
+    "deleted_tools": fields.List(fields.String),
 }
 
 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,
+    "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,
 }

api/fields/conversation_fields.py

@@ -6,205 +6,202 @@ from libs.helper import TimestampField
 
 class MessageTextField(fields.Raw):
     def format(self, value):
-        return value[0]['text'] if value else ''
+        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),
+    "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
+    "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
+    "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,
-    'type': fields.String,
-    'url': fields.String,
-    'belongs_to': fields.String(default='user'),
+    "id": fields.String,
+    "type": fields.String,
+    "url": fields.String,
+    "belongs_to": fields.String(default="user"),
 }
 
 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),
+    "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': fields.Raw,
-    '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), attribute='files'),
-    'metadata': fields.Raw(attribute='message_metadata_dict'),
-    'status': fields.String,
-    'error': fields.String,
+    "id": fields.String,
+    "conversation_id": fields.String,
+    "inputs": fields.Raw,
+    "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), attribute="files"),
+    "metadata": fields.Raw(attribute="message_metadata_dict"),
+    "status": fields.String,
+    "error": fields.String,
 }
 
-feedback_stat_fields = {
-    'like': fields.Integer,
-    'dislike': fields.Integer
-}
+feedback_stat_fields = {"like": fields.Integer, "dislike": 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,
+    "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_configs_fields = {
-    'prompt_template': fields.String,
+    "prompt_template": fields.String,
 }
 
 simple_model_config_fields = {
-    'model': fields.Raw(attribute='model_dict'),
-    'pre_prompt': fields.String,
+    "model": fields.Raw(attribute="model_dict"),
+    "pre_prompt": fields.String,
 }
 
 simple_message_detail_fields = {
-    'inputs': fields.Raw,
-    'query': fields.String,
-    'message': MessageTextField,
-    'answer': fields.String,
+    "inputs": fields.Raw,
+    "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,
-    'read_at': TimestampField,
-    'created_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')
+    "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,
+    "read_at": TimestampField,
+    "created_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')
+    "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'),
+    "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,
-    'name': fields.String,
-    'summary': fields.String(attribute='summary_or_query'),
-    'read_at': TimestampField,
-    'created_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)
+    "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,
+    "name": fields.String,
+    "summary": fields.String(attribute="summary_or_query"),
+    "read_at": TimestampField,
+    "created_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),
 }
 
 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')
+    "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,
-    '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)
+    "id": fields.String,
+    "status": fields.String,
+    "from_source": fields.String,
+    "from_end_user_id": fields.String,
+    "from_account_id": fields.String,
+    "created_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': fields.Raw,
-    'status': fields.String,
-    'introduction': fields.String,
-    'created_at': TimestampField
+    "id": fields.String,
+    "name": fields.String,
+    "inputs": fields.Raw,
+    "status": fields.String,
+    "introduction": fields.String,
+    "created_at": TimestampField,
 }
 
 conversation_infinite_scroll_pagination_fields = {
-    'limit': fields.Integer,
-    'has_more': fields.Boolean,
-    'data': fields.List(fields.Nested(simple_conversation_fields))
+    "limit": fields.Integer,
+    "has_more": fields.Boolean,
+    "data": fields.List(fields.Nested(simple_conversation_fields)),
 }
 
 conversation_with_model_config_fields = {
     **simple_conversation_fields,
-    'model_config': fields.Raw,
+    "model_config": fields.Raw,
 }
 
 conversation_with_model_config_infinite_scroll_pagination_fields = {
-    'limit': fields.Integer,
-    'has_more': fields.Boolean,
-    'data': fields.List(fields.Nested(conversation_with_model_config_fields))
+    "limit": fields.Integer,
+    "has_more": fields.Boolean,
+    "data": fields.List(fields.Nested(conversation_with_model_config_fields)),
 }

api/fields/conversation_variable_fields.py

@@ -3,19 +3,19 @@ from flask_restful import fields
 from libs.helper import TimestampField
 
 conversation_variable_fields = {
-    'id': fields.String,
-    'name': fields.String,
-    'value_type': fields.String(attribute='value_type.value'),
-    'value': fields.String,
-    'description': fields.String,
-    'created_at': TimestampField,
-    'updated_at': TimestampField,
+    "id": fields.String,
+    "name": fields.String,
+    "value_type": fields.String(attribute="value_type.value"),
+    "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'),
+    "page": fields.Integer,
+    "limit": fields.Integer,
+    "total": fields.Integer,
+    "has_more": fields.Boolean,
+    "data": fields.List(fields.Nested(conversation_variable_fields), attribute="data"),
 }

api/fields/data_source_fields.py

@@ -2,64 +2,56 @@ from flask_restful import fields
 
 from libs.helper import TimestampField
 
-integrate_icon_fields = {
-    'type': fields.String,
-    'url': fields.String,
-    'emoji': fields.String
-}
+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
+    "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))
+    "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)),
+    "notion_info": fields.List(fields.Nested(integrate_workspace_fields)),
 }
 
-integrate_icon_fields = {
-    'type': fields.String,
-    'url': fields.String,
-    'emoji': fields.String
-}
+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),
-    'parent_id': fields.String,
-    'type': fields.String
+    "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
+    "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)
+    "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)),
-}
+    "data": fields.List(fields.Nested(integrate_fields)),
+}

api/fields/dataset_fields.py

@@ -3,73 +3,64 @@ from flask_restful 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,
+    "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
-}
+reranking_model_fields = {"reranking_provider_name": fields.String, "reranking_model_name": fields.String}
 
-keyword_setting_fields = {
-    'keyword_weight': fields.Float
-}
+keyword_setting_fields = {"keyword_weight": fields.Float}
 
 vector_setting_fields = {
-    'vector_weight': fields.Float,
-    'embedding_model_name': fields.String,
-    'embedding_provider_name': fields.String,
+    "vector_weight": fields.Float,
+    "embedding_model_name": fields.String,
+    "embedding_provider_name": fields.String,
 }
 
 weighted_score_fields = {
-    'keyword_setting': fields.Nested(keyword_setting_fields),
-    'vector_setting': fields.Nested(vector_setting_fields),
+    "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
+    "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,
 }
 
-tag_fields = {
-    'id': fields.String,
-    'name': fields.String,
-    'type': fields.String
-}
+tag_fields = {"id": fields.String, "name": fields.String, "type": 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,
-    '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))
+    "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,
+    "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)),
 }
 
 dataset_query_detail_fields = {
@@ -79,7 +70,5 @@ dataset_query_detail_fields = {
     "source_app_id": fields.String,
     "created_by_role": fields.String,
     "created_by": fields.String,
-    "created_at": TimestampField
+    "created_at": TimestampField,
 }
-
-

api/fields/document_fields.py

@@ -4,75 +4,73 @@ from fields.dataset_fields import dataset_fields
 from libs.helper import TimestampField
 
 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,
+    "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,
 }
 
 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,
-    '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
+    "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,
+    "completed_segments": fields.Integer,
+    "total_segments": fields.Integer,
 }
 
 dataset_and_document_fields = {
-    'dataset': fields.Nested(dataset_fields),
-    'documents': fields.List(fields.Nested(document_fields)),
-    'batch': fields.String
+    "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,
+    "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))
-}
+document_status_fields_list = {"data": fields.List(fields.Nested(document_status_fields))}

api/fields/end_user_fields.py

@@ -1,8 +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,
+    "id": fields.String,
+    "type": fields.String,
+    "is_anonymous": fields.Boolean,
+    "session_id": fields.String,
 }

api/fields/file_fields.py

@@ -3,17 +3,17 @@ from flask_restful import 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,
+    "file_size_limit": fields.Integer,
+    "batch_count_limit": fields.Integer,
+    "image_file_size_limit": fields.Integer,
 }
 
 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,
-}
+    "id": fields.String,
+    "name": fields.String,
+    "size": fields.Integer,
+    "extension": fields.String,
+    "mime_type": fields.String,
+    "created_by": fields.String,
+    "created_at": TimestampField,
+}

api/fields/hit_testing_fields.py

@@ -3,39 +3,39 @@ from flask_restful import fields
 from libs.helper import TimestampField
 
 document_fields = {
-    'id': fields.String,
-    'data_source_type': fields.String,
-    'name': fields.String,
-    'doc_type': fields.String,
+    "id": fields.String,
+    "data_source_type": fields.String,
+    "name": fields.String,
+    "doc_type": fields.String,
 }
 
 segment_fields = {
-    'id': fields.String,
-    'position': fields.Integer,
-    'document_id': fields.String,
-    '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),
+    "id": fields.String,
+    "position": fields.Integer,
+    "document_id": fields.String,
+    "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),
 }
 
 hit_testing_record_fields = {
-    'segment': fields.Nested(segment_fields),
-    'score': fields.Float,
-    'tsne_position': fields.Raw
-}
+    "segment": fields.Nested(segment_fields),
+    "score": fields.Float,
+    "tsne_position": fields.Raw,
+}

api/fields/installed_app_fields.py

@@ -3,23 +3,21 @@ from flask_restful import fields
 from libs.helper import TimestampField
 
 app_fields = {
-    'id': fields.String,
-    'name': fields.String,
-    'mode': fields.String,
-    'icon': fields.String,
-    'icon_background': fields.String
+    "id": fields.String,
+    "name": fields.String,
+    "mode": fields.String,
+    "icon": fields.String,
+    "icon_background": fields.String,
 }
 
 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
+    "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))
-}
+installed_app_list_fields = {"installed_apps": fields.List(fields.Nested(installed_app_fields))}

api/fields/member_fields.py

@@ -2,38 +2,32 @@ from flask_restful import fields
 
 from libs.helper import TimestampField
 
-simple_account_fields = {
-    'id': fields.String,
-    'name': fields.String,
-    'email': fields.String
-}
+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
+    "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,
-    'last_active_at': TimestampField,
-    'created_at': TimestampField,
-    'role': fields.String,
-    'status': fields.String,
+    "id": fields.String,
+    "name": fields.String,
+    "avatar": fields.String,
+    "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))
-}
+account_with_role_list_fields = {"accounts": fields.List(fields.Nested(account_with_role_fields))}

api/fields/message_fields.py

@@ -3,83 +3,79 @@ from flask_restful import fields
 from fields.conversation_fields import message_file_fields
 from libs.helper import TimestampField
 
-feedback_fields = {
-    'rating': fields.String
-}
+feedback_fields = {"rating": fields.String}
 
 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
+    "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,
 }
 
-feedback_fields = {
-    'rating': fields.String
-}
+feedback_fields = {"rating": fields.String}
 
 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)
+    "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),
 }
 
 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
+    "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,
-    'inputs': fields.Raw,
-    '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), attribute='files'),
-    'status': fields.String,
-    'error': fields.String,
+    "id": fields.String,
+    "conversation_id": fields.String,
+    "inputs": fields.Raw,
+    "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), attribute="files"),
+    "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))
+    "limit": fields.Integer,
+    "has_more": fields.Boolean,
+    "data": fields.List(fields.Nested(message_fields)),
 }

api/fields/segment_fields.py

@@ -3,31 +3,31 @@ from flask_restful import fields
 from libs.helper import TimestampField
 
 segment_fields = {
-    'id': fields.String,
-    'position': fields.Integer,
-    'document_id': fields.String,
-    '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
+    "id": fields.String,
+    "position": fields.Integer,
+    "document_id": fields.String,
+    "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,
 }
 
 segment_list_response = {
-    'data': fields.List(fields.Nested(segment_fields)),
-    'has_more': fields.Boolean,
-    'limit': fields.Integer
+    "data": fields.List(fields.Nested(segment_fields)),
+    "has_more": fields.Boolean,
+    "limit": fields.Integer,
 }

api/fields/tag_fields.py

@@ -1,8 +1,3 @@
 from flask_restful import fields
 
-tag_fields = {
-    'id': fields.String,
-    'name': fields.String,
-    'type': fields.String,
-    'binding_count': fields.String
-}
+tag_fields = {"id": fields.String, "name": fields.String, "type": fields.String, "binding_count": fields.String}

api/fields/workflow_app_log_fields.py

@@ -7,18 +7,18 @@ 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),
+    "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
+    "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')
+    "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

@@ -13,43 +13,43 @@ class EnvironmentVariableField(fields.Raw):
         # Mask secret variables values in environment_variables
         if isinstance(value, SecretVariable):
             return {
-                'id': value.id,
-                'name': value.name,
-                'value': encrypter.obfuscated_token(value.value),
-                'value_type': value.value_type.value,
+                "id": value.id,
+                "name": value.name,
+                "value": encrypter.obfuscated_token(value.value),
+                "value_type": value.value_type.value,
             }
         if isinstance(value, Variable):
             return {
-                'id': value.id,
-                'name': value.name,
-                'value': value.value,
-                'value_type': value.value_type.value,
+                "id": value.id,
+                "name": value.name,
+                "value": value.value,
+                "value_type": value.value_type.value,
             }
         if isinstance(value, dict):
-            value_type = value.get('value_type')
+            value_type = value.get("value_type")
             if value_type not in ENVIRONMENT_VARIABLE_SUPPORTED_TYPES:
-                raise ValueError(f'Unsupported environment variable value type: {value_type}')
+                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='value_type.value'),
-    'value': fields.Raw,
-    'description': fields.String,
+    "id": fields.String,
+    "name": fields.String,
+    "value_type": fields.String(attribute="value_type.value"),
+    "value": fields.Raw,
+    "description": 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'),
-    '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)),
+    "id": fields.String,
+    "graph": fields.Raw(attribute="graph_dict"),
+    "features": fields.Raw(attribute="features_dict"),
+    "hash": fields.String(attribute="unique_hash"),
+    "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)),
 }

api/fields/workflow_run_fields.py

@@ -13,7 +13,7 @@ workflow_run_for_log_fields = {
     "total_tokens": fields.Integer,
     "total_steps": fields.Integer,
     "created_at": TimestampField,
-    "finished_at": TimestampField
+    "finished_at": TimestampField,
 }
 
 workflow_run_for_list_fields = {
@@ -24,9 +24,9 @@ workflow_run_for_list_fields = {
     "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_by_account": fields.Nested(simple_account_fields, attribute="created_by_account", allow_null=True),
     "created_at": TimestampField,
-    "finished_at": TimestampField
+    "finished_at": TimestampField,
 }
 
 advanced_chat_workflow_run_for_list_fields = {
@@ -39,40 +39,40 @@ advanced_chat_workflow_run_for_list_fields = {
     "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_by_account": fields.Nested(simple_account_fields, attribute="created_by_account", allow_null=True),
     "created_at": TimestampField,
-    "finished_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')
+    "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')
+    "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'),
+    "graph": fields.Raw(attribute="graph_dict"),
+    "inputs": fields.Raw(attribute="inputs_dict"),
     "status": fields.String,
-    "outputs": fields.Raw(attribute='outputs_dict'),
+    "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_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
+    "finished_at": TimestampField,
 }
 
 workflow_run_node_execution_fields = {
@@ -82,21 +82,21 @@ workflow_run_node_execution_fields = {
     "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'),
+    "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'),
+    "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
+    "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)),
+    "data": fields.List(fields.Nested(workflow_run_node_execution_fields)),
 }