fix: package plus request (#4492)

* fix plus request (#4476)

* perf: package plus request

* perf: plus request fix

* fix: doc

---------

Co-authored-by: heheer <[email protected]>

Author: c121914yu

docSite/content/zh-cn/docs/development/openapi/chat.md

@@ -34,17 +34,13 @@ weight: 852
 
 ### 请求
 
-<!-- #### v2
-
-v1,v2 接口请求参数一致，仅请求地址不一样。
-
 {{< tabs tabTotal="3" >}}
 {{< tab tabName="基础请求示例" >}}
 {{< markdownify >}}
 
 ```bash
-curl --location --request POST 'http://localhost:3000/api/v2/chat/completions' \
---header 'Authorization: fastgpt-xxxxxx' \
+curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
+--header 'Authorization: Bearer fastgpt-xxxxxx' \
 --header 'Content-Type: application/json' \
 --data-raw '{
     "chatId": "my_chatId",
@@ -58,7 +54,7 @@ curl --location --request POST 'http://localhost:3000/api/v2/chat/completions' \
     "messages": [
         {
             "role": "user",
-            "content": "你是谁"
+            "content": "导演是谁"
         }
     ]
 }'
@@ -74,7 +70,7 @@ curl --location --request POST 'http://localhost:3000/api/v2/chat/completions' \
 * 目前不支持上传文件，需上传到自己的对象存储中，获取对应的文件链接。
 
 ```bash
-curl --location --request POST 'http://localhost:3000/api/v2/chat/completions' \
+curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxxxxx' \
 --header 'Content-Type: application/json' \
 --data-raw '{
@@ -126,15 +122,17 @@ curl --location --request POST 'http://localhost:3000/api/v2/chat/completions' \
 {{< /tab >}}
 {{< /tabs >}}
 
-#### v1
+<!-- #### v2
+
+v1,v2 接口请求参数一致，仅请求地址不一样。
 
 {{< tabs tabTotal="3" >}}
 {{< tab tabName="基础请求示例" >}}
 {{< markdownify >}}
 
 ```bash
-curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
---header 'Authorization: Bearer fastgpt-xxxxxx' \
+curl --location --request POST 'http://localhost:3000/api/v2/chat/completions' \
+--header 'Authorization: fastgpt-xxxxxx' \
 --header 'Content-Type: application/json' \
 --data-raw '{
     "chatId": "my_chatId",
@@ -148,7 +146,7 @@ curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
     "messages": [
         {
             "role": "user",
-            "content": "导演是谁"
+            "content": "你是谁"
         }
     ]
 }'
@@ -164,7 +162,7 @@ curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 * 目前不支持上传文件，需上传到自己的对象存储中，获取对应的文件链接。
 
 ```bash
-curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
+curl --location --request POST 'http://localhost:3000/api/v2/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxxxxx' \
 --header 'Content-Type: application/json' \
 --data-raw '{
@@ -216,6 +214,10 @@ curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 {{< /tab >}}
 {{< /tabs >}}
 
+#### v1
+
+
+
 ### 响应
 
 #### v2
@@ -745,8 +747,6 @@ curl --location --request POST 'https://api.fastgpt.in/api/v1/chat/completions'
 
 ### 请求示例
 
-#### v1
-
 ```bash
 curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 --header 'Authorization: Bearer test-xxxxx' \
@@ -760,25 +760,8 @@ curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 }'
 ```
 
-#### v2
-
-```bash
-curl --location --request POST 'http://localhost:3000/api/v2/chat/completions' \
---header 'Authorization: Bearer test-xxxxx' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "stream": false,
-    "chatId": "test",
-    "variables": {
-        "query":"你好"
-    }
-}'
-```
-
 ### 响应示例
 
-#### v1
-
 {{< tabs tabTotal="3" >}}
 
 {{< tab tabName="detail=true,stream=false 响应" >}}
@@ -937,151 +920,6 @@ event取值：
 {{< /tab >}}
 {{< /tabs >}}
 
-
-#### v2
-
-{{< tabs tabTotal="3" >}}
-
-{{< tab tabName="detail=true,stream=false 响应" >}}
-{{< markdownify >}}
-
-* 插件的输出可以通过查找`responseData`中, `moduleType=pluginOutput`的元素，其`pluginOutput`是插件的输出。
-* 流输出，仍可以通过`choices`进行获取。
-
-```json
-{
-    "responseData": [
-        {
-            "id": "bsH1ZdbYkz9iJwYa",
-            "nodeId": "pluginInput",
-            "moduleName": "workflow:template.plugin_start",
-            "moduleType": "pluginInput",
-            "runningTime": 0
-        },
-        {
-            "id": "zDgfqSPhbYZFHVIn",
-            "nodeId": "h4Gr4lJtFVQ6qI4c",
-            "moduleName": "AI 对话",
-            "moduleType": "chatNode",
-            "runningTime": 1.44,
-            "totalPoints": 0,
-            "model": "GPT-4o-mini",
-            "tokens": 34,
-            "inputTokens": 8,
-            "outputTokens": 26,
-            "query": "你好",
-            "reasoningText": "",
-            "historyPreview": [
-                {
-                    "obj": "Human",
-                    "value": "你好"
-                },
-                {
-                    "obj": "AI",
-                    "value": "你好！有什么我可以帮助你的吗？"
-                }
-            ],
-            "contextTotalLen": 2
-        },
-        {
-            "id": "uLLwKKRZvufXzgF4",
-            "nodeId": "pluginOutput",
-            "moduleName": "common:core.module.template.self_output",
-            "moduleType": "pluginOutput",
-            "runningTime": 0,
-            "totalPoints": 0,
-            "pluginOutput": {
-                "result": "你好！有什么我可以帮助你的吗？"
-            }
-        }
-    ],
-    "newVariables": {
-
-    },
-    "id": "test",
-    "model": "",
-    "usage": {
-        "prompt_tokens": 1,
-        "completion_tokens": 1,
-        "total_tokens": 1
-    },
-    "choices": [
-        {
-            "message": {
-                "role": "assistant",
-                "content": "你好！有什么我可以帮助你的吗？"
-            },
-            "finish_reason": "stop",
-            "index": 0
-        }
-    ]
-}
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-
-{{< tab tabName="detail=true,stream=true 响应" >}}
-{{< markdownify >}}
-
-* 插件的输出可以通过获取`event=flowResponses`中的字符串，并将其反序列化后得到一个数组。同样的，查找 `moduleType=pluginOutput`的元素，其`pluginOutput`是插件的输出。
-* 流输出，仍和对话接口一样获取。
-
-```bash
-data: {"event":"flowNodeResponse","data":"{\"id\":\"q8ablUOqHGgqLIRM\",\"nodeId\":\"pluginInput\",\"moduleName\":\"workflow:template.plugin_start\",\"moduleType\":\"pluginInput\",\"runningTime\":0}"}
-
-data: {"event":"flowNodeStatus","data":"{\"status\":\"running\",\"name\":\"AI 对话\"}"}
-
-data: {"event":"answer","data":"{\"id\":\"\",\"object\":\"\",\"created\":0,\"model\":\"\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"你好\"},\"index\":0,\"finish_reason\":null}]}"}
-
-data: {"event":"answer","data":"{\"id\":\"\",\"object\":\"\",\"created\":0,\"model\":\"\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"！\"},\"index\":0,\"finish_reason\":null}]}"}
-
-data: {"event":"answer","data":"{\"id\":\"\",\"object\":\"\",\"created\":0,\"model\":\"\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"有什么\"},\"index\":0,\"finish_reason\":null}]}"}
-
-data: {"event":"answer","data":"{\"id\":\"\",\"object\":\"\",\"created\":0,\"model\":\"\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"我\"},\"index\":0,\"finish_reason\":null}]}"}
-
-data: {"event":"answer","data":"{\"id\":\"\",\"object\":\"\",\"created\":0,\"model\":\"\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"可以\"},\"index\":0,\"finish_reason\":null}]}"}
-
-data: {"event":"answer","data":"{\"id\":\"\",\"object\":\"\",\"created\":0,\"model\":\"\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"帮助\"},\"index\":0,\"finish_reason\":null}]}"}
-
-data: {"event":"answer","data":"{\"id\":\"\",\"object\":\"\",\"created\":0,\"model\":\"\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"你\"},\"index\":0,\"finish_reason\":null}]}"}
-
-data: {"event":"answer","data":"{\"id\":\"\",\"object\":\"\",\"created\":0,\"model\":\"\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"的吗\"},\"index\":0,\"finish_reason\":null}]}"}
-
-data: {"event":"answer","data":"{\"id\":\"\",\"object\":\"\",\"created\":0,\"model\":\"\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"？\"},\"index\":0,\"finish_reason\":null}]}"}
-
-data: {"event":"flowNodeResponse","data":"{\"id\":\"rqlXLUap8QeiN7Kf\",\"nodeId\":\"h4Gr4lJtFVQ6qI4c\",\"moduleName\":\"AI 对话\",\"moduleType\":\"chatNode\",\"runningTime\":1.79,\"totalPoints\":0,\"model\":\"GPT-4o-mini\",\"tokens\":137,\"inputTokens\":111,\"outputTokens\":26,\"query\":\"你好\",\"reasoningText\":\"\",\"historyPreview\":[{\"obj\":\"Human\",\"value\":\"[{\\\"renderTypeList\\\":[\\\"reference\\\"],\\\"selectedTypeInde\\n\\n...[hide 174 chars]...\\n\\ncanSelectImg\\\":true,\\\"required\\\":false,\\\"value\\\":\\\"你好\\\"}]\"},{\"obj\":\"AI\",\"value\":\"你好！有什么我可以帮助你的吗？\"},{\"obj\":\"Human\",\"value\":\"你好\"},{\"obj\":\"AI\",\"value\":\"你好！有什么我可以帮助你的吗？\"}],\"contextTotalLen\":4}"}
-
-data: {"event":"flowNodeResponse","data":"{\"id\":\"lHCpHI0MrM00HQlX\",\"nodeId\":\"pluginOutput\",\"moduleName\":\"common:core.module.template.self_output\",\"moduleType\":\"pluginOutput\",\"runningTime\":0,\"totalPoints\":0,\"pluginOutput\":{\"result\":\"你好！有什么我可以帮助你的吗？\"}}"}
-
-data: {"event":"answer","data":"{\"id\":\"\",\"object\":\"\",\"created\":0,\"model\":\"\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":null},\"index\":0,\"finish_reason\":\"stop\"}]}"}
-
-data: {"event":"answer","data":"[DONE]"}
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< tab tabName="输出获取" >}}
-{{< markdownify >}}
-
-event取值：
-
-- answer: 返回给客户端的文本（最终会算作回答）
-- fastAnswer: 指定回复返回给客户端的文本（最终会算作回答）
-- toolCall: 执行工具
-- toolParams: 工具参数
-- toolResponse: 工具返回
-- flowNodeStatus: 运行到的节点状态
-- flowNodeResponse: 单个节点详细响应
-- updateVariables: 更新变量
-- error: 报错
-
-{{< /markdownify >}}
-{{< /tab >}}
-{{< /tabs >}}
-
 # 对话 CRUD
 
 {{% alert icon="🤖 " context="success" %}}

docSite/content/zh-cn/docs/development/upgrading/494.md

@@ -62,4 +62,5 @@ curl --location --request POST 'https://{{host}}/api/admin/initv494' \
 ## 🐛 修复
 
 1. 搜索应用/知识库时，无法点击目录进入下一层。
-2. 重新训练时，参数未成功初始化。
+2. 重新训练时，参数未成功初始化。
+3. package/service 部分请求在多 app 中不一致。

packages/service/common/api/type.d.ts

@@ -0,0 +1,29 @@
+import { FeishuServer, YuqueServer } from '@fastgpt/global/core/dataset/apiDataset';
+import {
+  DeepRagSearchProps,
+  SearchDatasetDataResponse
+} from '../../core/dataset/search/controller';
+import { AuthOpenApiLimitProps } from '../../support/openapi/auth';
+import { CreateUsageProps, ConcatUsageProps } from '@fastgpt/global/support/wallet/usage/api';
+import {
+  GetProApiDatasetFileContentParams,
+  GetProApiDatasetFileListParams,
+  GetProApiDatasetFilePreviewUrlParams
+} from '../../core/dataset/apiDataset/proApi';
+
+declare global {
+  var textCensorHandler: (params: { text: string }) => Promise<{ code: number; message?: string }>;
+  var deepRagHandler: (data: DeepRagSearchProps) => Promise<SearchDatasetDataResponse>;
+  var authOpenApiHandler: (data: AuthOpenApiLimitProps) => Promise<any>;
+  var createUsageHandler: (data: CreateUsageProps) => Promise<void>;
+  var concatUsageHandler: (data: ConcatUsageProps) => Promise<void>;
+
+  // API dataset
+  var getProApiDatasetFileList: (data: GetProApiDatasetFileListParams) => Promise<APIFileItem[]>;
+  var getProApiDatasetFileContent: (
+    data: GetProApiDatasetFileContentParams
+  ) => Promise<ApiFileReadContentResponse>;
+  var getProApiDatasetFilePreviewUrl: (
+    data: GetProApiDatasetFilePreviewUrlParams
+  ) => Promise<string>;
+}

packages/service/common/system/constants.ts

@@ -1,4 +1,3 @@
 export const FastGPTProUrl = process.env.PRO_URL ? `${process.env.PRO_URL}/api` : '';
-export const isFastGPTMainService = !!process.env.PRO_URL;
 // @ts-ignore
 export const isFastGPTProService = () => !!global.systemConfig;

packages/service/common/api/requestPlusApi.ts renamed to packages/service/core/chat/postTextCensor.ts

@@ -1,7 +1,6 @@
-import { POST } from './plusRequest';
-
 export const postTextCensor = (data: { text: string }) =>
-  POST<{ code?: number; message: string }>('/common/censor/check', data)
+  global
+    .textCensorHandler(data)
     .then((res) => {
       if (res?.code === 5000) {
         return Promise.reject(res);

packages/service/core/dataset/apiDataset/proApi.ts

@@ -0,0 +1,25 @@
+import { ParentIdType } from '@fastgpt/global/common/parentFolder/type';
+import { FeishuServer, YuqueServer } from '@fastgpt/global/core/dataset/apiDataset';
+
+export enum ProApiDatasetOperationTypeEnum {
+  LIST = 'list',
+  READ = 'read',
+  CONTENT = 'content'
+}
+
+export type ProApiDatasetCommonParams = {
+  feishuServer?: FeishuServer;
+  yuqueServer?: YuqueServer;
+};
+
+export type GetProApiDatasetFileListParams = ProApiDatasetCommonParams & {
+  parentId?: ParentIdType;
+};
+
+export type GetProApiDatasetFileContentParams = ProApiDatasetCommonParams & {
+  apiFileId: string;
+};
+
+export type GetProApiDatasetFilePreviewUrlParams = ProApiDatasetCommonParams & {
+  apiFileId: string;
+};

packages/service/core/dataset/read.ts

@@ -9,7 +9,6 @@ import { readRawContentByFileBuffer } from '../../common/file/read/utils';
 import { parseFileExtensionFromUrl } from '@fastgpt/global/common/string/tools';
 import { APIFileServer, FeishuServer, YuqueServer } from '@fastgpt/global/core/dataset/apiDataset';
 import { useApiDatasetRequest } from './apiDataset/api';
-import { POST } from '../../common/api/plusRequest';
 
 export const readFileRawTextByUrl = async ({
   teamId,
@@ -168,11 +167,7 @@ export const readApiServerFileContent = async ({
   }
 
   if (feishuServer || yuqueServer) {
-    return POST<{
-      title?: string;
-      rawText: string;
-    }>(`/core/dataset/systemApiDataset`, {
-      type: 'content',
+    return global.getProApiDatasetFileContent({
       feishuServer,
       yuqueServer,
       apiFileId

packages/service/core/dataset/search/controller.ts

@@ -24,7 +24,6 @@ import { MongoDatasetCollectionTags } from '../tag/schema';
 import { readFromSecondary } from '../../../common/mongo/utils';
 import { MongoDatasetDataText } from '../data/dataTextSchema';
 import { ChatItemType } from '@fastgpt/global/core/chat/type';
-import { POST } from '../../../common/api/plusRequest';
 import { NodeInputKeyEnum } from '@fastgpt/global/core/workflow/constants';
 import { datasetSearchQueryExtension } from './utils';
 import type { RerankModelItemType } from '@fastgpt/global/core/ai/model.d';
@@ -850,5 +849,4 @@ export type DeepRagSearchProps = SearchDatasetDataProps & {
   [NodeInputKeyEnum.datasetDeepSearchMaxTimes]?: number;
   [NodeInputKeyEnum.datasetDeepSearchBg]?: string;
 };
-export const deepRagSearch = (data: DeepRagSearchProps) =>
-  POST<SearchDatasetDataResponse>('/core/dataset/deepRag', data);
+export const deepRagSearch = (data: DeepRagSearchProps) => global.deepRagHandler(data);