Merge pull request #143 from AssemblyAI/EA17A79D514289B819B9AE7C9AB1132F

Sync from internal repo

Author: he-james

package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.29.0",
+  "version": "4.30.0",
   "description": "The AssemblyAI JavaScript SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async and real-time transcription, as well as the latest LeMUR models.",
   "engines": {
     "node": ">=18"

src/types/openapi.generated.ts

@@ -21,11 +21,18 @@ type OneOf<T extends any[]> = T extends [infer Only]
  */
 export type AudioIntelligenceModelStatus = "success" | "unavailable";
 
+export interface TranscriptWarning {
+  /** The warning message. */
+  message: string;
+}
+
 export interface TranscriptMetadata {
   /** The domain that was actually used for the transcription. */
   domain_used?: string | null;
   /** An optional warning message, if applicable. */
   warning?: string | null;
+  /** A list of warning objects, if applicable. */
+  warnings?: TranscriptWarning[] | null;
 }
 
 /**

tests/unit/transcript.test.ts

@@ -503,4 +503,69 @@ describe("transcript", () => {
     expect(transcript.id).toBe(transcriptId);
     expect(transcript.speech_model_used).toBeUndefined();
   });
+
+  it("should handle transcript response with metadata warnings", async () => {
+    const transcriptWithWarnings = {
+      id: transcriptId,
+      status: "completed",
+      metadata: {
+        domain_used: null,
+        warnings: [
+          {
+            message:
+              "Skipped medical-v1 correction because the language is not supported",
+          },
+        ],
+      },
+    };
+    fetchMock.doMockOnceIf(
+      requestMatches({ url: `/v2/transcript/${transcriptId}`, method: "GET" }),
+      JSON.stringify(transcriptWithWarnings),
+    );
+    const transcript = await assembly.transcripts.get(transcriptId);
+
+    expect(transcript.id).toBe(transcriptId);
+    expect(transcript.metadata).toBeDefined();
+    expect(transcript.metadata!.warnings).toHaveLength(1);
+    expect(transcript.metadata!.warnings![0].message).toBe(
+      "Skipped medical-v1 correction because the language is not supported",
+    );
+    expect(transcript.metadata!.domain_used).toBeNull();
+  });
+
+  it("should handle transcript response with metadata but no warnings key", async () => {
+    const transcriptWithMetadataNoWarnings = {
+      id: transcriptId,
+      status: "completed",
+      metadata: {
+        domain_used: null,
+      },
+    };
+    fetchMock.doMockOnceIf(
+      requestMatches({ url: `/v2/transcript/${transcriptId}`, method: "GET" }),
+      JSON.stringify(transcriptWithMetadataNoWarnings),
+    );
+    const transcript = await assembly.transcripts.get(transcriptId);
+
+    expect(transcript.id).toBe(transcriptId);
+    expect(transcript.metadata).toBeDefined();
+    expect(transcript.metadata!.domain_used).toBeNull();
+    expect(transcript.metadata!.warnings).toBeUndefined();
+  });
+
+  it("should handle transcript response without metadata", async () => {
+    const transcriptWithoutMetadata = {
+      id: transcriptId,
+      status: "completed",
+      // metadata intentionally omitted
+    };
+    fetchMock.doMockOnceIf(
+      requestMatches({ url: `/v2/transcript/${transcriptId}`, method: "GET" }),
+      JSON.stringify(transcriptWithoutMetadata),
+    );
+    const transcript = await assembly.transcripts.get(transcriptId);
+
+    expect(transcript.id).toBe(transcriptId);
+    expect(transcript.metadata).toBeUndefined();
+  });
 });