From 49cebd9fec3105130e55d987ae87461667debd81 Mon Sep 17 00:00:00 2001 From: balibabu Date: Tue, 7 Jan 2025 19:33:53 +0800 Subject: [PATCH] Feat: Add description for tag parsing method #4368 (#4402) ### What problem does this PR solve? Feat: Add description for tag parsing method #4368 ### Type of change - [x] New Feature (non-breaking change which adds functionality) --- web/src/assets/svg/chunk-method/tag-01.svg | 84 +++++++++++++++++++ web/src/assets/svg/chunk-method/tag-02.svg | 84 +++++++++++++++++++ web/src/locales/en.ts | 14 +++- web/src/locales/zh-traditional.ts | 14 +++- web/src/locales/zh.ts | 14 +++- .../components/knowledge-setting/tag-tabs.tsx | 46 +++++++--- .../components/knowledge-setting/utils.ts | 1 + .../form/generate-form/dynamic-parameters.tsx | 5 +- 8 files changed, 244 insertions(+), 18 deletions(-) create mode 100644 web/src/assets/svg/chunk-method/tag-01.svg create mode 100644 web/src/assets/svg/chunk-method/tag-02.svg diff --git a/web/src/assets/svg/chunk-method/tag-01.svg b/web/src/assets/svg/chunk-method/tag-01.svg new file mode 100644 index 000000000..0ed6351ee --- /dev/null +++ b/web/src/assets/svg/chunk-method/tag-01.svg @@ -0,0 +1,84 @@ + + knowledge-graph-B-svg + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/web/src/assets/svg/chunk-method/tag-02.svg b/web/src/assets/svg/chunk-method/tag-02.svg new file mode 100644 index 000000000..b8498d6ab --- /dev/null +++ b/web/src/assets/svg/chunk-method/tag-02.svg @@ -0,0 +1,84 @@ + + knowledge-graph-A-svg + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/web/src/locales/en.ts b/web/src/locales/en.ts index 788862673..a42daa827 100644 --- a/web/src/locales/en.ts +++ b/web/src/locales/en.ts @@ -286,6 +286,16 @@ export default {

This approach chunks files using the 'naive'/'General' method. It splits a document into segments and then combines adjacent segments until the token count exceeds the threshold specified by 'Chunk token number', at which point a chunk is created.

The chunks are then fed to the LLM to extract entities and relationships for a knowledge graph and a mind map.

Ensure that you set the Entity types.

`, + tag: `

Knowlege base using 'Tag' as a chunking method is supposed to be used by other knowledge bases to add tags to their chunks, queries to which will also be with tags too.

+

Knowlege base using 'Tag' as a chunking method is NOT supposed to be involved in RAG procedure.

+

The chunks in this knowledge base are examples of tags, which demonstrate the entire tag set and the relevance between chunk and tags.

+ +

This chunk method supports EXCEL and CSV/TXT file formats.

+

If a file is in Excel format, it should contain two columns without headers: one for content and the other for tags, with the content column preceding the tags column. Multiple sheets are acceptable, provided the columns are properly structured.

+

If a file is in CSV/TXT format, it must be UTF-8 encoded with TAB as the delimiter to separate content and tags.

+

In tags column, there're English comma between tags.

+Lines of texts that fail to follow the above rules will be ignored, and each pair will be considered a distinct chunk. +`, useRaptor: 'Use RAPTOR to enhance retrieval', useRaptorTip: 'Recursive Abstractive Processing for Tree-Organized Retrieval, see https://huggingface.co/papers/2401.18059 for more information.', @@ -310,9 +320,11 @@ The above is the content you need to summarize.`, vietnamese: 'Vietnamese', pageRank: 'Page rank', pageRankTip: `This increases the relevance score of the knowledge base. Its value will be added to the relevance score of all retrieved chunks from this knowledge base. Useful when you are searching within multiple knowledge bases and wanting to assign a higher pagerank score to a specific one.`, - tag: 'Tag', + tagName: 'Tag', frequency: 'Frequency', searchTags: 'Search tags', + tagCloud: 'Cloud', + tagTable: 'Table', }, chunk: { chunk: 'Chunk', diff --git a/web/src/locales/zh-traditional.ts b/web/src/locales/zh-traditional.ts index 50a59c7dc..26dcfa4b7 100644 --- a/web/src/locales/zh-traditional.ts +++ b/web/src/locales/zh-traditional.ts @@ -271,6 +271,16 @@ export default {

接下來，區塊將傳送到LLM以提取知識圖譜和思維導圖的節點和關係。

請注意您需要指定的條目類型。

`, + tag: `

使用「標籤」作為分塊方法的知識庫應該被其他知識庫用來將標籤加入其區塊中，查詢也將帶有標籤。 +

使用「標籤」作為分塊方法的知識庫不應該參與 RAG 過程。 +

本知識庫中的區塊是標籤的範例，展示了整個標籤集以及區塊與標籤之間的相關性。 + +

此區塊方法支援EXCEL和CSV/TXT檔案格式。 +

如果檔案採用 Excel 格式，則應包含兩列，不含標題：一列用於內容，另一列用於標籤，內容列位於標籤列之前。只要列的結構正確，多張紙也是可以接受的。 +

如果檔案為CSV/TXT格式，則必須採用UTF-8編碼，並以TAB作為分隔符號來分隔內容和標籤。 +

標籤欄中，標籤之間有英文逗號。 +不符合上述規則的文字行將被忽略，並且每一對將被視為一個不同的區塊。 +`, useRaptor: '使用RAPTOR文件增強策略', useRaptorTip: '請參考 https://huggingface.co/papers/2401.18059', prompt: '提示詞', @@ -294,9 +304,11 @@ export default { pageRank: '頁面排名', pageRankTip: `這用來提高相關性分數。所有檢索到的區塊的相關性得分將加上該數字。 當您想要先搜尋給定的知識庫時，請設定比其他人更高的 pagerank 分數。`, - tag: '標籤', + tagName: '標籤', frequency: '頻次', searchTags: '搜尋標籤', + tagCloud: '雲端', + tagTable: '表', }, chunk: { chunk: '解析塊', diff --git a/web/src/locales/zh.ts b/web/src/locales/zh.ts index 2d6dc32c6..b5f7d415e 100644 --- a/web/src/locales/zh.ts +++ b/web/src/locales/zh.ts @@ -288,6 +288,16 @@ export default {

接下来，将分块传输到 LLM 以提取知识图谱和思维导图的节点和关系。

注意您需要指定的条目类型。

`, + tag: `

使用“标签”作为分块方法的知识库应该被其他知识库使用，以将标签添加到其块中，对这些块的查询也将带有标签。

+

使用“标签”作为分块方法的知识库不应该参与 RAG 过程。

+

此知识库中的块是标签的示例，它们演示了整个标签集以及块和标签之间的相关性。

+ +

此块方法支持EXCEL和CSV/TXT文件格式。

+

如果文件为Excel格式，则它应该包含两列无标题：一列用于内容，另一列用于标签，内容列位于标签列之前。可以接受多个工作表，只要列结构正确即可。

+

如果文件为 CSV/TXT 格式，则必须使用 UTF-8 编码并以 TAB 作为分隔符来分隔内容和标签。

+

在标签列中，标签之间使用英文 逗号。

+不符合上述规则的文本行将被忽略，并且每对文本将被视为一个不同的块。 +`, useRaptor: '使用召回增强RAPTOR策略', useRaptorTip: '请参考 https://huggingface.co/papers/2401.18059', prompt: '提示词', @@ -311,9 +321,11 @@ export default { pageRank: '页面排名', pageRankTip: `这用于提高相关性得分。所有检索到的块的相关性得分将加上此数字。 当您想首先搜索给定的知识库时，请设置比其他知识库更高的 pagerank 得分。`, - tag: '标签', + tagName: '标签', frequency: '频次', searchTags: '搜索标签', + tagCloud: '云', + tagTable: '表', }, chunk: { chunk: '解析块', diff --git a/web/src/pages/add-knowledge/components/knowledge-setting/tag-tabs.tsx b/web/src/pages/add-knowledge/components/knowledge-setting/tag-tabs.tsx index 689dd40cb..abcd3f673 100644 --- a/web/src/pages/add-knowledge/components/knowledge-setting/tag-tabs.tsx +++ b/web/src/pages/add-knowledge/components/knowledge-setting/tag-tabs.tsx @@ -1,20 +1,40 @@ -import { Tabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; +import { Segmented } from 'antd'; +import { SegmentedLabeledOption } from 'antd/es/segmented'; +import { upperFirst } from 'lodash'; +import { useState } from 'react'; +import { useTranslation } from 'react-i18next'; import { TagTable } from './tag-table'; import { TagWordCloud } from './tag-word-cloud'; +enum TagType { + Cloud = 'cloud', + Table = 'table', +} + +const TagContentMap = { + [TagType.Cloud]: , + [TagType.Table]: , +}; + export function TagTabs() { + const [value, setValue] = useState(TagType.Cloud); + const { t } = useTranslation(); + + const options: SegmentedLabeledOption[] = [TagType.Cloud, TagType.Table].map( + (x) => ({ + label: t(`knowledgeConfiguration.tag${upperFirst(x)}`), + value: x, + }), + ); + return ( - - - Word cloud - Table - - - - - - - - +
+ setValue(val as TagType)} + /> + {TagContentMap[value]} +
); } diff --git a/web/src/pages/add-knowledge/components/knowledge-setting/utils.ts b/web/src/pages/add-knowledge/components/knowledge-setting/utils.ts index ceb9cc97e..4c5666467 100644 --- a/web/src/pages/add-knowledge/components/knowledge-setting/utils.ts +++ b/web/src/pages/add-knowledge/components/knowledge-setting/utils.ts @@ -16,4 +16,5 @@ export const ImageMap = { table: getImageName('table', 2), one: getImageName('one', 2), knowledge_graph: getImageName('knowledge-graph', 2), + tag: getImageName('tag', 2), }; diff --git a/web/src/pages/flow/form/generate-form/dynamic-parameters.tsx b/web/src/pages/flow/form/generate-form/dynamic-parameters.tsx index 5ab8e6308..463437da3 100644 --- a/web/src/pages/flow/form/generate-form/dynamic-parameters.tsx +++ b/web/src/pages/flow/form/generate-form/dynamic-parameters.tsx @@ -1,9 +1,10 @@ import { EditableCell, EditableRow } from '@/components/editable-cell'; import { useTranslate } from '@/hooks/common-hooks'; +import { RAGFlowNodeType } from '@/interfaces/database/flow'; import { DeleteOutlined } from '@ant-design/icons'; import { Button, Flex, Select, Table, TableProps } from 'antd'; import { useBuildComponentIdSelectOptions } from '../../hooks/use-get-begin-query'; -import { IGenerateParameter, RAGFlowNodeType } from '../../interface'; +import { IGenerateParameter } from '../../interface'; import { useHandleOperateParameters } from './hooks'; import styles from './index.less'; @@ -46,7 +47,7 @@ const DynamicParameters = ({ node }: IProps) => { }), }, { - title: t('componentId'), + title: t('value'), dataIndex: 'component_id', key: 'component_id', align: 'center',