Update OpenAI dependency

OpenAI package will be updated soon,
as it needs codebase migration

package.json

@@ -15,8 +15,9 @@
     "discord.js": "^14.8.0",
     "fold-to-ascii": "^5.0.1",
     "gpt-3-encoder": "^1.1.4",
-    "openai": "^3.2.1",
-    "require-directory": "^2.1.1"
+    "openai": "^4.10.0",
+    "require-directory": "^2.1.1",
+    "typescript": "^5.1.6"
   },
   "devDependencies": {
     "@types/fold-to-ascii": "^5.0.0",
@@ -24,7 +25,6 @@
     "@typescript-eslint/eslint-plugin": "^6.2.0",
     "@typescript-eslint/parser": "^6.2.0",
     "eslint": "^8.46.0",
-    "prisma": "^5.0.0",
-    "typescript": "^5.1.6"
+    "prisma": "^5.0.0"
   }
 }

src/command.ts

@@ -1,6 +1,6 @@
 import { AutocompleteInteraction, PermissionsBitField } from "discord.js";
 import { RESTPostAPIApplicationCommandsJSONBody } from "discord.js";
-import { ApplicationCommandOption, ApplicationCommandType, ChatInputCommandInteraction, LocalizationMap, MessageInteraction, PermissionResolvable, UserSelectMenuInteraction } from "discord.js";
+import { APIApplicationCommandOption, ApplicationCommandType, ChatInputCommandInteraction, LocalizationMap, MessageInteraction, PermissionResolvable, UserSelectMenuInteraction } from "discord.js";
 
 type InteractionTypeMap = {
   [ApplicationCommandType.ChatInput]: [ChatInputCommandInteraction, string];
@@ -13,7 +13,7 @@ interface Command<Type extends keyof InteractionTypeMap = ApplicationCommandType
   readonly name_localizations?: LocalizationMap;
   readonly description: InteractionTypeMap[Type][1];
   readonly description_localizations?: LocalizationMap;
-  readonly options?: ApplicationCommandOption[];
+  readonly options?: APIApplicationCommandOption[];
   readonly default_member_permissions?: PermissionResolvable;
   readonly type: Type;
   readonly nsfw?: boolean;

src/commands/check-limit.ts

@@ -1,4 +1,4 @@
-import { ApplicationCommandType, ChatInputCommandInteraction, ApplicationCommandOption, ApplicationCommandOptionType, APIEmbedField } from "discord.js";
+import { ApplicationCommandType, ChatInputCommandInteraction, APIApplicationCommandOption, ApplicationCommandOptionType, APIEmbedField } from "discord.js";
 
 import Command from "../command";
 import { config } from "../index";
@@ -7,7 +7,7 @@ export default class MyLimit extends Command implements Command {
   name = "check-limit";
   description = "Checks your limit and usage";
   type = ApplicationCommandType.ChatInput;
-  options: ApplicationCommandOption[] = [
+  options: APIApplicationCommandOption[] = [
     {
       name: "recovery-for",
       description: "Calculate the limit recovery time for given message count (default: amount required to use the bot again or 1)",

src/configDefault.ts

@@ -1,8 +1,8 @@
 import { Message } from "discord.js";
 import {
-  ChatCompletionRequestMessage as OpenAIMessage,
-  CreateChatCompletionRequest as ChatCompletionRequestData,
-} from "openai";
+  ChatCompletionMessageParam as OpenAIMessage,
+  ChatCompletionCreateParamsNonStreaming as ChatCompletionRequestData,
+} from "openai/resources/chat";
 
 import IQuota from "./IQuota";
 import MessageCount from "./quota/messageCount";

src/execution.ts

@@ -1,11 +1,11 @@
 import DiscordApi, { GuildTextBasedChannel, TextBasedChannel } from "discord.js";
-import { ChatCompletionRequestMessage, ChatCompletionResponseMessage } from "openai";
-import Axios from "axios";
+import {APIError as OpenAIError} from "openai";
 
 import { database, openai, config } from "./index";
 import Moderation from "./moderation";
 import toOpenAIMessages from "./toOpenAIMessages";
 import FunctionManager from "./funcitonManager";
+import { ChatCompletion, ChatCompletionMessage, ChatCompletionMessageParam } from "openai/resources/chat";
 
 type NonNullableInObject<T, V> = { [k in keyof T]: k extends V ? NonNullable<T[k]> : T[k] };
 export type apiRequest = DiscordApi.Message | DiscordApi.RepliableInteraction;
@@ -171,12 +171,12 @@ export async function queueRequest(request: apiRequest) {
  * @param functionRan counter of how many function have been ran
  */
 function logUsedTokens(
-    answer: Awaited<ReturnType<typeof openai.createChatCompletion>>,
+    answer: ChatCompletion,
     message: RequestMessage,
     functionRan: number,
   ) {
-    const usage = answer.data.usage;
-    const functionName = answer.data.choices[0].message?.function_call?.name;
+    const usage = answer.usage;
+    const functionName = answer.choices[0].message?.function_call?.name;
     if (usage !== undefined) {
       const channelName: string = !message.channel.isDMBased() ? `${message.channel.name} (${message.guild?.name})` : `@${getAuthor(message).tag}`;
       console.log(`Used ${usage.total_tokens} (${usage.prompt_tokens} + ${usage.completion_tokens}) tokens for ${getAuthor(message).tag} (${getAuthor(message).id}) in #${channelName}${functionName ? " [Function: " + functionName + "]" : ""}`);
@@ -207,7 +207,7 @@ async function executeFromQueue(channel: string) {
   const channelQueue = channelsRunning.get(channel) as ChannelsRunningValue;
   const message = channelQueue.at(0) as RequestMessage;
   let functionRanCounter = 0;
-  let OpenAImessages: ChatCompletionRequestMessage[] = [];
+  let OpenAImessages: ChatCompletionMessageParam[] = [];
 
   // ignore if we can't even send anything to reply
   if (!canReplyToRequest(message)) return;
@@ -234,11 +234,11 @@ async function executeFromQueue(channel: string) {
     });
 
     OpenAImessages = toOpenAIMessages(messages.values());
-    let generatedMessage: ChatCompletionResponseMessage | undefined = undefined;
-    let answer: Awaited<ReturnType<typeof openai.createChatCompletion>>;
+    let generatedMessage: ChatCompletionMessage | undefined = undefined;
+    let answer: Awaited<ReturnType<typeof openai.chat.completions.create>>;
 
     do {
-      answer = await openai.createChatCompletion({
+      answer = await openai.chat.completions.create({
         ...config.chatCompletionParams,
         messages: OpenAImessages,
         // FIXME: don't use new instance of FunctionManager
@@ -247,7 +247,7 @@ async function executeFromQueue(channel: string) {
 
       logUsedTokens(answer, message, ++functionRanCounter);
 
-      generatedMessage = answer.data.choices[0].message;
+      generatedMessage = answer.choices[0].message;
       if (!generatedMessage) throw new Error("Empty message received");
 
       // handle function calls
@@ -262,9 +262,9 @@ async function executeFromQueue(channel: string) {
 
     channelQueue.stopTyping();
 
-    const answerContent = answer.data.choices[0].message?.content;
+    const answerContent = answer.choices[0].message?.content;
 
-    if (answerContent === undefined || answerContent === "") {
+    if (answerContent === null || answerContent === "") {
       if (message instanceof DiscordApi.Message) message.react("😶").catch(() => {/* GRACEFAIL: It's okay if the bot won't reply */});
     }
     else {
@@ -285,29 +285,37 @@ async function executeFromQueue(channel: string) {
       }
     }
   } catch (e) {
+    let errorText: string = "";
     channelQueue.stopTyping();
-    console.error(`Error ocurred while handling chat completion request (${(e as object).constructor.name}):`);
-    if (Axios.isAxiosError(e)) {
-      console.error(JSON.stringify(e.response?.data));
-    }
-    else {
+    if (typeof e !== "object") {
+      console.error(`Error ocurred while handling chat completion request (${typeof e}):`);
       console.error(e);
     }
-    if (OpenAImessages.length !== 0) {
-      console.error("Messages:");
-      console.error(OpenAImessages);
+    else if (e === null) {
+      console.error ("Error ocurred while handling chat completion request: null");
     }
+    else {
+      console.error(`Error ocurred while handling chat completion request (${e.constructor.name}):`);
+      if (e instanceof OpenAIError) {
+        console.error(JSON.stringify(e));
+      }
+      else {
+        console.error(e);
+      }
+      if (OpenAImessages.length !== 0) {
+        console.error("Messages:");
+        console.error(OpenAImessages);
+      }
 
-    let errorText = "\n";
-
-    if (e instanceof Error) {
-      errorText += e.message;
-    }
-    else errorText = "";
-    if (Axios.isAxiosError(e) && e.code?.match(/^5..$/) && channelQueue.tries < 3) {
-      channelQueue.tries++;
-      await new Promise(r => setTimeout(r, 2000)); // pause for 2 seconds before retrying
-      return executeFromQueue(channel);
+      if (e instanceof Error) {
+        errorText = e.message;
+      }
+      else errorText = "";
+      if (e instanceof OpenAIError && e.code?.match(/^5..$/) && channelQueue.tries < 3) {
+        channelQueue.tries++;
+        await new Promise(r => setTimeout(r, 2000)); // pause for 2 seconds before retrying
+        return executeFromQueue(channel);
+      }
     }
 
     requestReply(

src/funcitonManager.ts

@@ -1,4 +1,4 @@
-import { ChatCompletionFunctions, ChatCompletionRequestMessage, ChatCompletionRequestMessageFunctionCall } from "openai";
+import { ChatCompletionCreateParams, ChatCompletionMessage, ChatCompletionMessageParam } from "openai/resources/chat";
 
 import { config } from "./index";
 
@@ -13,6 +13,9 @@ type OpenAIFunctionRequestData<T extends nameTypeMap> = {
   [name in keyof T]: T[name];
 };
 
+type ChatCompletionFunctions = ChatCompletionCreateParams.Function;
+type ChatCompletionFunctionCall = ChatCompletionMessage.FunctionCall;
+
 /**
  * Represents the function that can be ran by the OpenAI model
  */
@@ -61,7 +64,7 @@ export default class FunctionManager {
     return rvalue;
   }
 
-  public handleFunction(request: ChatCompletionRequestMessageFunctionCall): ChatCompletionRequestMessage {
+  public handleFunction(request: ChatCompletionFunctionCall): ChatCompletionMessageParam {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     let parsedArguments: any;
     

src/index.ts

@@ -1,5 +1,5 @@
 import DiscordApi from "discord.js";
-import { Configuration as OpenAIApiConfiguration, OpenAIApi } from "openai";
+import OpenAIApi from "openai";
 import { PrismaClient } from "@prisma/client";
 import Typescript from "typescript";
 import fs from "node:fs";
@@ -43,9 +43,9 @@ function getConfig() {
 
 export const config: IConfigRequired = getConfig();
 
-export const openai = new OpenAIApi(new OpenAIApiConfiguration({
+export const openai = new OpenAIApi({
   apiKey: config.tokens.OpenAI
-}));
+});
 
 export const database = new PrismaClient();
 

src/moderation.ts

@@ -28,11 +28,11 @@ export default class Moderation {
       }
     }
     
-    const answer = await openai.createModeration({
+    const answer = await openai.moderations.create({
       input: await formatRequestOrResponse(message),
     });
 
-    const flagged = answer.data.results[0].flagged;
+    const flagged = answer.results[0].flagged;
     this.cache.set(message.id, flagged);
     // FIXME: These next 7 lines does not belong there and should be refactored out.
     if (flagged) if (message instanceof Message) {

src/toOpenAIMessages.ts

@@ -1,4 +1,4 @@
-import { ChatCompletionRequestMessage as OpenAIMessage } from "openai";
+import { ChatCompletionMessageParam as OpenAIMessage } from "openai/resources/chat";
 import { Collection, Message as DiscordMessage, InteractionResponse } from "discord.js";
 import FoldToAscii from "fold-to-ascii";