From edc61e9b4c7510f8a1c6982ddf73c32db5d1d65e Mon Sep 17 00:00:00 2001
From: balibabu <cike8899@users.noreply.github.com>
Date: Fri, 5 Jul 2024 15:52:24 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20save=20the=20parameters=20of=20the=20ge?=
 =?UTF-8?q?nerate=20operator=20to=20the=20form=20field=20=E2=80=A6=20(#139?=
 =?UTF-8?q?0)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

### What problem does this PR solve?
feat: save the parameters of the generate operator to the form field of
the node #918

### Type of change


- [x] New Feature (non-breaking change which adds functionality)
---
 .../components/llm-setting-items/index.tsx    |   2 +-
 web/src/locales/en.ts                         |   5 +-
 web/src/pages/flow/constant.tsx               |   5 +-
 .../flow/generate-form/dynamic-parameters.tsx | 171 +++++++++---------
 web/src/pages/flow/generate-form/hooks.ts     | 102 +++++++++++
 web/src/pages/flow/generate-form/index.less   |   2 +-
 web/src/pages/flow/generate-form/index.tsx    |   8 +-
 .../generate-form/next-dynamic-parameters.tsx | 135 --------------
 web/src/pages/flow/store.ts                   |  12 +-
 web/src/utils/form.ts                         |   2 +-
 10 files changed, 208 insertions(+), 236 deletions(-)
 create mode 100644 web/src/pages/flow/generate-form/hooks.ts
 delete mode 100644 web/src/pages/flow/generate-form/next-dynamic-parameters.tsx

diff --git a/web/src/components/llm-setting-items/index.tsx b/web/src/components/llm-setting-items/index.tsx
index 8b88b8703..d5f349e6a 100644
--- a/web/src/components/llm-setting-items/index.tsx
+++ b/web/src/components/llm-setting-items/index.tsx
@@ -51,7 +51,7 @@ const LlmSettingItems = ({ prefix, formItemLayout = {} }: IProps) => {
       <Divider></Divider>
       <Form.Item
         label={t('freedom')}
-        name="parameters"
+        name="parameter"
         tooltip={t('freedomTip')}
         {...formItemLayout}
         initialValue={ModelVariableType.Precise}
diff --git a/web/src/locales/en.ts b/web/src/locales/en.ts
index 9e11b6b3e..2dc8fb4d0 100644
--- a/web/src/locales/en.ts
+++ b/web/src/locales/en.ts
@@ -570,12 +570,15 @@ The above is the content you need to summarize.`,
       retrievalDescription: `This component is for the process of retrieving relevent information from knowledge base. So, knowledgebases should be selected. If there's nothing retrieved, the 'Empty response' will be returned.`,
       generateDescription: `This component is used to call LLM to generate text. Be careful about the prompt setting.`,
       categorizeDescription: `This component is used to categorize text. Please specify the name, description and examples of the category. Every single category leads to different downstream components.`,
-      relevantDescription: `This component is used to judge if the retrieved information is relevent to user's question. 'Yes' represents that they're relevant. 'No' represents they're irrelevant.`,
+      relevantDescription: `This component is used to judge if the output of upstream is relevent to user's latest question. 'Yes' represents that they're relevant. 'No' represents they're irrelevant.`,
       rewriteQuestionDescription: `This component is used to refine user's quesion. Typically, when a user's original question can't retrieve relevant information from knowledge base, this component help you change the question into a proper one which might be more consistant with the expressions in knowledge base. Only 'Retrieval' can be its downstreams.`,
       messageDescription:
         'This component is used to send user static information.',
       keywordDescription:
         'This component is used to send user static information.',
+      promptText: `Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:
+        {input}
+  The above is the content you need to summarize.`,
     },
     footer: {
       profile: 'All rights reserved @ React',
diff --git a/web/src/pages/flow/constant.tsx b/web/src/pages/flow/constant.tsx
index ab8bfb13e..68629d4d8 100644
--- a/web/src/pages/flow/constant.tsx
+++ b/web/src/pages/flow/constant.tsx
@@ -145,13 +145,12 @@ const initialLlmBaseValues = {
 };
 
 export const initialGenerateValues = {
-  // parameters: ModelVariableType.Precise,
-  // temperatureEnabled: true,
   ...initialLlmBaseValues,
   prompt: `Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:
-  {cluster_content}
+  {input}
 The above is the content you need to summarize.`,
   cite: true,
+  parameters: [],
 };
 
 export const initialRewriteQuestionValues = {
diff --git a/web/src/pages/flow/generate-form/dynamic-parameters.tsx b/web/src/pages/flow/generate-form/dynamic-parameters.tsx
index febdf8fd2..af7f7fc2f 100644
--- a/web/src/pages/flow/generate-form/dynamic-parameters.tsx
+++ b/web/src/pages/flow/generate-form/dynamic-parameters.tsx
@@ -1,103 +1,96 @@
+import { EditableCell, EditableRow } from '@/components/editable-cell';
 import { useTranslate } from '@/hooks/commonHooks';
-import { CloseOutlined } from '@ant-design/icons';
-import { Button, Card, Form, Input, Select, Typography } from 'antd';
-import { useUpdateNodeInternals } from 'reactflow';
-import { Operator } from '../constant';
-import {
-  useBuildFormSelectOptions,
-  useHandleFormSelectChange,
-} from '../form-hooks';
+import { DeleteOutlined } from '@ant-design/icons';
+import { Button, Flex, Select, Table, TableProps } from 'antd';
 import { IGenerateParameter } from '../interface';
 
+import {
+  useBuildComponentIdSelectOptions,
+  useHandleOperateParameters,
+} from './hooks';
+import styles from './index.less';
+
 interface IProps {
   nodeId?: string;
 }
 
+const components = {
+  body: {
+    row: EditableRow,
+    cell: EditableCell,
+  },
+};
+
 const DynamicParameters = ({ nodeId }: IProps) => {
-  const updateNodeInternals = useUpdateNodeInternals();
-  const form = Form.useFormInstance();
-  const buildCategorizeToOptions = useBuildFormSelectOptions(
-    Operator.Categorize,
-    nodeId,
-  );
-  const { handleSelectChange } = useHandleFormSelectChange(nodeId);
   const { t } = useTranslate('flow');
 
+  const options = useBuildComponentIdSelectOptions(nodeId);
+  const {
+    dataSource,
+    handleAdd,
+    handleRemove,
+    handleSave,
+    handleComponentIdChange,
+  } = useHandleOperateParameters(nodeId!);
+
+  const columns: TableProps<IGenerateParameter>['columns'] = [
+    {
+      title: t('key'),
+      dataIndex: 'key',
+      key: 'key',
+      onCell: (record: IGenerateParameter) => ({
+        record,
+        editable: true,
+        dataIndex: 'key',
+        title: 'key',
+        handleSave,
+      }),
+    },
+    {
+      title: t('componentId'),
+      dataIndex: 'component_id',
+      key: 'component_id',
+      align: 'center',
+      render(text, record) {
+        return (
+          <Select
+            style={{ width: '100%' }}
+            allowClear
+            options={options}
+            value={text}
+            onChange={handleComponentIdChange(record)}
+          />
+        );
+      },
+    },
+    {
+      title: t('operation'),
+      dataIndex: 'operation',
+      width: 20,
+      key: 'operation',
+      align: 'center',
+      render(_, record) {
+        return <DeleteOutlined onClick={handleRemove(record.id)} />;
+      },
+    },
+  ];
+
   return (
-    <>
-      <Form.List name="parameters">
-        {(fields, { add, remove }) => {
-          const handleAdd = () => {
-            const idx = fields.length;
-            add({ name: `parameter ${idx + 1}` });
-            if (nodeId) updateNodeInternals(nodeId);
-          };
-          return (
-            <div
-              style={{ display: 'flex', rowGap: 10, flexDirection: 'column' }}
-            >
-              {fields.map((field) => (
-                <Card
-                  size="small"
-                  key={field.key}
-                  extra={
-                    <CloseOutlined
-                      onClick={() => {
-                        remove(field.name);
-                      }}
-                    />
-                  }
-                >
-                  <Form.Item
-                    label={t('key')} // TODO: repeatability check
-                    name={[field.name, 'key']}
-                    rules={[{ required: true, message: t('nameMessage') }]}
-                  >
-                    <Input />
-                  </Form.Item>
-                  <Form.Item
-                    label={t('componentId')}
-                    name={[field.name, 'component_id']}
-                  >
-                    <Select
-                      allowClear
-                      options={buildCategorizeToOptions(
-                        (form.getFieldValue(['parameters']) ?? [])
-                          .map((x: IGenerateParameter) => x.component_id)
-                          .filter(
-                            (x: string) =>
-                              x !==
-                              form.getFieldValue([
-                                'parameters',
-                                field.name,
-                                'component_id',
-                              ]),
-                          ),
-                      )}
-                      onChange={handleSelectChange(
-                        form.getFieldValue(['parameters', field.name, 'key']),
-                      )}
-                    />
-                  </Form.Item>
-                </Card>
-              ))}
-
-              <Button type="dashed" onClick={handleAdd} block>
-                + Add Item
-              </Button>
-            </div>
-          );
-        }}
-      </Form.List>
-
-      <Form.Item noStyle shouldUpdate>
-        {() => (
-          <Typography>
-            <pre>{JSON.stringify(form.getFieldsValue(), null, 2)}</pre>
-          </Typography>
-        )}
-      </Form.Item>
-    </>
+    <section>
+      <Flex justify="end">
+        <Button size="small" onClick={handleAdd}>
+          {t('add')}
+        </Button>
+      </Flex>
+      <Table
+        dataSource={dataSource}
+        columns={columns}
+        rowKey={'id'}
+        className={styles.variableTable}
+        components={components}
+        rowClassName={() => styles.editableRow}
+      />
+    </section>
   );
 };
 
diff --git a/web/src/pages/flow/generate-form/hooks.ts b/web/src/pages/flow/generate-form/hooks.ts
new file mode 100644
index 000000000..28334ad68
--- /dev/null
+++ b/web/src/pages/flow/generate-form/hooks.ts
@@ -0,0 +1,102 @@
+import get from 'lodash/get';
+import { useCallback, useMemo } from 'react';
+import { v4 as uuid } from 'uuid';
+import { Operator } from '../constant';
+import { IGenerateParameter } from '../interface';
+import useGraphStore from '../store';
+
+// exclude nodes with branches
+const ExcludedNodes = [Operator.Categorize, Operator.Relevant];
+
+export const useBuildComponentIdSelectOptions = (nodeId?: string) => {
+  const nodes = useGraphStore((state) => state.nodes);
+
+  const options = useMemo(() => {
+    return nodes
+      .filter(
+        (x) =>
+          x.id !== nodeId && !ExcludedNodes.some((y) => y === x.data.label),
+      )
+      .map((x) => ({ label: x.data.name, value: x.id }));
+  }, [nodes, nodeId]);
+
+  return options;
+};
+
+export const useHandleOperateParameters = (nodeId: string) => {
+  const { getNode, updateNodeForm } = useGraphStore((state) => state);
+  const node = getNode(nodeId);
+  const dataSource: IGenerateParameter[] = useMemo(
+    () => get(node, 'data.form.parameters', []),
+    [node],
+  );
+
+  //   const [x, setDataSource] = useState<IGenerateParameter[]>([]);
+
+  const handleComponentIdChange = useCallback(
+    (row: IGenerateParameter) => (value: string) => {
+      const newData = [...dataSource];
+      const index = newData.findIndex((item) => row.id === item.id);
+      const item = newData[index];
+      newData.splice(index, 1, {
+        ...item,
+        component_id: value,
+      });
+
+      updateNodeForm(nodeId, { parameters: newData });
+      //   setDataSource(newData);
+    },
+    [updateNodeForm, nodeId, dataSource],
+  );
+
+  const handleRemove = useCallback(
+    (id?: string) => () => {
+      const newData = dataSource.filter((item) => item.id !== id);
+      updateNodeForm(nodeId, { parameters: newData });
+      // setDataSource(newData);
+    },
+    [updateNodeForm, nodeId, dataSource],
+  );
+
+  const handleAdd = useCallback(() => {
+    // setDataSource((state) => [
+    //   ...state,
+    //   {
+    //     id: uuid(),
+    //     key: '',
+    //     component_id: undefined,
+    //   },
+    // ]);
+    updateNodeForm(nodeId, {
+      parameters: [
+        ...dataSource,
+        {
+          id: uuid(),
+          key: '',
+          component_id: undefined,
+        },
+      ],
+    });
+  }, [dataSource, nodeId, updateNodeForm]);
+
+  const handleSave = (row: IGenerateParameter) => {
+    const newData = [...dataSource];
+    const index = newData.findIndex((item) => row.id === item.id);
+    const item = newData[index];
+    newData.splice(index, 1, {
+      ...item,
+      ...row,
+    });
+
+    updateNodeForm(nodeId, { parameters: newData });
+    // setDataSource(newData);
+  };
+
+  return {
+    handleAdd,
+    handleRemove,
+    handleComponentIdChange,
+    handleSave,
+    dataSource,
+  };
+};
diff --git a/web/src/pages/flow/generate-form/index.less b/web/src/pages/flow/generate-form/index.less
index 7af64e7ac..8de5a4f53 100644
--- a/web/src/pages/flow/generate-form/index.less
+++ b/web/src/pages/flow/generate-form/index.less
@@ -9,7 +9,7 @@
   :global(.editable-cell-value-wrap) {
     padding: 5px 12px;
     cursor: pointer;
-    height: 22px !important;
+    height: 30px !important;
   }
   &:hover {
     :global(.editable-cell-value-wrap) {
diff --git a/web/src/pages/flow/generate-form/index.tsx b/web/src/pages/flow/generate-form/index.tsx
index 01a8346e3..159f1ad8a 100644
--- a/web/src/pages/flow/generate-form/index.tsx
+++ b/web/src/pages/flow/generate-form/index.tsx
@@ -3,9 +3,9 @@ import { useTranslate } from '@/hooks/commonHooks';
 import { Form, Input, Switch } from 'antd';
 import { useSetLlmSetting } from '../hooks';
 import { IOperatorForm } from '../interface';
-import DynamicParameters from './next-dynamic-parameters';
+import DynamicParameters from './dynamic-parameters';
 
-const GenerateForm = ({ onValuesChange, form }: IOperatorForm) => {
+const GenerateForm = ({ onValuesChange, form, node }: IOperatorForm) => {
   const { t } = useTranslate('flow');
 
   useSetLlmSetting(form);
@@ -29,7 +29,7 @@ const GenerateForm = ({ onValuesChange, form }: IOperatorForm) => {
       <Form.Item
         name={['prompt']}
         label={t('prompt', { keyPrefix: 'knowledgeConfiguration' })}
-        initialValue={t('promptText', { keyPrefix: 'knowledgeConfiguration' })}
+        initialValue={t('promptText')}
         tooltip={t('promptTip', { keyPrefix: 'knowledgeConfiguration' })}
         rules={[
           {
@@ -49,7 +49,7 @@ const GenerateForm = ({ onValuesChange, form }: IOperatorForm) => {
       >
         <Switch />
       </Form.Item>
-      <DynamicParameters></DynamicParameters>
+      <DynamicParameters nodeId={node?.id}></DynamicParameters>
     </Form>
   );
 };
diff --git a/web/src/pages/flow/generate-form/next-dynamic-parameters.tsx b/web/src/pages/flow/generate-form/next-dynamic-parameters.tsx
deleted file mode 100644
index 8c848bc3b..000000000
--- a/web/src/pages/flow/generate-form/next-dynamic-parameters.tsx
+++ /dev/null
@@ -1,135 +0,0 @@
-import { EditableCell, EditableRow } from '@/components/editable-cell';
-import { useTranslate } from '@/hooks/commonHooks';
-import { DeleteOutlined } from '@ant-design/icons';
-import { Button, Flex, Select, Table, TableProps } from 'antd';
-import { useEffect, useState } from 'react';
-import { v4 as uuid } from 'uuid';
-import { IGenerateParameter } from '../interface';
-
-import { Operator } from '../constant';
-import { useBuildFormSelectOptions } from '../form-hooks';
-import styles from './index.less';
-
-interface IProps {
-  nodeId?: string;
-}
-
-const components = {
-  body: {
-    row: EditableRow,
-    cell: EditableCell,
-  },
-};
-
-const DynamicParameters = ({ nodeId }: IProps) => {
-  const [dataSource, setDataSource] = useState<IGenerateParameter[]>([]);
-  const { t } = useTranslate('flow');
-
-  const buildCategorizeToOptions = useBuildFormSelectOptions(
-    Operator.Generate,
-    nodeId,
-  );
-
-  const handleRemove = (id?: string) => () => {
-    const newData = dataSource.filter((item) => item.id !== id);
-    setDataSource(newData);
-  };
-
-  const handleAdd = () => {
-    setDataSource((state) => [
-      ...state,
-      {
-        id: uuid(),
-        key: '',
-        component_id: undefined,
-      },
-    ]);
-  };
-
-  const handleSave = (row: IGenerateParameter) => {
-    const newData = [...dataSource];
-    const index = newData.findIndex((item) => row.id === item.id);
-    const item = newData[index];
-    newData.splice(index, 1, {
-      ...item,
-      ...row,
-    });
-    setDataSource(newData);
-  };
-
-  useEffect(() => {}, [dataSource]);
-
-  const handleOptionalChange = (row: IGenerateParameter) => (value: string) => {
-    const newData = [...dataSource];
-    const index = newData.findIndex((item) => row.id === item.id);
-    const item = newData[index];
-    newData.splice(index, 1, {
-      ...item,
-      component_id: value,
-    });
-    setDataSource(newData);
-  };
-
-  const columns: TableProps<IGenerateParameter>['columns'] = [
-    {
-      title: t('key'),
-      dataIndex: 'key',
-      key: 'key',
-      onCell: (record: IGenerateParameter) => ({
-        record,
-        editable: true,
-        dataIndex: 'key',
-        title: 'key',
-        handleSave,
-      }),
-    },
-    {
-      title: t('componentId'),
-      dataIndex: 'component_id',
-      key: 'component_id',
-      align: 'center',
-      render(text, record) {
-        return (
-          <Select
-            style={{ width: '100%' }}
-            allowClear
-            options={buildCategorizeToOptions([])}
-            // onChange={handleSelectChange(
-            //   form.getFieldValue(['parameters', field.name, 'key']),
-            // )}
-          />
-        );
-      },
-    },
-    {
-      title: t('operation'),
-      dataIndex: 'operation',
-      width: 20,
-      key: 'operation',
-      align: 'center',
-      render(_, record) {
-        return <DeleteOutlined onClick={handleRemove(record.id)} />;
-      },
-    },
-  ];
-
-  return (
-    <section>
-      <Flex justify="end">
-        <Button size="small" onClick={handleAdd}>
-          {t('add')}
-        </Button>
-      </Flex>
-      <Table
-        dataSource={dataSource}
-        columns={columns}
-        rowKey={'id'}
-        className={styles.variableTable}
-        components={components}
-        rowClassName={() => styles.editableRow}
-      />
-    </section>
-  );
-};
-
-export default DynamicParameters;
diff --git a/web/src/pages/flow/store.ts b/web/src/pages/flow/store.ts
index fa208a588..f8f51b753 100644
--- a/web/src/pages/flow/store.ts
+++ b/web/src/pages/flow/store.ts
@@ -189,7 +189,17 @@ const useGraphStore = create<RFState>()(
         set({
           nodes: get().nodes.map((node) => {
             if (node.id === nodeId) {
-              node.data = { ...node.data, form: values };
+              // node.data = {
+              //   ...node.data,
+              //   form: { ...node.data.form, ...values },
+              // };
+              return {
+                ...node,
+                data: {
+                  ...node.data,
+                  form: { ...node.data.form, ...values },
+                },
+              } as any;
             }
 
             return node;
diff --git a/web/src/utils/form.ts b/web/src/utils/form.ts
index 1f15c5ea1..7b33fd1f0 100644
--- a/web/src/utils/form.ts
+++ b/web/src/utils/form.ts
@@ -20,7 +20,7 @@ export const excludeUnEnabledVariables = (
 export const removeUselessFieldsFromValues = (values: any, prefix?: string) => {
   const nextValues: any = omit(values, [
     ...Object.keys(variableEnabledFieldMap),
-    'parameters',
+    'parameter',
     ...excludeUnEnabledVariables(values, prefix),
   ]);