Variable assign (#2346)

* feat: Support variable assign

* feat: Workfloat support variable assign(#2114)

* feat: Support variable assign save input output value

* feat: Execution detail support variable assign(#2114)

* feat: Support variable assign dict array value config

* chore: rename package

---------

Co-authored-by: wangdan-fit2cloud <[email protected]>

Author: liuruibin

apps/application/flow/step_node/__init__.py

@@ -24,11 +24,14 @@
 from .speech_to_text_step_node import BaseSpeechToTextNode
 from .start_node import *
 from .text_to_speech_step_node.impl.base_text_to_speech_node import BaseTextToSpeechNode
+from .variable_assign_node import BaseVariableAssignNode
 
-node_list = [BaseStartStepNode, BaseChatNode, BaseSearchDatasetNode, BaseQuestionNode, BaseConditionNode, BaseReplyNode,
+node_list = [BaseStartStepNode, BaseChatNode, BaseSearchDatasetNode, BaseQuestionNode,
+             BaseConditionNode, BaseReplyNode,
              BaseFunctionNodeNode, BaseFunctionLibNodeNode, BaseRerankerNode, BaseApplicationNode,
              BaseDocumentExtractNode,
-             BaseImageUnderstandNode, BaseFormNode, BaseSpeechToTextNode, BaseTextToSpeechNode,BaseImageGenerateNode]
+             BaseImageUnderstandNode, BaseFormNode, BaseSpeechToTextNode, BaseTextToSpeechNode,
+             BaseImageGenerateNode, BaseVariableAssignNode]
 
 
 def get_node(node_type):

apps/application/flow/step_node/variable_assign_node/__init__.py

@@ -0,0 +1,3 @@
+# coding=utf-8
+
+from .impl import *

apps/application/flow/step_node/variable_assign_node/i_variable_assign_node.py

@@ -0,0 +1,27 @@
+# coding=utf-8
+
+from typing import Type
+
+from django.utils.translation import gettext_lazy as _
+from rest_framework import serializers
+
+from application.flow.i_step_node import INode, NodeResult
+from common.util.field_message import ErrMessage
+
+
+class VariableAssignNodeParamsSerializer(serializers.Serializer):
+    variable_list = serializers.ListField(required=True,
+                                          error_messages=ErrMessage.list(_("Reference Field")))
+
+
+class IVariableAssignNode(INode):
+    type = 'variable-assign-node'
+
+    def get_node_params_serializer_class(self) -> Type[serializers.Serializer]:
+        return VariableAssignNodeParamsSerializer
+
+    def _run(self):
+        return self.execute(**self.node_params_serializer.data, **self.flow_params_serializer.data)
+
+    def execute(self, variable_list, stream, **kwargs) -> NodeResult:
+        pass

apps/application/flow/step_node/variable_assign_node/impl/__init__.py

@@ -0,0 +1,9 @@
+# coding=utf-8
+"""
+    @project: maxkb
+    @Author：虎
+    @file： __init__.py
+    @date：2024/6/11 17:49
+    @desc:
+"""
+from .base_variable_assign_node import *

apps/application/flow/step_node/variable_assign_node/impl/base_variable_assign_node.py

@@ -0,0 +1,59 @@
+# coding=utf-8
+import json
+from typing import List
+
+from application.flow.i_step_node import NodeResult
+from application.flow.step_node.variable_assign_node.i_variable_assign_node import IVariableAssignNode
+
+
+class BaseVariableAssignNode(IVariableAssignNode):
+    def save_context(self, details, workflow_manage):
+        self.context['variable_list'] = details.get('variable_list')
+        self.context['result_list'] = details.get('result_list')
+
+    def execute(self, variable_list, stream, **kwargs) -> NodeResult:
+        #
+        result_list = []
+        for variable in variable_list:
+            if 'fields' not in variable:
+                continue
+            if 'global' == variable['fields'][0]:
+                result = {
+                    'name': variable['name'],
+                    'input_value': self.get_reference_content(variable['fields']),
+                }
+                if variable['source'] == 'custom':
+                    if variable['type'] in ['dict', 'array']:
+                        if isinstance(variable['value'], dict) or isinstance(variable['value'], list):
+                            val = variable['value']
+                        else:
+                            val = json.loads(variable['value'])
+                        self.workflow_manage.context[variable['fields'][1]] = val
+                        result['output_value'] = variable['value'] = val
+                    else:
+                        self.workflow_manage.context[variable['fields'][1]] = variable['value']
+                        result['output_value'] = variable['value']
+                else:
+                    reference = self.get_reference_content(variable['reference'])
+                    self.workflow_manage.context[variable['fields'][1]] = reference
+                    result['output_value'] = reference
+                result_list.append(result)
+
+        return NodeResult({'variable_list': variable_list, 'result_list': result_list}, {})
+
+    def get_reference_content(self, fields: List[str]):
+        return str(self.workflow_manage.get_reference_field(
+            fields[0],
+            fields[1:]))
+
+    def get_details(self, index: int, **kwargs):
+        return {
+            'name': self.node.properties.get('stepName'),
+            "index": index,
+            'run_time': self.context.get('run_time'),
+            'type': self.node.type,
+            'variable_list': self.context.get('variable_list'),
+            'result_list': self.context.get('result_list'),
+            'status': self.status,
+            'err_message': self.err_message
+        }

ui/src/assets/icon_assigner.svg

@@ -59,13 +59,16 @@
                       <h5 class="p-8-12">
                         {{ $t('common.param.inputParam') }}
                       </h5>
+
                       <div class="p-8-12 border-t-dashed lighter">
                         <div class="mb-8">
                           <span class="color-secondary">
                             {{ $t('chat.paragraphSource.question') }}:</span
                           >
+
                           {{ item.question || '-' }}
                         </div>
+
                         <div v-for="(f, i) in item.global_fields" :key="i" class="mb-8">
                           <span class="color-secondary">{{ f.label }}:</span> {{ f.value }}
                         </div>
@@ -604,6 +607,30 @@
                       </div>
                     </div>
                   </template>
+
+                  <!-- 变量赋值 -->
+                  <template v-if="item.type === WorkflowType.VariableAssignNode">
+                    <div class="card-never border-r-4">
+                      <h5 class="p-8-12">
+                        {{ $t('common.param.inputParam') }}
+                      </h5>
+                      <div class="p-8-12 border-t-dashed lighter">
+                        <div v-for="(f, i) in item.result_list" :key="i" class="mb-8">
+                          <span class="color-secondary">{{ f.name }}:</span> {{ f.input_value }}
+                        </div>
+                      </div>
+                    </div>
+                    <div class="card-never border-r-4">
+                      <h5 class="p-8-12">
+                        {{ $t('common.param.outputParam') }}
+                      </h5>
+                      <div class="p-8-12 border-t-dashed lighter">
+                        <div v-for="(f, i) in item.result_list" :key="i" class="mb-8">
+                          <span class="color-secondary">{{ f.name }}:</span> {{ f.output_value }}
+                        </div>
+                      </div>
+                    </div>
+                  </template>
                 </template>
                 <template v-else>
                   <div class="card-never border-r-4">

ui/src/components/ai-chat/ExecutionDetailDialog.vue

@@ -12,8 +12,9 @@ export enum WorkflowType {
   Application = 'application-node',
   DocumentExtractNode = 'document-extract-node',
   ImageUnderstandNode = 'image-understand-node',
+  VariableAssignNode = 'variable-assign-node',
   FormNode = 'form-node',
   TextToSpeechNode = 'text-to-speech-node',
   SpeechToTextNode = 'speech-to-text-node',
-    ImageGenerateNode = 'image-generate-node'
+  ImageGenerateNode = 'image-generate-node'
 }

ui/src/enums/workflow.ts

@@ -19,7 +19,7 @@ export default {
     autoSave: 'Auto Save',
     latestRelease: 'Latest Release',
     copyParam: 'Copy Parameters',
-    debug: 'Run',
+    debug: 'Run'
   },
   tip: {
     publicSuccess: 'Published successfully',
@@ -48,12 +48,13 @@ export default {
     beautify: 'Auto-Arrange'
   },
   variable: {
+    label: 'Variable',
     global: 'Global Variable',
     Referencing: 'Referenced Variable',
     ReferencingRequired: 'Referenced variable is required',
     ReferencingError: 'Invalid referenced variable',
     NoReferencing: 'Referenced variable does not exist',
-    fieldMessage: 'Please select a variable'
+    placeholder: 'Please select a variable'
   },
   condition: {
     title: 'Execution Condition',
@@ -82,12 +83,11 @@ export default {
     baseNode: {
       label: 'Base Information',
       appName: {
-        label: 'App Name',
-    
+        label: 'App Name'
       },
       appDescription: {
-        label: 'App Description',
-       },
+        label: 'App Description'
+      },
       fileUpload: {
         label: 'File Upload',
         tooltip: 'When enabled, the Q&A page will display a file upload button.'
@@ -114,7 +114,7 @@ export default {
                   If you want the user to see the output of this node, please turn on the switch.`
       },
       defaultPrompt: 'Known Information',
-      think: 'Thinking Process',
+      think: 'Thinking Process'
     },
     searchDatasetNode: {
       label: 'Knowledge Retrieval',
@@ -188,8 +188,7 @@ export default {
         label: 'Form Output Content',
         requiredMessage:
           'Please set the output content of this node, { form } is a placeholder for the form.',
-        tooltip:
-          'Define the output content of this node. { form } is a placeholder for the form'
+        tooltip: 'Define the output content of this node. { form } is a placeholder for the form'
       },
       formAllContent: 'All Form Content',
       formSetting: 'Form Configuration'
@@ -212,6 +211,11 @@ export default {
         requiredMessage: 'Please select an image'
       }
     },
+    variableAssignNode: {
+      label: 'Variable Assign',
+      text: 'Update the value of the global variable',
+      assign: 'Set Value'
+    },
     imageGenerateNode: {
       label: 'Image Generation',
       text: 'Generate images based on provided text content',
@@ -222,13 +226,11 @@ export default {
       },
       prompt: {
         label: 'Positive Prompt',
-        tooltip:
-          'Describe elements and visual features you want in the generated image'
+        tooltip: 'Describe elements and visual features you want in the generated image'
       },
       negative_prompt: {
         label: 'Negative Prompt',
-        tooltip:
-          'Describe elements you want to exclude from the generated image',
+        tooltip: 'Describe elements you want to exclude from the generated image',
         placeholder:
           'Please describe content you do not want to generate, such as color, bloody content'
       }

ui/src/locales/lang/en-US/views/application-workflow.ts

@@ -19,7 +19,7 @@ export default {
     autoSave: '自动保存',
     latestRelease: '最近发布',
     copyParam: '复制参数',
-    debug: '调试',
+    debug: '调试'
   },
   tip: {
     publicSuccess: '发布成功',
@@ -48,12 +48,13 @@ export default {
     beautify: '一键美化'
   },
   variable: {
+    label: '变量',
     global: '全局变量',
     Referencing: '引用变量',
     ReferencingRequired: '引用变量必填',
     ReferencingError: '引用变量错误',
     NoReferencing: '不存在的引用变量',
-    fieldMessage: '请选择变量'
+    placeholder: '请选择变量'
   },
   condition: {
     title: '执行条件',
@@ -83,12 +84,11 @@ export default {
     baseNode: {
       label: '基本信息',
       appName: {
-        label: '应用名称',
-    
+        label: '应用名称'
       },
       appDescription: {
-        label: '应用描述',
-       },
+        label: '应用描述'
+      },
       fileUpload: {
         label: '文件上传',
         tooltip: '开启后，问答页面会显示上传文件的按钮。'
@@ -115,7 +115,7 @@ export default {
                   如果你想让用户看到该节点的输出内容，请打开开关。`
       },
       defaultPrompt: '已知信息',
-      think: '思考过程',
+      think: '思考过程'
     },
     searchDatasetNode: {
       label: '知识库检索',
@@ -211,6 +211,11 @@ export default {
         requiredMessage: '请选择图片'
       }
     },
+    variableAssignNode: {
+      label: '变量赋值',
+      text: '更新全局变量的值',
+      assign: '赋值'
+    },
     imageGenerateNode: {
       label: '图片生成',
       text: '根据提供的文本内容生成图片',