fix: allow the use of older gpt models in the api (#2001)

* fix: allow the use of older gpt models in the api

* fix: add script to run migration for test env

Author: spaenleh

package.json

@@ -41,6 +41,7 @@
     "openapi:generate": "node dist/scripts/generateOpenAPI.js",
     "openapi:lint": "vacuum lint ./openapi.json",
     "openapi:report": "vacuum html-report ./openapi.json vacuum-report.html",
+    "migration:apply-test": "DB_CONNECTION=postgres://test:test@db:5432/test yarn migration:run",
     "migration:generate": "yarn drizzle-kit generate",
     "migration:run": "yarn drizzle-kit migrate",
     "migration:check": "yarn drizzle-kit generate --name=migrationtest --out=./src/drizzle --schema=./src/drizzle/schema.ts --dialect=postgresql && [ -f '$(find ./src/drizzle | grep migrationtest)' ] && exit 1 || exit 0"

src/services/item/plugins/app/chatBot/chatBot.controller.test.ts

@@ -12,7 +12,7 @@ import build, {
 import { seedFromJson } from '../../../../../../test/mocks/seed';
 import { db } from '../../../../../drizzle/db';
 import { assertIsDefined } from '../../../../../utils/assertions';
-import { APP_ITEMS_PREFIX } from '../../../../../utils/config';
+import { APP_ITEMS_PREFIX, OPENAI_GPT_VERSION } from '../../../../../utils/config';
 import { OpenAILengthError, OpenAIUnknownStopError } from '../../../../../utils/errors';
 import { getAccessToken } from '../test/fixtures';
 import { FinishReason } from './chatBot.types';
@@ -304,6 +304,36 @@ describe('Chat Bot Tests', () => {
         expect(response.statusCode).toEqual(StatusCodes.BAD_REQUEST);
       });
 
+      it('OK if using accepted version but default to newer model', async () => {
+        const { apps } = await seedFromJson({ apps: [{}] });
+        const {
+          items: [item],
+          actor,
+        } = await seedFromJson({
+          items: [
+            {
+              type: ItemType.APP,
+              memberships: [{ account: 'actor' }],
+            },
+          ],
+        });
+        const chosenApp = apps[0];
+
+        assertIsDefined(actor);
+        mockAuthenticate(actor);
+        const token = await getAccessToken(app, item, chosenApp);
+        const response = await app.inject({
+          method: HttpMethod.Post,
+          url: `${APP_ITEMS_PREFIX}/${item.id}/${CHAT_PATH}?gptVersion=gpt-4`,
+          headers: {
+            Authorization: `Bearer ${token}`,
+          },
+          payload: DOCKER_MOCKED_BODY,
+        });
+        expect(response.statusCode).toEqual(StatusCodes.OK);
+        expect(response.json().model).toBe(OPENAI_GPT_VERSION);
+      });
+
       it('Bad request if post chat with invalid temperature', async () => {
         const { apps } = await seedFromJson({ apps: [{}] });
         const {

src/services/item/plugins/app/chatBot/chatBot.controller.ts

@@ -1,5 +1,7 @@
 import type { FastifyPluginAsyncTypebox } from '@fastify/type-provider-typebox';
 
+import { GPTVersion, GPTVersionType } from '@graasp/sdk';
+
 import { resolveDependency } from '../../../../../di/utils';
 import { db } from '../../../../../drizzle/db';
 import { asDefined } from '../../../../../utils/assertions';
@@ -10,6 +12,15 @@ import { AuthorizedItemService } from '../../../../authorizedItem.service';
 import { create } from './chatBot.schemas';
 import { ChatBotService } from './chatBot.service';
 
+const validateGPTVersion = (gptVersionInput: string | undefined): GPTVersionType => {
+  let gptVersion = gptVersionInput;
+  // convert removed versions to the default
+  if (!gptVersion || !(Object.values(GPTVersion) as string[]).includes(gptVersion)) {
+    gptVersion = OPENAI_GPT_VERSION;
+  }
+  return gptVersion as GPTVersionType;
+};
+
 const chatBotPlugin: FastifyPluginAsyncTypebox = async (fastify) => {
   const authorizedItemService = resolveDependency(AuthorizedItemService);
   const chatBotService = resolveDependency(ChatBotService);
@@ -27,9 +38,10 @@ const chatBotPlugin: FastifyPluginAsyncTypebox = async (fastify) => {
         await authorizedItemService.getItemById(db, { accountId: member.id, itemId });
         throw new InvalidJWTItem(jwtItemId ?? '<EMPTY>', itemId);
       }
-      // default to 3.5 turbo / or the version specified in the env variable
+      // validate the GPTVersion so that we can still support unsupported versions that will default to
+      // the standard value
+      const gptVersion = validateGPTVersion(query.gptVersion);
       // as it is the cheapest model while still allowing a larger context window than gpt4
-      const gptVersion = query.gptVersion ?? OPENAI_GPT_VERSION;
       const temperature = query.temperature ?? OPENAI_DEFAULT_TEMPERATURE;
 
       const message = await chatBotService.post(

src/services/item/plugins/app/chatBot/chatBot.schemas.ts

@@ -34,7 +34,10 @@ export const create = {
   }),
   querystring: customType.StrictObject({
     gptVersion: Type.Optional(
-      Type.Enum(GPTVersion, { description: 'Model to use', default: OPENAI_GPT_VERSION }),
+      Type.Union([
+        Type.Literal('gpt-4'),
+        Type.Enum(GPTVersion, { description: 'Model to use', default: OPENAI_GPT_VERSION }),
+      ]),
     ),
     temperature: Type.Optional(
       Type.Number({ maximum: OPENAI_MAX_TEMPERATURE, minimum: OPENAI_MIN_TEMPERATURE }),