Doc (#2910)

* feat: add app chat openapi (#2908) * add chat openapi * create question guide openapi * change auth method * add chat openapi doc * delete unused code * feat: chat openapi doc * rerank doc * add chat detail openapi & doc * update chat openapi doc --------- Co-authored-by: heheer <heheer@sealos.io> Co-authored-by: heheer <1239331448@qq.com>
2025-07-29 09:44:47 +00:00 · 2024-10-14 10:26:57 +08:00
parent 9b6fe3a465
commit 9a621583c4
28 changed files with 897 additions and 83 deletions
--- a/projects/app/src/pages/api/core/ai/agent/createQuestionGuide.ts
+++ b/projects/app/src/pages/api/core/ai/agent/createQuestionGuide.ts
@@ -13,7 +13,8 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse<

    const { tmbId, teamId } = await authChatCert({
      req,
-      authToken: true
+      authToken: true,
+      authApiKey: true
    });

    const qgModel = global.llmModels[0];
--- a/projects/app/src/pages/api/core/chat/clearHistories.ts
+++ b/projects/app/src/pages/api/core/chat/clearHistories.ts
@@ -36,7 +36,7 @@ async function handler(req: NextApiRequest, res: NextApiResponse) {
      };
    }
    if (appId) {
-      const { tmbId } = await authCert({ req, authToken: true });
+      const { tmbId } = await authCert({ req, authToken: true, authApiKey: true });

      return {
        tmbId,
--- a/projects/app/src/pages/api/core/chat/delHistory.ts
+++ b/projects/app/src/pages/api/core/chat/delHistory.ts
@@ -17,6 +17,7 @@ async function handler(req: ApiRequestProps<{}, DelHistoryProps>, res: NextApiRe
  await authChatCrud({
    req,
    authToken: true,
+    authApiKey: true,
    ...req.query,
    per: WritePermissionVal
  });
--- a/projects/app/src/pages/api/core/chat/feedback/adminUpdate.ts
+++ b/projects/app/src/pages/api/core/chat/feedback/adminUpdate.ts
@@ -10,10 +10,10 @@ import { ReadPermissionVal } from '@fastgpt/global/support/permission/constant';
 export default async function handler(req: NextApiRequest, res: NextApiResponse) {
  try {
    await connectToDatabase();
-    const { appId, chatId, chatItemId, datasetId, dataId, q, a } =
+    const { appId, chatId, dataId, datasetId, feedbackDataId, q, a } =
      req.body as AdminUpdateFeedbackParams;

-    if (!chatItemId || !datasetId || !dataId || !q) {
+    if (!dataId || !datasetId || !feedbackDataId || !q) {
      throw new Error('missing parameter');
    }

@@ -29,12 +29,12 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
      {
        appId,
        chatId,
-        dataId: chatItemId
+        dataId
      },
      {
        adminFeedback: {
          datasetId,
-          dataId,
+          dataId: feedbackDataId,
          q,
          a
        }
--- a/projects/app/src/pages/api/core/chat/feedback/closeCustom.ts
+++ b/projects/app/src/pages/api/core/chat/feedback/closeCustom.ts
@@ -6,14 +6,15 @@ import type { CloseCustomFeedbackParams } from '@/global/core/chat/api.d';
 import { MongoChatItem } from '@fastgpt/service/core/chat/chatItemSchema';
 import { authChatCrud } from '@/service/support/permission/auth/chat';
 import { ReadPermissionVal } from '@fastgpt/global/support/permission/constant';
+import { mongoSessionRun } from '@fastgpt/service/common/mongo/sessionRun';

 /* remove custom feedback */
 export default async function handler(req: NextApiRequest, res: NextApiResponse) {
  try {
    await connectToDatabase();
-    const { appId, chatId, chatItemId, index } = req.body as CloseCustomFeedbackParams;
+    const { appId, chatId, dataId, index } = req.body as CloseCustomFeedbackParams;

-    if (!chatItemId || !appId || !chatId || !chatItemId) {
+    if (!dataId || !appId || !chatId) {
      throw new Error('missing parameter');
    }

@@ -26,10 +27,22 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
    });
    await authCert({ req, authToken: true });

-    await MongoChatItem.findOneAndUpdate(
-      { appId, chatId, dataId: chatItemId },
-      { $unset: { [`customFeedbacks.${index}`]: 1 } }
-    );
+    await mongoSessionRun(async (session) => {
+      await MongoChatItem.findOneAndUpdate(
+        { appId, chatId, dataId },
+        { $unset: { [`customFeedbacks.${index}`]: 1 } },
+        {
+          session
+        }
+      );
+      await MongoChatItem.findOneAndUpdate(
+        { appId, chatId, dataId },
+        { $pull: { customFeedbacks: null } },
+        {
+          session
+        }
+      );
+    });

    jsonRes(res);
  } catch (err) {
--- a/projects/app/src/pages/api/core/chat/feedback/updateUserFeedback.ts
+++ b/projects/app/src/pages/api/core/chat/feedback/updateUserFeedback.ts
@@ -11,7 +11,7 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
  const {
    appId,
    chatId,
-    chatItemId,
+    dataId,
    shareId,
    teamId,
    teamToken,
@@ -36,15 +36,15 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
      per: ReadPermissionVal
    });

-    if (!chatItemId) {
-      throw new Error('chatItemId is required');
+    if (!dataId) {
+      throw new Error('dataId is required');
    }

    await MongoChatItem.findOneAndUpdate(
      {
        appId,
        chatId,
-        dataId: chatItemId
+        dataId
      },
      {
        $unset: {
--- a/projects/app/src/pages/api/core/chat/getHistories.ts
+++ b/projects/app/src/pages/api/core/chat/getHistories.ts
@@ -43,7 +43,7 @@ async function handler(
      };
    }
    if (appId) {
-      const { tmbId } = await authCert({ req, authToken: true });
+      const { tmbId } = await authCert({ req, authToken: true, authApiKey: true });
      return {
        tmbId,
        appId,
--- a/projects/app/src/pages/api/core/chat/getPaginationRecords.ts
+++ b/projects/app/src/pages/api/core/chat/getPaginationRecords.ts
@@ -26,7 +26,14 @@ async function handler(
  req: ApiRequestProps<getPaginationRecordsBody, getPaginationRecordsQuery>,
  res: ApiResponseType<any>
 ): Promise<getPaginationRecordsResponse> {
-  const { chatId, appId, offset, pageSize = 10, loadCustomFeedbacks, type } = req.body;
+  const {
+    appId,
+    chatId,
+    offset,
+    pageSize = 10,
+    loadCustomFeedbacks,
+    type = GetChatTypeEnum.normal
+  } = req.body;

  if (!appId || !chatId) {
    return {
@@ -40,6 +47,7 @@ async function handler(
    authChatCrud({
      req,
      authToken: true,
+      authApiKey: true,
      ...req.body,
      per: ReadPermissionVal
    })
--- a/projects/app/src/pages/api/core/chat/getResData.ts
+++ b/projects/app/src/pages/api/core/chat/getResData.ts
@@ -37,6 +37,7 @@ async function handler(
    await authChatCrud({
      req,
      authToken: true,
+      authApiKey: true,
      ...req.query,
      per: ReadPermissionVal
    });
@@ -44,6 +45,7 @@ async function handler(
    await authApp({
      req,
      authToken: true,
+      authApiKey: true,
      appId,
      per: ManagePermissionVal
    });
--- a/projects/app/src/pages/api/core/chat/init.ts
+++ b/projects/app/src/pages/api/core/chat/init.ts
@@ -29,6 +29,7 @@ async function handler(
    authApp({
      req,
      authToken: true,
+      authApiKey: true,
      appId,
      per: ReadPermissionVal
    }),
--- a/projects/app/src/pages/api/core/chat/item/delete.ts
+++ b/projects/app/src/pages/api/core/chat/item/delete.ts
@@ -1,6 +1,5 @@
-import type { NextApiRequest, NextApiResponse } from 'next';
+import type { NextApiResponse } from 'next';
 import { jsonRes } from '@fastgpt/service/common/response';
-import { connectToDatabase } from '@/service/mongo';
 import { MongoChatItem } from '@fastgpt/service/core/chat/chatItemSchema';
 import { authChatCrud } from '@/service/support/permission/auth/chat';
 import type { DeleteChatItemProps } from '@/global/core/chat/api.d';
@@ -9,7 +8,7 @@ import { ApiRequestProps } from '@fastgpt/service/type/next';
 import { WritePermissionVal } from '@fastgpt/global/support/permission/constant';

 async function handler(req: ApiRequestProps<{}, DeleteChatItemProps>, res: NextApiResponse) {
-  const { appId, chatId, contentId, shareId, outLinkUid } = req.query;
+  const { appId, chatId, contentId } = req.query;

  if (!contentId || !chatId) {
    return jsonRes(res);
@@ -18,6 +17,7 @@ async function handler(req: ApiRequestProps<{}, DeleteChatItemProps>, res: NextA
  await authChatCrud({
    req,
    authToken: true,
+    authApiKey: true,
    ...req.query,
    per: WritePermissionVal
  });
--- a/projects/app/src/pages/api/core/chat/item/getSpeech.ts
+++ b/projects/app/src/pages/api/core/chat/item/getSpeech.ts
@@ -24,7 +24,11 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
      throw new Error('model or voice not found');
    }

-    const { teamId, tmbId, authType } = await authChatCert({ req, authToken: true });
+    const { teamId, tmbId, authType } = await authChatCert({
+      req,
+      authToken: true,
+      authApiKey: true
+    });

    const ttsModel = getAudioSpeechModel(ttsConfig.model);
    const voiceData = ttsModel.voices?.find((item) => item.value === ttsConfig.voice);
--- a/projects/app/src/pages/api/core/chat/updateHistory.ts
+++ b/projects/app/src/pages/api/core/chat/updateHistory.ts
@@ -1,4 +1,4 @@
-import type { NextApiRequest, NextApiResponse } from 'next';
+import type { NextApiResponse } from 'next';
 import { jsonRes } from '@fastgpt/service/common/response';
 import { UpdateHistoryProps } from '@/global/core/chat/api.d';
 import { MongoChat } from '@fastgpt/service/core/chat/chatSchema';
@@ -13,6 +13,7 @@ async function handler(req: ApiRequestProps<UpdateHistoryProps>, res: NextApiRes
  await authChatCrud({
    req,
    authToken: true,
+    authApiKey: true,
    ...req.body,
    per: WritePermissionVal
  });
--- a/projects/app/src/pages/api/plugins/customFeedback/index.ts
+++ b/projects/app/src/pages/api/plugins/customFeedback/index.ts
@@ -18,7 +18,7 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse<
    const {
      appId,
      chatId,
-      responseChatItemId: chatItemId,
+      responseChatItemId: dataId,
      defaultFeedback,
      customFeedback
    } = req.body as Props;
@@ -38,12 +38,12 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse<
      addCustomFeedbacks({
        appId,
        chatId,
-        chatItemId,
+        dataId,
        feedbacks: [feedback]
      });
    }, 60000);

-    if (!chatId || !chatItemId) {
+    if (!chatId || !dataId) {
      return res.json({
        response: `\\n\\n**自动反馈调试**: ${feedback}\\n\\n`
      });
--- a/projects/app/src/pages/api/plugins/customFeedback/v2/index.ts
+++ b/projects/app/src/pages/api/plugins/customFeedback/v2/index.ts
@@ -20,7 +20,7 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse<
      customFeedback,
      appId,
      chatId,
-      responseChatItemId: chatItemId,
+      responseChatItemId: dataId,
      customInputs
    } = req.body as Props;

@@ -37,12 +37,12 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse<
      addCustomFeedbacks({
        appId,
        chatId,
-        chatItemId,
+        dataId,
        feedbacks: [feedbackText]
      });
    }, 60000);

-    if (!chatId || !chatItemId) {
+    if (!chatId || !dataId) {
      return res.json({
        [NodeOutputKeyEnum.answerText]: `\\n\\n**自动反馈调试**: "${feedbackText}"\\n\\n`,
        text: feedbackText