@tiger16601/n8n-nodes-fastgpt 1.1.4

package/dist/nodes/FastGPT/DatasetDescription.js

@@ -0,0 +1,732 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.datasetFields = exports.datasetOperations = void 0;
+const GenericFunctions_1 = require("./GenericFunctions");
+exports.datasetOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: {
+            show: {
+                resource: ['dataset'],
+            },
+        },
+        options: [
+            {
+                name: '创建一个空的集合',
+                value: '创建一个空的集合',
+                action: '创建一个空的集合',
+                description: '创建一个空的集合, 可以用于存储数据',
+                routing: {
+                    request: {
+                        method: 'POST',
+                        url: '/core/dataset/collection/create',
+                    },
+                    output: { postReceive: [GenericFunctions_1.sendErrorPostReceive] },
+                },
+            },
+            {
+                name: '创建一个纯文本集合',
+                value: '创建一个纯文本集合',
+                action: '创建一个纯文本集合',
+                description: '传入一段文字，创建一个集合，会根据传入的文字进行分割。',
+                routing: {
+                    request: {
+                        method: 'POST',
+                        url: '/core/dataset/collection/create/text',
+                    },
+                    output: { postReceive: [GenericFunctions_1.sendErrorPostReceive] },
+                },
+            },
+            {
+                name: '创建一个链接集合',
+                value: '创建一个链接集合',
+                action: '创建一个链接集合',
+                description: '传入一个网络链接，创建一个集合，会先去对应网页抓取内容，再抓取的文字进行分割。',
+                routing: {
+                    request: {
+                        method: 'POST',
+                        url: '/core/dataset/collection/create/link',
+                    },
+                    output: { postReceive: [GenericFunctions_1.sendErrorPostReceive] },
+                },
+            },
+            {
+                name: '创建一个文件集合',
+                value: '创建一个文件集合',
+                action: '创建一个文件集合',
+                description: '传入一个文件，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。',
+                routing: {
+                    request: {
+                        method: 'POST',
+                        url: '/core/dataset/collection/create/localFile',
+                    },
+                    output: { postReceive: [GenericFunctions_1.sendErrorPostReceive] },
+                },
+            },
+            {
+                name: '获取集合列表',
+                value: '获取集合列表',
+                action: '获取集合列表',
+                description: '获取知识库下的所有集合。',
+                routing: {
+                    request: {
+                        method: 'POST',
+                        // FIX: 更新为V2版本API
+                        url: '/core/dataset/collection/listV2',
+                    },
+                    output: { postReceive: [GenericFunctions_1.sendErrorPostReceive] },
+                },
+            },
+            {
+                name: '获取集合详情',
+                value: '获取集合详情',
+                action: '获取集合详情',
+                description: '获取知识库下指定集合的详情',
+                routing: {
+                    request: {
+                        method: 'GET',
+                        url: '/core/dataset/collection/detail',
+                    },
+                    output: { postReceive: [GenericFunctions_1.sendErrorPostReceive] },
+                },
+            },
+            {
+                name: '删除一个集合',
+                value: '删除一个集合',
+                action: '删除一个集合',
+                description: '删除知识库下指定ID的集合',
+                routing: {
+                    request: {
+                        method: 'DELETE',
+                        url: '/core/dataset/collection/delete',
+                    },
+                    output: { postReceive: [GenericFunctions_1.sendErrorPostReceive] },
+                },
+            },
+            {
+                name: '更新集合信息',
+                value: '更新集合信息',
+                action: '更新集合信息',
+                description: '通过集合ID或外部文件ID修改集合的名称、标签、父级目录等信息',
+                routing: {
+                    request: {
+                        method: 'POST',
+                        url: '/core/dataset/collection/update',
+                    },
+                    output: { postReceive: [GenericFunctions_1.sendErrorPostReceive] },
+                },
+            },
+        ],
+        default: '创建一个纯文本集合',
+    },
+];
+const completeOperations = [
+    {
+        displayName: '父级目录ID',
+        description: '在FastGPT中打开文件夹，复制浏览器上的ID',
+        name: 'datasetParentId',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: [
+                    '创建一个空的集合',
+                    '创建一个纯文本集合',
+                    '创建一个链接集合',
+                    '创建一个文件集合',
+                    '获取集合列表',
+                    '获取集合详情',
+                    '删除一个集合',
+                ],
+                resource: ['dataset'],
+            },
+        },
+        // FIX: 将父级目录ID发送到请求体中的parentId字段，修复创建集合时parentId缺失的问题
+        routing: {
+            send: {
+                type: 'body',
+                property: 'parentId',
+            },
+        },
+    },
+    {
+        displayName: '选择知识库',
+        name: 'datasetKnowledgeId',
+        type: 'options',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: [
+                    '创建一个空的集合',
+                    '创建一个纯文本集合',
+                    '创建一个链接集合',
+                    '创建一个文件集合',
+                    '获取集合列表',
+                    '获取集合详情',
+                    '删除一个集合',
+                ],
+                resource: ['dataset'],
+            },
+        },
+        typeOptions: {
+            loadOptions: {
+                routing: {
+                    request: {
+                        method: 'POST',
+                        url: '/core/dataset/list',
+                        body: {
+                            parentId: '={{$parameter["datasetParentId"]}}',
+                        },
+                    },
+                    output: {
+                        postReceive: [
+                            {
+                                type: 'rootProperty',
+                                properties: {
+                                    property: 'data',
+                                },
+                            },
+                            {
+                                type: 'filter',
+                                properties: {
+                                    pass: "={{ $responseItem.type === 'dataset' }}",
+                                },
+                            },
+                            {
+                                type: 'setKeyValue',
+                                properties: {
+                                    name: '={{$responseItem.name}}',
+                                    value: '={{$responseItem._id}}',
+                                },
+                            },
+                            {
+                                type: 'sort',
+                                properties: {
+                                    key: 'name',
+                                },
+                            },
+                        ],
+                    },
+                },
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'datasetId',
+            },
+        },
+    },
+    {
+        displayName: '集合ID',
+        description: '要查询详情的集合ID',
+        name: 'id',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['获取集合详情'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'query',
+                property: 'id',
+            },
+        },
+    },
+    {
+        displayName: '集合ID列表',
+        description: '输入要删除的集合ID，多个用逗号分隔，如：id1,id2',
+        name: 'datasetCollectionIds',
+        type: 'string',
+        default: '',
+        required: true,
+        displayOptions: {
+            show: {
+                operation: ['删除一个集合'],
+                resource: ['dataset'],
+            },
+        },
+        // FIX: API要求collectionIds为数组格式，使用preSend将逗号分隔的字符串转为数组
+        routing: {
+            send: {
+                type: 'body',
+                property: 'collectionIds',
+                preSend: [
+                    async function (requestOptions) {
+                        const idsStr = String(this.getNodeParameter('datasetCollectionIds'));
+                        const ids = idsStr.split(',').map(id => id.trim()).filter(id => id);
+                        requestOptions.body.collectionIds = ids;
+                        return requestOptions;
+                    },
+                ],
+            },
+        },
+    },
+    {
+        displayName: '名称',
+        name: 'datasetName',
+        type: 'string',
+        default: '',
+        required: true,
+        displayOptions: {
+            show: {
+                operation: ['创建一个空的集合', '创建一个纯文本集合'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'name',
+            },
+        },
+    },
+    {
+        displayName: '类型',
+        name: 'datasetType',
+        type: 'options',
+        default: 'folder',
+        required: true,
+        displayOptions: {
+            show: {
+                operation: ['创建一个空的集合'],
+                resource: ['dataset'],
+            },
+        },
+        options: [
+            {
+                name: '文件夹',
+                value: 'folder',
+            },
+            {
+                name: '虚拟集合(手动集合)',
+                value: 'virtual',
+            },
+        ],
+        routing: {
+            send: {
+                type: 'body',
+                property: 'type',
+            },
+        },
+    },
+    {
+        displayName: '网页链接',
+        name: 'datasetLink',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['创建一个链接集合'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'link',
+            },
+        },
+    },
+    {
+        displayName: '文件字段名',
+        name: 'datasetFileField',
+        type: 'string',
+        default: '',
+        description: '目前支持：pdf, docx, md, txt, html, csv',
+        required: true,
+        displayOptions: {
+            show: {
+                operation: ['创建一个文件集合'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                preSend: [
+                    // FIX: 修复items数组被当作单对象使用的bug，正确获取当前item的binary数据
+                    async function (requestOptions) {
+                        const items = this.getInputData();
+                        const itemIndex = this.getItemIndex();
+                        const binaryDataName = String(this.getNodeParameter('datasetFileField'));
+                        if (!items || !items[itemIndex] || !items[itemIndex].binary) {
+                            throw Error('文件不能为空');
+                        }
+                        const binaryDataValue = items[itemIndex].binary[binaryDataName];
+                        const binaryData = await this.helpers.getBinaryDataBuffer(binaryDataName, itemIndex);
+                        const FormData = require('form-data');
+                        const form = new FormData();
+                        const filename = binaryDataValue.fileName || `${binaryDataName}.${binaryDataValue.fileExtension}`;
+                        form.append('file', binaryData, {
+                            filename: encodeURI(filename),
+                            contentType: binaryDataValue.mimeType,
+                        });
+                        form.append('data', JSON.stringify(requestOptions.body));
+                        requestOptions.body = form;
+                        requestOptions.headers = form.getHeaders();
+                        return requestOptions;
+                    },
+                ],
+            },
+        },
+    },
+    {
+        displayName: '网页选择器',
+        name: 'datasetWebPageSelector',
+        type: 'string',
+        default: '',
+        description: '指定网页中的CSS选择器，用于提取指定元素的文本内容，如：.docs-content',
+        displayOptions: {
+            show: {
+                operation: ['创建一个链接集合'],
+                resource: ['dataset'],
+            },
+        },
+        // FIX: 新增metadata.webPageSelector字段，用于指定网页抓取的CSS选择器
+        routing: {
+            send: {
+                type: 'body',
+                property: 'metadata.webPageSelector',
+            },
+        },
+    },
+    {
+        displayName: '训练类型',
+        name: 'datasetTrainingType',
+        type: 'options',
+        default: 'chunk',
+        required: true,
+        displayOptions: {
+            show: {
+                operation: ['创建一个纯文本集合', '创建一个链接集合', '创建一个文件集合'],
+                resource: ['dataset'],
+            },
+        },
+        options: [
+            {
+                name: '按文本长度进行分割',
+                value: 'chunk',
+            },
+            {
+                name: 'QA拆分',
+                value: 'qa',
+            },
+        ],
+        // FIX: 将训练类型从'type'改为'trainingType'，匹配API实际参数名
+        routing: {
+            send: {
+                type: 'body',
+                property: 'trainingType',
+            },
+        },
+    },
+    {
+        displayName: 'Chunk长度',
+        name: 'datasetChunkSize',
+        type: 'number',
+        default: 3000,
+        displayOptions: {
+            show: {
+                operation: ['创建一个纯文本集合', '创建一个链接集合', '创建一个文件集合'],
+                resource: ['dataset'],
+                datasetTrainingType: ['chunk'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'chunkSize',
+            },
+        },
+    },
+    {
+        displayName: '自定义最高优先分割符号',
+        name: 'datasetChunkSplitter',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['创建一个纯文本集合', '创建一个链接集合', '创建一个文件集合'],
+                resource: ['dataset'],
+                datasetTrainingType: ['chunk'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'chunkSplitter',
+            },
+        },
+    },
+    {
+        displayName: 'QA拆分自定义提示词',
+        name: 'datasetQAPrompt',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['创建一个纯文本集合', '创建一个链接集合', '创建一个文件集合'],
+                resource: ['dataset'],
+                datasetTrainingType: ['qa'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'qaPrompt',
+            },
+        },
+    },
+    {
+        displayName: '原文本',
+        name: 'datasetText',
+        type: 'string',
+        default: '',
+        typeOptions: {
+            rows: 10,
+        },
+        displayOptions: {
+            show: {
+                operation: ['创建一个纯文本集合'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'text',
+            },
+        },
+    },
+    {
+        displayName: '偏移量',
+        description: '分页偏移量，从0开始',
+        name: 'datasetPageNum',
+        type: 'number',
+        default: 0,
+        displayOptions: {
+            show: {
+                operation: ['获取集合列表'],
+                resource: ['dataset'],
+            },
+        },
+        // FIX: API listV2使用offset而非pageNum
+        routing: {
+            send: {
+                type: 'body',
+                property: 'offset',
+            },
+        },
+    },
+    {
+        displayName: '每页数量',
+        name: 'datasetPageSize',
+        type: 'number',
+        default: 30,
+        displayOptions: {
+            show: {
+                operation: ['获取集合列表'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'pageSize',
+            },
+        },
+    },
+    {
+        displayName: '模糊搜索文本',
+        name: 'datasetSearchText',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['获取集合列表'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'searchText',
+            },
+        },
+    },
+    // FIX: 新增"更新集合信息"操作相关字段
+    {
+        displayName: '集合ID',
+        description: '要更新的集合ID，与知识库ID+外部文件ID二选一',
+        name: 'updateCollectionId',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['更新集合信息'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'id',
+            },
+        },
+    },
+    {
+        displayName: '知识库ID',
+        description: '通过外部文件ID更新时使用，与集合ID二选一',
+        name: 'updateDatasetId',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['更新集合信息'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'datasetId',
+            },
+        },
+    },
+    {
+        displayName: '外部文件ID',
+        description: '通过外部文件ID更新时使用，需配合知识库ID',
+        name: 'updateExternalFileId',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['更新集合信息'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'externalFileId',
+            },
+        },
+    },
+    {
+        displayName: '父级ID',
+        description: '修改父级目录，不填则不修改',
+        name: 'updateParentId',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['更新集合信息'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'parentId',
+            },
+        },
+    },
+    {
+        displayName: '名称',
+        description: '修改集合名称，不填则不修改',
+        name: 'updateName',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['更新集合信息'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'name',
+            },
+        },
+    },
+    {
+        displayName: '标签',
+        description: '修改集合标签，多个用逗号分隔，如：tag1,tag2。不填则不修改',
+        name: 'updateTags',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['更新集合信息'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'tags',
+                preSend: [
+                    async function (requestOptions) {
+                        const tagsStr = String(this.getNodeParameter('updateTags'));
+                        if (tagsStr) {
+                            const tags = tagsStr.split(',').map(t => t.trim()).filter(t => t);
+                            requestOptions.body.tags = tags;
+                        }
+                        return requestOptions;
+                    },
+                ],
+            },
+        },
+    },
+    {
+        displayName: '禁用状态',
+        description: '是否禁用该集合',
+        name: 'updateForbid',
+        type: 'boolean',
+        default: false,
+        displayOptions: {
+            show: {
+                operation: ['更新集合信息'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'forbid',
+            },
+        },
+    },
+    {
+        displayName: '创建时间',
+        description: '修改集合创建时间，格式如：2024-01-01T00:00:00.000Z。不填则不修改',
+        name: 'updateCreateTime',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                operation: ['更新集合信息'],
+                resource: ['dataset'],
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'createTime',
+            },
+        },
+    },
+];
+const sharedOperations = [];
+exports.datasetFields = [
+    ...completeOperations,
+    ...sharedOperations,
+];
+//# sourceMappingURL=DatasetDescription.js.map