fix(azure-openai): error handling

pezzolabs · Oct 22, 2023 · a63515e · a63515e
1 parent f8203b6
commit a63515e
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 43 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,4 @@
 # Add files here to ignore them from prettier formatting
 **/.next
-apps/docs
+apps/docs
+**/dist
diff --git a/apps/docs/theme.config.tsx b/apps/docs/theme.config.tsx
@@ -9,7 +9,7 @@ const config: DocsThemeConfig = {
     link: 'https://github.com/pezzolabs/unillm',
   },
   chat: {
-    link: 'https://pezzo.cc/discord',
+    link: 'https://discord.gg/XcEVPePwn2',
   },
   docsRepositoryBase: 'https://github.com/pezzolabs/unillm/tree/main/apps/docs',
   footer: {

diff --git a/packages/unillm-node/providers/azure-openai.ts b/packages/unillm-node/providers/azure-openai.ts
@@ -20,10 +20,10 @@ import { BaseProvider } from "./baseProvider";
 import { UnifiedErrorResponse } from "../utils/UnifiedErrorResponse";
 
 type AzureOpenAIError = {
-  message: string;
-  type: string;
-  param: string | null;
-  code: string | null;
+  message?: string;
+  type?: string;
+  param?: string | null;
+  code?: string | null;
 };
 
 export class AzureOpenAIProvider extends BaseProvider<Providers.AzureOpenAI> {
@@ -50,10 +50,6 @@ export class AzureOpenAIProvider extends BaseProvider<Providers.AzureOpenAI> {
         },
       );
     } catch (_error: any) {
-      if (!_error.type) {
-        throw _error;
-      }
-
       const error = this.getUnifiedErrorFromAzureOpenAIError(
         _error as AzureOpenAIError,
         model,
@@ -167,21 +163,42 @@ export class AzureOpenAIProvider extends BaseProvider<Providers.AzureOpenAI> {
 
   private getUnifiedErrorFromAzureOpenAIError(
     error: AzureOpenAIError,
-    model: ModelTypes[Providers.AzureOpenAI],
+    deployment: ModelTypes[Providers.AzureOpenAI],
   ): UnifiedErrorResponse {
-    let status;
-
-    switch (error.type) {
-      case "invalid_request_error":
-        status = 400;
-        break;
-      default:
-        status = 500;
+    let status = 500;
+
+    // Sometimes Azure returns a status code
+    if (typeof error.code === "number") {
+      status = error.code;
+    } else if (typeof error.code === "string") {
+      if (!isNaN(Number(error.code))) {
+        status = Number(error.code);
+      } else {
+        // Sometimes it returns strings
+        switch (error.code) {
+          case "DeploymentNotFound":
+            status = 404;
+            break;
+
+          // Need to handle more cases, but this isn't documented anywhere.
+        }
+      }
+    }
+
+    // And sometime it will return the native OpenAI error type, if endpoint and deployment exist
+    if (error.type) {
+      switch (error.type) {
+        case "invalid_request_error":
+          status = 400;
+          break;
+
+        // Need to handle more cases, but this isn't documented anywhere.
+      }
     }
 
     return new UnifiedErrorResponse(
       {
-        model,
+        model: `azure:openai:${deployment}`,
       },
       status,
       error,

diff --git a/packages/unillm-node/tests/azure-openai.test.ts b/packages/unillm-node/tests/azure-openai.test.ts
@@ -36,7 +36,7 @@ describe("#createChatCompletion - Azure OpenAI", () => {
       ).not.toThrow();
     });
 
-    it("Should throw an error and return a unified error response", async () => {
+    it.only("Should throw an error and return a unified error response", async () => {
       let errorOccurred = false;
       try {
         await uniLLM.createChatCompletion(`azure:${deployment}`, {

diff --git a/packages/unillm-node/tests/utils/validation.util.ts b/packages/unillm-node/tests/utils/validation.util.ts
@@ -5,9 +5,7 @@ import type {
 } from "openai/resources/chat";
 
 import { UnifiedCreateChatCompletionNonStreamResult } from "../../utils/types";
-import {
-  UnifiedErrorResponse,
-} from "../../utils/UnifiedErrorResponse";
+import { UnifiedErrorResponse } from "../../utils/UnifiedErrorResponse";
 
 /**
  * Validates an object against the OpenAI ChatCompletion response schema.
@@ -101,19 +99,17 @@ export function validateOpenAIChatCompletionChunk(obj: ChatCompletionChunk) {
 export function validateOpenAIChatCompletionErrorResponse(
   error: UnifiedErrorResponse,
 ) {
-  const schema: z.ZodType<UnifiedErrorResponse> = z.strictObject({
-    name: z.string(),
-    message: z.string(),
+  const schema = z.strictObject({
     status: z.number(),
     headers: z.record(z.string()),
-    param: z.string().nullable(),
-    code: z.string().nullable(),
-    type: z.string(),
+    param: z.string().nullable().optional(),
+    code: z.string().nullable().optional(),
+    type: z.string().optional(),
     error: z.strictObject({
       message: z.string(),
-      type: z.string(),
-      param: z.string().nullable(),
-      code: z.string().nullable(),
+      type: z.string().optional(),
+      param: z.string().nullable().optional(),
+      code: z.string().nullable().optional(),
     }),
     metadata: z.strictObject({
       model: z.string(),

diff --git a/packages/unillm-node/utils/UnifiedErrorResponse.ts b/packages/unillm-node/utils/UnifiedErrorResponse.ts
@@ -15,15 +15,5 @@ export class UnifiedErrorResponse extends APIError {
     headers: Headers | undefined,
   ) {
     super(status, error, message, headers);
-
-    if ((error as any).param === undefined) {
-      (error as any).param = null;
-      (this as any).param = null;
-    }
-
-    if ((error as any).code === undefined) {
-      (error as any).code = null;
-      (this as any).code = null;
-    }
   }
 }