Migrate from deprecated @azure/openai package to openai (#3050)

Co-authored-by: Johannes Obermair <[email protected]>

.changeset/calm-clocks-switch.md

@@ -0,0 +1,7 @@
+---
+"@comet/cms-api": patch
+---
+
+Migrate from deprecated `@azure/openai` package to `openai`
+
+See https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/migration-javascript for more information.

demo/api/package.json

@@ -20,8 +20,8 @@
         "mikro-orm": "mikro-orm",
         "mikro-orm:drop": "mikro-orm schema:drop -r",
         "mikro-orm:migration:generate": "mikro-orm migration:create",
-        "start": "$npm_execpath prebuild && dotenv -c -e .env.site-configs -- nest start --debug --watch --preserveWatchOutput",
-        "start:dev": "$npm_execpath prebuild && $npm_execpath db:migrate && $npm_execpath console createBlockIndexViews && NODE_OPTIONS='--max-old-space-size=512' dotenv -c -e .env.site-configs -- nest start --debug --watch --preserveWatchOutput",
+        "start": "$npm_execpath prebuild && dotenv -e .env.secrets -e .env.local -e .env -e .env.site-configs -- nest start --debug --watch --preserveWatchOutput",
+        "start:dev": "$npm_execpath prebuild && $npm_execpath db:migrate && $npm_execpath console createBlockIndexViews && NODE_OPTIONS='--max-old-space-size=512' dotenv -e .env.secrets -e .env.local -e .env -e .env.site-configs -- nest start --debug --watch --preserveWatchOutput",
         "start:prod": "node dist/main"
     },
     "dependencies": {

packages/api/cms-api/package.json

@@ -34,7 +34,6 @@
     "dependencies": {
         "@aws-sdk/client-s3": "3.645.0",
         "@azure-rest/ai-translation-text": "^1.0.0-beta.1",
-        "@azure/openai": "1.0.0-beta.11",
         "@azure/storage-blob": "^12.23.0",
         "@comet/blocks-api": "workspace:^7.11.0",
         "@fast-csv/parse": "^4.3.6",
@@ -69,6 +68,7 @@
         "mime-db": "^1.0.0",
         "multer": "^1.4.4",
         "node-fetch": "^2.0.0",
+        "openai": "^4.77.3",
         "passport": "^0.6.0",
         "passport-custom": "^1.1.1",
         "passport-http": "^0.3.0",

packages/api/cms-api/src/content-generation/azure-open-ai/azure-open-ai-content-generation.service.ts

@@ -1,5 +1,6 @@
-import { AzureKeyCredential, ChatRequestMessage, OpenAIClient } from "@azure/openai";
 import { Inject, Injectable } from "@nestjs/common";
+import { AzureOpenAI } from "openai";
+import { ChatCompletionMessageParam } from "openai/resources/chat/completions";
 
 import { FilesService } from "../../dam/files/files.service";
 import { ContentGenerationServiceInterface } from "../content-generation-service.interface";
@@ -11,6 +12,7 @@ export type AzureOpenAiConfig = {
     deploymentId: string;
     apiKey: string;
     apiUrl: string;
+    apiVersion?: string;
 };
 
 type ConfigByMethod = Partial<Record<ServiceMethods, AzureOpenAiConfig>>;
@@ -40,6 +42,15 @@ export class AzureOpenAiContentGenerationService {
         return config;
     }
 
+    private createClient(config: AzureOpenAiConfig): AzureOpenAI {
+        return new AzureOpenAI({
+            apiKey: config.apiKey,
+            deployment: config.deploymentId,
+            apiVersion: config.apiVersion ?? "2024-03-01-preview",
+            endpoint: config.apiUrl,
+        });
+    }
+
     async generateAltText(fileId: string): Promise<string> {
         const config = this.getConfigForMethod("generateAltText");
 
@@ -49,8 +60,8 @@ export class AzureOpenAiContentGenerationService {
             throw new Error("File doesn't exist");
         }
 
-        const client = new OpenAIClient(config.apiUrl, new AzureKeyCredential(config.apiKey));
-        const prompt: ChatRequestMessage[] = [
+        const client = this.createClient(config);
+        const prompt: Array<ChatCompletionMessageParam> = [
             {
                 role: "system",
                 content:
@@ -61,15 +72,15 @@ export class AzureOpenAiContentGenerationService {
                 content: [
                     {
                         type: "image_url",
-                        imageUrl: {
+                        image_url: {
                             url: await this.filesService.getFileAsBase64String(file),
                             detail: "low",
                         },
                     },
                 ],
             },
         ];
-        const result = await client.getChatCompletions(config.deploymentId, prompt, { maxTokens: 300 });
+        const result = await client.chat.completions.create({ messages: prompt, model: "", max_tokens: 300 });
         return result.choices[0].message?.content ?? "";
     }
 
@@ -82,8 +93,8 @@ export class AzureOpenAiContentGenerationService {
             throw new Error("File doesn't exist");
         }
 
-        const client = new OpenAIClient(config.apiUrl, new AzureKeyCredential(config.apiKey));
-        const prompt: ChatRequestMessage[] = [
+        const client = this.createClient(config);
+        const prompt: Array<ChatCompletionMessageParam> = [
             {
                 role: "system",
                 content:
@@ -94,15 +105,15 @@ export class AzureOpenAiContentGenerationService {
                 content: [
                     {
                         type: "image_url",
-                        imageUrl: {
+                        image_url: {
                             url: await this.filesService.getFileAsBase64String(file),
                             detail: "low",
                         },
                     },
                 ],
             },
         ];
-        const result = await client.getChatCompletions(config.deploymentId, prompt, { maxTokens: 300 });
+        const result = await client.chat.completions.create({ messages: prompt, model: "", max_tokens: 300 });
         return result.choices[0].message?.content ?? "";
     }
 }