assemblyai 4.29.0 → 4.32.1

package/dist/workerd.mjs

@@ -15,7 +15,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.29.0" },
+    sdk: { name: "JavaScript", version: "4.32.1" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -220,8 +220,18 @@ const StreamingErrorType = {
     BadSchema: 4101,
     TooManyStreams: 4102,
     Reconnected: 4103,
+    ServerError: 3005,
+    InputValidationError: 3006,
+    AudioChunkDurationViolation: 3007,
+    MaxSessionDurationExceeded: 3008,
+    ConcurrencyLimitExceeded: 3009,
 };
 const StreamingErrorMessages = {
+    [StreamingErrorType.ServerError]: "Server error",
+    [StreamingErrorType.InputValidationError]: "Input validation error",
+    [StreamingErrorType.AudioChunkDurationViolation]: "Audio chunk duration violation",
+    [StreamingErrorType.MaxSessionDurationExceeded]: "Session expired: maximum session duration exceeded",
+    [StreamingErrorType.ConcurrencyLimitExceeded]: "Too many concurrent sessions",
     [StreamingErrorType.BadSampleRate]: "Sample rate must be a positive integer",
     [StreamingErrorType.AuthFailed]: "Not Authorized",
     [StreamingErrorType.InsufficientFunds]: "Insufficient funds",
@@ -804,12 +814,18 @@ class StreamingTranscriber {
         if (this.params.endOfTurnConfidenceThreshold) {
             searchParams.set("end_of_turn_confidence_threshold", this.params.endOfTurnConfidenceThreshold.toString());
         }
-        if (this.params.minTurnSilence) {
-            searchParams.set("min_turn_silence", this.params.minTurnSilence.toString());
+        if (this.params.minEndOfTurnSilenceWhenConfident !== undefined) {
+            if (this.params.minTurnSilence !== undefined) {
+                console.warn("[Deprecation Warning] Both `minEndOfTurnSilenceWhenConfident` and `minTurnSilence` are set. Using `minTurnSilence`; `minEndOfTurnSilenceWhenConfident` is deprecated.");
+            }
+            else {
+                console.warn("[Deprecation Warning] `minEndOfTurnSilenceWhenConfident` is deprecated and will be removed in a future release. Please use `minTurnSilence` instead.");
+            }
         }
-        else if (this.params.minEndOfTurnSilenceWhenConfident) {
-            console.warn("[Deprecation Warning] `minEndOfTurnSilenceWhenConfident` is deprecated and will be removed in a future release. Please use `minTurnSilence` instead.");
-            searchParams.set("min_end_of_turn_silence_when_confident", this.params.minEndOfTurnSilenceWhenConfident.toString());
+        const effectiveMinTurnSilence = this.params.minTurnSilence ??
+            this.params.minEndOfTurnSilenceWhenConfident;
+        if (effectiveMinTurnSilence !== undefined) {
+            searchParams.set("min_turn_silence", effectiveMinTurnSilence.toString());
         }
         if (this.params.maxTurnSilence) {
             searchParams.set("max_turn_silence", this.params.maxTurnSilence.toString());
@@ -855,6 +871,12 @@ class StreamingTranscriber {
         if (this.params.maxSpeakers !== undefined) {
             searchParams.set("max_speakers", this.params.maxSpeakers.toString());
         }
+        if (this.params.noiseSuppressionModel) {
+            searchParams.set("noise_suppression_model", this.params.noiseSuppressionModel);
+        }
+        if (this.params.noiseSuppressionThreshold !== undefined) {
+            searchParams.set("noise_suppression_threshold", this.params.noiseSuppressionThreshold.toString());
+        }
         if (this.params.llmGateway !== undefined) {
             searchParams.set("llm_gateway", JSON.stringify(this.params.llmGateway));
         }
@@ -898,7 +920,12 @@ class StreamingTranscriber {
             this.socket.onmessage = ({ data }) => {
                 const message = JSON.parse(data.toString());
                 if ("error" in message) {
-                    this.listeners.error?.(new StreamingError(message.error));
+                    const err = new StreamingError(message.error);
+                    if ("error_code" in message) {
+                        err.code =
+                            message.error_code;
+                    }
+                    this.listeners.error?.(err);
                     return;
                 }
                 switch (message.type) {
@@ -919,6 +946,12 @@ class StreamingTranscriber {
                         this.listeners.llmGatewayResponse?.(message);
                         break;
                     }
+                    case "Warning": {
+                        const warning = message;
+                        console.warn(`Streaming warning (code=${warning.warning_code}): ${warning.warning}`);
+                        this.listeners.warning?.(warning);
+                        break;
+                    }
                     case "Termination": {
                         this.sessionTerminatedResolve?.();
                         break;
@@ -942,9 +975,20 @@ class StreamingTranscriber {
      * @param config - The configuration parameters to update
      */
     updateConfiguration(config) {
+        const { min_end_of_turn_silence_when_confident, min_turn_silence, ...rest } = config;
+        if (min_end_of_turn_silence_when_confident !== undefined) {
+            if (min_turn_silence !== undefined) {
+                console.warn("[Deprecation Warning] Both `min_end_of_turn_silence_when_confident` and `min_turn_silence` are set. Using `min_turn_silence`; `min_end_of_turn_silence_when_confident` is deprecated.");
+            }
+            else {
+                console.warn("[Deprecation Warning] `min_end_of_turn_silence_when_confident` is deprecated and will be removed in a future release. Please use `min_turn_silence` instead.");
+            }
+        }
+        const effective = min_turn_silence ?? min_end_of_turn_silence_when_confident;
         const message = {
             type: "UpdateConfiguration",
-            ...config,
+            ...rest,
+            ...(effective !== undefined ? { min_turn_silence: effective } : {}),
         };
         this.send(JSON.stringify(message));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.29.0",
+  "version": "4.32.1",
   "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"

package/src/services/streaming/service.ts

@@ -16,6 +16,7 @@ import {
   LLMGatewayResponseEvent,
   StreamingUpdateConfiguration,
   StreamingForceEndpoint,
+  WarningEvent,
 } from "../..";
 import { StreamingError, StreamingErrorMessages } from "../../utils/errors";
 import { StreamingErrorTypeCodes } from "../../utils/errors/streaming";
@@ -86,19 +87,22 @@ export class StreamingTranscriber {
       );
     }
 
-    if (this.params.minTurnSilence) {
-      searchParams.set(
-        "min_turn_silence",
-        this.params.minTurnSilence.toString(),
-      );
-    } else if (this.params.minEndOfTurnSilenceWhenConfident) {
-      console.warn(
-        "[Deprecation Warning] `minEndOfTurnSilenceWhenConfident` is deprecated and will be removed in a future release. Please use `minTurnSilence` instead.",
-      );
-      searchParams.set(
-        "min_end_of_turn_silence_when_confident",
-        this.params.minEndOfTurnSilenceWhenConfident.toString(),
-      );
+    if (this.params.minEndOfTurnSilenceWhenConfident !== undefined) {
+      if (this.params.minTurnSilence !== undefined) {
+        console.warn(
+          "[Deprecation Warning] Both `minEndOfTurnSilenceWhenConfident` and `minTurnSilence` are set. Using `minTurnSilence`; `minEndOfTurnSilenceWhenConfident` is deprecated.",
+        );
+      } else {
+        console.warn(
+          "[Deprecation Warning] `minEndOfTurnSilenceWhenConfident` is deprecated and will be removed in a future release. Please use `minTurnSilence` instead.",
+        );
+      }
+    }
+    const effectiveMinTurnSilence =
+      this.params.minTurnSilence ??
+      this.params.minEndOfTurnSilenceWhenConfident;
+    if (effectiveMinTurnSilence !== undefined) {
+      searchParams.set("min_turn_silence", effectiveMinTurnSilence.toString());
     }
 
     if (this.params.maxTurnSilence) {
@@ -176,6 +180,20 @@ export class StreamingTranscriber {
       searchParams.set("max_speakers", this.params.maxSpeakers.toString());
     }
 
+    if (this.params.noiseSuppressionModel) {
+      searchParams.set(
+        "noise_suppression_model",
+        this.params.noiseSuppressionModel,
+      );
+    }
+
+    if (this.params.noiseSuppressionThreshold !== undefined) {
+      searchParams.set(
+        "noise_suppression_threshold",
+        this.params.noiseSuppressionThreshold.toString(),
+      );
+    }
+
     if (this.params.llmGateway !== undefined) {
       searchParams.set("llm_gateway", JSON.stringify(this.params.llmGateway));
     }
@@ -191,6 +209,7 @@ export class StreamingTranscriber {
     event: "llmGatewayResponse",
     listener: (event: LLMGatewayResponseEvent) => void,
   ): void;
+  on(event: "warning", listener: (event: WarningEvent) => void): void;
   on(event: "error", listener: (error: Error) => void): void;
   on(event: "close", listener: (code: number, reason: string) => void): void;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -243,7 +262,12 @@ Learn more at https://github.com/AssemblyAI/assemblyai-node-sdk/blob/main/docs/c
         const message = JSON.parse(data.toString()) as StreamingEventMessage;
 
         if ("error" in message) {
-          this.listeners.error?.(new StreamingError(message.error));
+          const err = new StreamingError(message.error);
+          if ("error_code" in message) {
+            (err as StreamingError & { code?: number }).code =
+              message.error_code;
+          }
+          this.listeners.error?.(err);
           return;
         }
 
@@ -265,6 +289,14 @@ Learn more at https://github.com/AssemblyAI/assemblyai-node-sdk/blob/main/docs/c
             this.listeners.llmGatewayResponse?.(message);
             break;
           }
+          case "Warning": {
+            const warning = message as WarningEvent;
+            console.warn(
+              `Streaming warning (code=${warning.warning_code}): ${warning.warning}`,
+            );
+            this.listeners.warning?.(warning);
+            break;
+          }
           case "Termination": {
             this.sessionTerminatedResolve?.();
             break;
@@ -291,9 +323,28 @@ Learn more at https://github.com/AssemblyAI/assemblyai-node-sdk/blob/main/docs/c
    * @param config - The configuration parameters to update
    */
   updateConfiguration(config: Omit<StreamingUpdateConfiguration, "type">) {
+    const {
+      min_end_of_turn_silence_when_confident,
+      min_turn_silence,
+      ...rest
+    } = config;
+    if (min_end_of_turn_silence_when_confident !== undefined) {
+      if (min_turn_silence !== undefined) {
+        console.warn(
+          "[Deprecation Warning] Both `min_end_of_turn_silence_when_confident` and `min_turn_silence` are set. Using `min_turn_silence`; `min_end_of_turn_silence_when_confident` is deprecated.",
+        );
+      } else {
+        console.warn(
+          "[Deprecation Warning] `min_end_of_turn_silence_when_confident` is deprecated and will be removed in a future release. Please use `min_turn_silence` instead.",
+        );
+      }
+    }
+    const effective =
+      min_turn_silence ?? min_end_of_turn_silence_when_confident;
     const message: StreamingUpdateConfiguration = {
       type: "UpdateConfiguration",
-      ...config,
+      ...rest,
+      ...(effective !== undefined ? { min_turn_silence: effective } : {}),
     };
     this.send(JSON.stringify(message));
   }

package/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;
 }
 
 /**
@@ -2818,6 +2825,10 @@ export type Transcript = {
    * See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more information.
    */
   redact_pii_policies?: PiiPolicy[] | null;
+  /**
+   * Whether the unredacted text, words, and utterances were also returned alongside the redacted fields. Only applies when `redact_pii` is enabled.
+   */
+  redact_pii_return_unredacted?: boolean | null;
   /**
    * The replacement logic for detected PII, can be "entity_type" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
    */
@@ -2910,6 +2921,18 @@ export type Transcript = {
    * The list of custom topics provided if custom topics is enabled
    */
   topics?: string[];
+  /**
+   * The unredacted transcript text. Returned only when `redact_pii_return_unredacted` was set with `redact_pii`.
+   */
+  unredacted_text?: string | null;
+  /**
+   * The unredacted list of utterances. Returned only when `redact_pii_return_unredacted` was set with `redact_pii` and channel/speaker modes are enabled.
+   */
+  unredacted_utterances?: TranscriptUtterance[] | null;
+  /**
+   * The unredacted list of individual words. Returned only when `redact_pii_return_unredacted` was set with `redact_pii`.
+   */
+  unredacted_words?: TranscriptWord[] | null;
   /**
    * When dual_channel or speaker_labels is enabled, a list of turn-by-turn utterance objects.
    * See {@link https://www.assemblyai.com/docs/models/speaker-diarization | Speaker diarization } for more information.
@@ -3389,6 +3412,11 @@ export type TranscriptOptionalParams = {
    * The list of PII Redaction policies to enable. See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
    */
   redact_pii_policies?: PiiPolicy[];
+  /**
+   * If `redact_pii` is enabled, also return the unredacted text, words, and utterances alongside the redacted fields.
+   * @defaultValue false
+   */
+  redact_pii_return_unredacted?: boolean;
   /**
    * The replacement logic for detected PII, can be "entity_type" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
    * @defaultValue "hash"

package/src/types/streaming/index.ts

@@ -36,6 +36,8 @@ export type StreamingTranscriberParams = {
   inactivityTimeout?: number;
   speakerLabels?: boolean;
   maxSpeakers?: number;
+  noiseSuppressionModel?: NoiseSuppressionModel;
+  noiseSuppressionThreshold?: number;
   llmGateway?: LLMGatewayConfig;
 };
 
@@ -45,6 +47,7 @@ export type StreamingEvents =
   | "turn"
   | "speechStarted"
   | "llmGatewayResponse"
+  | "warning"
   | "error";
 
 export type StreamingListeners = {
@@ -53,6 +56,7 @@ export type StreamingListeners = {
   turn?: (event: TurnEvent) => void;
   speechStarted?: (event: SpeechStartedEvent) => void;
   llmGatewayResponse?: (event: LLMGatewayResponseEvent) => void;
+  warning?: (event: WarningEvent) => void;
   error?: (error: Error) => void;
 };
 
@@ -65,6 +69,8 @@ export type StreamingSpeechModel =
 
 export type StreamingDomain = "medical-v1";
 
+export type NoiseSuppressionModel = "near-field" | "far-field";
+
 export type StreamingTokenParams = {
   expires_in_seconds: number;
   max_session_duration_seconds?: number;
@@ -139,9 +145,17 @@ export type StreamingForceEndpoint = {
 };
 
 export type ErrorEvent = {
+  type: "Error";
+  error_code?: number;
   error: string;
 };
 
+export type WarningEvent = {
+  type: "Warning";
+  warning_code: number;
+  warning: string;
+};
+
 export type LLMGatewayResponseEvent = {
   type: "LLMGatewayResponse";
   turn_order: number;
@@ -155,7 +169,8 @@ export type StreamingEventMessage =
   | SpeechStartedEvent
   | TerminationEvent
   | LLMGatewayResponseEvent
-  | ErrorEvent;
+  | ErrorEvent
+  | WarningEvent;
 
 export type StreamingOperationMessage =
   | StreamingUpdateConfiguration

package/src/utils/errors/streaming.ts

@@ -15,12 +15,24 @@ const StreamingErrorType = {
   BadSchema: 4101,
   TooManyStreams: 4102,
   Reconnected: 4103,
+  ServerError: 3005,
+  InputValidationError: 3006,
+  AudioChunkDurationViolation: 3007,
+  MaxSessionDurationExceeded: 3008,
+  ConcurrencyLimitExceeded: 3009,
 } as const;
 
 type StreamingErrorTypeCodes =
   (typeof StreamingErrorType)[keyof typeof StreamingErrorType];
 
 const StreamingErrorMessages: Record<StreamingErrorTypeCodes, string> = {
+  [StreamingErrorType.ServerError]: "Server error",
+  [StreamingErrorType.InputValidationError]: "Input validation error",
+  [StreamingErrorType.AudioChunkDurationViolation]:
+    "Audio chunk duration violation",
+  [StreamingErrorType.MaxSessionDurationExceeded]:
+    "Session expired: maximum session duration exceeded",
+  [StreamingErrorType.ConcurrencyLimitExceeded]: "Too many concurrent sessions",
   [StreamingErrorType.BadSampleRate]: "Sample rate must be a positive integer",
   [StreamingErrorType.AuthFailed]: "Not Authorized",
   [StreamingErrorType.InsufficientFunds]: "Insufficient funds",