assemblyai 4.6.1 → 4.7.0

package/dist/streaming.mjs

@@ -40,30 +40,42 @@ const { WritableStream } = typeof window !== "undefined"
 
 const factory = (url, params) => new ws(url, params);
 
-var RealtimeErrorType;
-(function (RealtimeErrorType) {
-    RealtimeErrorType[RealtimeErrorType["BadSampleRate"] = 4000] = "BadSampleRate";
-    RealtimeErrorType[RealtimeErrorType["AuthFailed"] = 4001] = "AuthFailed";
-    // Both InsufficientFunds and FreeAccount error use 4002
-    RealtimeErrorType[RealtimeErrorType["InsufficientFundsOrFreeAccount"] = 4002] = "InsufficientFundsOrFreeAccount";
-    RealtimeErrorType[RealtimeErrorType["NonexistentSessionId"] = 4004] = "NonexistentSessionId";
-    RealtimeErrorType[RealtimeErrorType["SessionExpired"] = 4008] = "SessionExpired";
-    RealtimeErrorType[RealtimeErrorType["ClosedSession"] = 4010] = "ClosedSession";
-    RealtimeErrorType[RealtimeErrorType["RateLimited"] = 4029] = "RateLimited";
-    RealtimeErrorType[RealtimeErrorType["UniqueSessionViolation"] = 4030] = "UniqueSessionViolation";
-    RealtimeErrorType[RealtimeErrorType["SessionTimeout"] = 4031] = "SessionTimeout";
-    RealtimeErrorType[RealtimeErrorType["AudioTooShort"] = 4032] = "AudioTooShort";
-    RealtimeErrorType[RealtimeErrorType["AudioTooLong"] = 4033] = "AudioTooLong";
-    RealtimeErrorType[RealtimeErrorType["BadJson"] = 4100] = "BadJson";
-    RealtimeErrorType[RealtimeErrorType["BadSchema"] = 4101] = "BadSchema";
-    RealtimeErrorType[RealtimeErrorType["TooManyStreams"] = 4102] = "TooManyStreams";
-    RealtimeErrorType[RealtimeErrorType["Reconnected"] = 4103] = "Reconnected";
-    RealtimeErrorType[RealtimeErrorType["ReconnectAttemptsExhausted"] = 1013] = "ReconnectAttemptsExhausted";
-})(RealtimeErrorType || (RealtimeErrorType = {}));
+const RealtimeErrorType = {
+    BadSampleRate: 4000,
+    AuthFailed: 4001,
+    /**
+     * @deprecated Use InsufficientFunds or FreeTierUser instead
+     */
+    InsufficientFundsOrFreeAccount: 4002,
+    InsufficientFunds: 4002,
+    FreeTierUser: 4003,
+    NonexistentSessionId: 4004,
+    SessionExpired: 4008,
+    ClosedSession: 4010,
+    RateLimited: 4029,
+    UniqueSessionViolation: 4030,
+    SessionTimeout: 4031,
+    AudioTooShort: 4032,
+    AudioTooLong: 4033,
+    AudioTooSmallToTranscode: 4034,
+    /**
+     * @deprecated Don't use
+     */
+    BadJson: 4100,
+    BadSchema: 4101,
+    TooManyStreams: 4102,
+    Reconnected: 4103,
+    /**
+     * @deprecated Don't use
+     */
+    ReconnectAttemptsExhausted: 1013,
+    WordBoostParameterParsingFailed: 4104,
+};
 const RealtimeErrorMessages = {
     [RealtimeErrorType.BadSampleRate]: "Sample rate must be a positive integer",
     [RealtimeErrorType.AuthFailed]: "Not Authorized",
-    [RealtimeErrorType.InsufficientFundsOrFreeAccount]: "Insufficient funds or you are using a free account. This feature is paid-only and requires you to add a credit card. Please visit https://assemblyai.com/dashboard/ to add a credit card to your account.",
+    [RealtimeErrorType.InsufficientFunds]: "Insufficient funds",
+    [RealtimeErrorType.FreeTierUser]: "This feature is paid-only and requires you to add a credit card. Please visit https://app.assemblyai.com/ to add a credit card to your account.",
     [RealtimeErrorType.NonexistentSessionId]: "Session ID does not exist",
     [RealtimeErrorType.SessionExpired]: "Session has expired",
     [RealtimeErrorType.ClosedSession]: "Session is closed",
@@ -72,11 +84,13 @@ const RealtimeErrorMessages = {
     [RealtimeErrorType.SessionTimeout]: "Session Timeout",
     [RealtimeErrorType.AudioTooShort]: "Audio too short",
     [RealtimeErrorType.AudioTooLong]: "Audio too long",
+    [RealtimeErrorType.AudioTooSmallToTranscode]: "Audio too small to transcode",
     [RealtimeErrorType.BadJson]: "Bad JSON",
     [RealtimeErrorType.BadSchema]: "Bad schema",
     [RealtimeErrorType.TooManyStreams]: "Too many streams",
-    [RealtimeErrorType.Reconnected]: "Reconnected",
+    [RealtimeErrorType.Reconnected]: "This session has been reconnected. This WebSocket is no longer valid.",
     [RealtimeErrorType.ReconnectAttemptsExhausted]: "Reconnect attempts exhausted",
+    [RealtimeErrorType.WordBoostParameterParsingFailed]: "Could not parse word boost parameter",
 };
 class RealtimeError extends Error {
 }
@@ -170,7 +184,7 @@ class RealtimeTranscriber {
             this.socket.onclose = ({ code, reason }) => {
                 var _a, _b;
                 if (!reason) {
-                    if (code in RealtimeErrorType) {
+                    if (code in RealtimeErrorMessages) {
                         reason = RealtimeErrorMessages[code];
                     }
                 }

package/dist/types/openapi.generated.d.ts

@@ -2239,6 +2239,16 @@ export type Transcript = {
      * The default value is 'en_us'.
      */
     language_code?: LiteralUnion<TranscriptLanguageCode, string>;
+    /**
+     * The confidence score for the detected language, between 0.0 (low confidence) and 1.0 (high confidence)
+     */
+    language_confidence: number | null;
+    /**
+     * The confidence threshold for the automatically detected language.
+     * An error will be returned if the langauge confidence is below this threshold.
+     * Defaults to 0.
+     */
+    language_confidence_threshold: number | null;
     /**
      * Whether {@link https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection | Automatic language detection } is enabled, either true or false
      */
@@ -2374,7 +2384,7 @@ export type Transcript = {
     words?: TranscriptWord[] | null;
 };
 /**
- * The word boost parameter value
+ * How much to boost specified words
  */
 export type TranscriptBoostParam = "low" | "default" | "high";
 /**
@@ -2548,7 +2558,7 @@ export type TranscriptOptionalParams = {
      */
     auto_highlights?: boolean;
     /**
-     * The word boost parameter value
+     * How much to boost specified words
      */
     boost_param?: TranscriptBoostParam;
     /**
@@ -2596,6 +2606,12 @@ export type TranscriptOptionalParams = {
      * The default value is 'en_us'.
      */
     language_code?: LiteralUnion<TranscriptLanguageCode, string> | null;
+    /**
+     * The confidence threshold for the automatically detected language.
+     * An error will be returned if the langauge confidence is below this threshold.
+     * Defaults to 0.
+     */
+    language_confidence_threshold?: number;
     /**
      * Enable {@link https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection | Automatic language detection }, either true or false.
      */
@@ -2639,7 +2655,7 @@ export type TranscriptOptionalParams = {
      */
     speakers_expected?: number | null;
     /**
-     * The speech model to use for the transcription. When `null`, the default model is used.
+     * The speech model to use for the transcription. When `null`, the "best" model is used.
      * @defaultValue null
      */
     speech_model?: SpeechModel | null;

package/dist/utils/errors/realtime.d.ts

@@ -1,22 +1,36 @@
-declare enum RealtimeErrorType {
-    BadSampleRate = 4000,
-    AuthFailed = 4001,
-    InsufficientFundsOrFreeAccount = 4002,
-    NonexistentSessionId = 4004,
-    SessionExpired = 4008,
-    ClosedSession = 4010,
-    RateLimited = 4029,
-    UniqueSessionViolation = 4030,
-    SessionTimeout = 4031,
-    AudioTooShort = 4032,
-    AudioTooLong = 4033,
-    BadJson = 4100,
-    BadSchema = 4101,
-    TooManyStreams = 4102,
-    Reconnected = 4103,
-    ReconnectAttemptsExhausted = 1013
-}
-declare const RealtimeErrorMessages: Record<RealtimeErrorType, string>;
+declare const RealtimeErrorType: {
+    readonly BadSampleRate: 4000;
+    readonly AuthFailed: 4001;
+    /**
+     * @deprecated Use InsufficientFunds or FreeTierUser instead
+     */
+    readonly InsufficientFundsOrFreeAccount: 4002;
+    readonly InsufficientFunds: 4002;
+    readonly FreeTierUser: 4003;
+    readonly NonexistentSessionId: 4004;
+    readonly SessionExpired: 4008;
+    readonly ClosedSession: 4010;
+    readonly RateLimited: 4029;
+    readonly UniqueSessionViolation: 4030;
+    readonly SessionTimeout: 4031;
+    readonly AudioTooShort: 4032;
+    readonly AudioTooLong: 4033;
+    readonly AudioTooSmallToTranscode: 4034;
+    /**
+     * @deprecated Don't use
+     */
+    readonly BadJson: 4100;
+    readonly BadSchema: 4101;
+    readonly TooManyStreams: 4102;
+    readonly Reconnected: 4103;
+    /**
+     * @deprecated Don't use
+     */
+    readonly ReconnectAttemptsExhausted: 1013;
+    readonly WordBoostParameterParsingFailed: 4104;
+};
+type RealtimeErrorTypeCodes = (typeof RealtimeErrorType)[keyof typeof RealtimeErrorType];
+declare const RealtimeErrorMessages: Record<RealtimeErrorTypeCodes, string>;
 declare class RealtimeError extends Error {
 }
-export { RealtimeError, RealtimeErrorType, RealtimeErrorMessages };
+export { RealtimeError, RealtimeErrorType, RealtimeErrorTypeCodes, RealtimeErrorMessages, };

package/dist/workerd.mjs

@@ -15,7 +15,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.6.1" },
+    sdk: { name: "JavaScript", version: "4.7.0" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -147,30 +147,42 @@ const { WritableStream } = typeof window !== "undefined"
 
 const factory = (url, params) => new ws(url, params);
 
-var RealtimeErrorType;
-(function (RealtimeErrorType) {
-    RealtimeErrorType[RealtimeErrorType["BadSampleRate"] = 4000] = "BadSampleRate";
-    RealtimeErrorType[RealtimeErrorType["AuthFailed"] = 4001] = "AuthFailed";
-    // Both InsufficientFunds and FreeAccount error use 4002
-    RealtimeErrorType[RealtimeErrorType["InsufficientFundsOrFreeAccount"] = 4002] = "InsufficientFundsOrFreeAccount";
-    RealtimeErrorType[RealtimeErrorType["NonexistentSessionId"] = 4004] = "NonexistentSessionId";
-    RealtimeErrorType[RealtimeErrorType["SessionExpired"] = 4008] = "SessionExpired";
-    RealtimeErrorType[RealtimeErrorType["ClosedSession"] = 4010] = "ClosedSession";
-    RealtimeErrorType[RealtimeErrorType["RateLimited"] = 4029] = "RateLimited";
-    RealtimeErrorType[RealtimeErrorType["UniqueSessionViolation"] = 4030] = "UniqueSessionViolation";
-    RealtimeErrorType[RealtimeErrorType["SessionTimeout"] = 4031] = "SessionTimeout";
-    RealtimeErrorType[RealtimeErrorType["AudioTooShort"] = 4032] = "AudioTooShort";
-    RealtimeErrorType[RealtimeErrorType["AudioTooLong"] = 4033] = "AudioTooLong";
-    RealtimeErrorType[RealtimeErrorType["BadJson"] = 4100] = "BadJson";
-    RealtimeErrorType[RealtimeErrorType["BadSchema"] = 4101] = "BadSchema";
-    RealtimeErrorType[RealtimeErrorType["TooManyStreams"] = 4102] = "TooManyStreams";
-    RealtimeErrorType[RealtimeErrorType["Reconnected"] = 4103] = "Reconnected";
-    RealtimeErrorType[RealtimeErrorType["ReconnectAttemptsExhausted"] = 1013] = "ReconnectAttemptsExhausted";
-})(RealtimeErrorType || (RealtimeErrorType = {}));
+const RealtimeErrorType = {
+    BadSampleRate: 4000,
+    AuthFailed: 4001,
+    /**
+     * @deprecated Use InsufficientFunds or FreeTierUser instead
+     */
+    InsufficientFundsOrFreeAccount: 4002,
+    InsufficientFunds: 4002,
+    FreeTierUser: 4003,
+    NonexistentSessionId: 4004,
+    SessionExpired: 4008,
+    ClosedSession: 4010,
+    RateLimited: 4029,
+    UniqueSessionViolation: 4030,
+    SessionTimeout: 4031,
+    AudioTooShort: 4032,
+    AudioTooLong: 4033,
+    AudioTooSmallToTranscode: 4034,
+    /**
+     * @deprecated Don't use
+     */
+    BadJson: 4100,
+    BadSchema: 4101,
+    TooManyStreams: 4102,
+    Reconnected: 4103,
+    /**
+     * @deprecated Don't use
+     */
+    ReconnectAttemptsExhausted: 1013,
+    WordBoostParameterParsingFailed: 4104,
+};
 const RealtimeErrorMessages = {
     [RealtimeErrorType.BadSampleRate]: "Sample rate must be a positive integer",
     [RealtimeErrorType.AuthFailed]: "Not Authorized",
-    [RealtimeErrorType.InsufficientFundsOrFreeAccount]: "Insufficient funds or you are using a free account. This feature is paid-only and requires you to add a credit card. Please visit https://assemblyai.com/dashboard/ to add a credit card to your account.",
+    [RealtimeErrorType.InsufficientFunds]: "Insufficient funds",
+    [RealtimeErrorType.FreeTierUser]: "This feature is paid-only and requires you to add a credit card. Please visit https://app.assemblyai.com/ to add a credit card to your account.",
     [RealtimeErrorType.NonexistentSessionId]: "Session ID does not exist",
     [RealtimeErrorType.SessionExpired]: "Session has expired",
     [RealtimeErrorType.ClosedSession]: "Session is closed",
@@ -179,11 +191,13 @@ const RealtimeErrorMessages = {
     [RealtimeErrorType.SessionTimeout]: "Session Timeout",
     [RealtimeErrorType.AudioTooShort]: "Audio too short",
     [RealtimeErrorType.AudioTooLong]: "Audio too long",
+    [RealtimeErrorType.AudioTooSmallToTranscode]: "Audio too small to transcode",
     [RealtimeErrorType.BadJson]: "Bad JSON",
     [RealtimeErrorType.BadSchema]: "Bad schema",
     [RealtimeErrorType.TooManyStreams]: "Too many streams",
-    [RealtimeErrorType.Reconnected]: "Reconnected",
+    [RealtimeErrorType.Reconnected]: "This session has been reconnected. This WebSocket is no longer valid.",
     [RealtimeErrorType.ReconnectAttemptsExhausted]: "Reconnect attempts exhausted",
+    [RealtimeErrorType.WordBoostParameterParsingFailed]: "Could not parse word boost parameter",
 };
 class RealtimeError extends Error {
 }
@@ -275,7 +289,7 @@ class RealtimeTranscriber {
             };
             this.socket.onclose = ({ code, reason }) => {
                 if (!reason) {
-                    if (code in RealtimeErrorType) {
+                    if (code in RealtimeErrorMessages) {
                         reason = RealtimeErrorMessages[code];
                     }
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.6.1",
+  "version": "4.7.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"

package/src/services/realtime/service.ts

@@ -17,11 +17,8 @@ import {
   AudioData,
   SessionInformation,
 } from "../..";
-import {
-  RealtimeError,
-  RealtimeErrorMessages,
-  RealtimeErrorType,
-} from "../../utils/errors";
+import { RealtimeError, RealtimeErrorMessages } from "../../utils/errors";
+import { RealtimeErrorTypeCodes } from "../../utils/errors/realtime";
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 const forceEndOfUtteranceMessage = `{"force_end_utterance":true}`;
@@ -213,8 +210,8 @@ export class RealtimeTranscriber {
 
       this.socket!.onclose = ({ code, reason }: CloseEvent) => {
         if (!reason) {
-          if (code in RealtimeErrorType) {
-            reason = RealtimeErrorMessages[code as RealtimeErrorType];
+          if (code in RealtimeErrorMessages) {
+            reason = RealtimeErrorMessages[code as RealtimeErrorTypeCodes];
           }
         }
         this.listeners.close?.(code, reason);

package/src/types/openapi.generated.ts

@@ -2406,6 +2406,16 @@ export type Transcript = {
    * The default value is 'en_us'.
    */
   language_code?: LiteralUnion<TranscriptLanguageCode, string>;
+  /**
+   * The confidence score for the detected language, between 0.0 (low confidence) and 1.0 (high confidence)
+   */
+  language_confidence: number | null;
+  /**
+   * The confidence threshold for the automatically detected language.
+   * An error will be returned if the langauge confidence is below this threshold.
+   * Defaults to 0.
+   */
+  language_confidence_threshold: number | null;
   /**
    * Whether {@link https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection | Automatic language detection } is enabled, either true or false
    */
@@ -2542,7 +2552,7 @@ export type Transcript = {
 };
 
 /**
- * The word boost parameter value
+ * How much to boost specified words
  */
 export type TranscriptBoostParam = "low" | "default" | "high";
 
@@ -2823,7 +2833,7 @@ export type TranscriptOptionalParams = {
    */
   auto_highlights?: boolean;
   /**
-   * The word boost parameter value
+   * How much to boost specified words
    */
   boost_param?: TranscriptBoostParam;
   /**
@@ -2871,6 +2881,12 @@ export type TranscriptOptionalParams = {
    * The default value is 'en_us'.
    */
   language_code?: LiteralUnion<TranscriptLanguageCode, string> | null;
+  /**
+   * The confidence threshold for the automatically detected language.
+   * An error will be returned if the langauge confidence is below this threshold.
+   * Defaults to 0.
+   */
+  language_confidence_threshold?: number;
   /**
    * Enable {@link https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection | Automatic language detection }, either true or false.
    */
@@ -2914,7 +2930,7 @@ export type TranscriptOptionalParams = {
    */
   speakers_expected?: number | null;
   /**
-   * The speech model to use for the transcription. When `null`, the default model is used.
+   * The speech model to use for the transcription. When `null`, the "best" model is used.
    * @defaultValue null
    */
   speech_model?: SpeechModel | null;

package/src/utils/errors/realtime.ts

@@ -1,28 +1,44 @@
-enum RealtimeErrorType {
-  BadSampleRate = 4000,
-  AuthFailed = 4001,
-  // Both InsufficientFunds and FreeAccount error use 4002
-  InsufficientFundsOrFreeAccount = 4002,
-  NonexistentSessionId = 4004,
-  SessionExpired = 4008,
-  ClosedSession = 4010,
-  RateLimited = 4029,
-  UniqueSessionViolation = 4030,
-  SessionTimeout = 4031,
-  AudioTooShort = 4032,
-  AudioTooLong = 4033,
-  BadJson = 4100,
-  BadSchema = 4101,
-  TooManyStreams = 4102,
-  Reconnected = 4103,
-  ReconnectAttemptsExhausted = 1013,
-}
+const RealtimeErrorType = {
+  BadSampleRate: 4000,
+  AuthFailed: 4001,
+  /**
+   * @deprecated Use InsufficientFunds or FreeTierUser instead
+   */
+  InsufficientFundsOrFreeAccount: 4002,
+  InsufficientFunds: 4002,
+  FreeTierUser: 4003,
+  NonexistentSessionId: 4004,
+  SessionExpired: 4008,
+  ClosedSession: 4010,
+  RateLimited: 4029,
+  UniqueSessionViolation: 4030,
+  SessionTimeout: 4031,
+  AudioTooShort: 4032,
+  AudioTooLong: 4033,
+  AudioTooSmallToTranscode: 4034,
+  /**
+   * @deprecated Don't use
+   */
+  BadJson: 4100,
+  BadSchema: 4101,
+  TooManyStreams: 4102,
+  Reconnected: 4103,
+  /**
+   * @deprecated Don't use
+   */
+  ReconnectAttemptsExhausted: 1013,
+  WordBoostParameterParsingFailed: 4104,
+} as const;
 
-const RealtimeErrorMessages: Record<RealtimeErrorType, string> = {
+type RealtimeErrorTypeCodes =
+  (typeof RealtimeErrorType)[keyof typeof RealtimeErrorType];
+
+const RealtimeErrorMessages: Record<RealtimeErrorTypeCodes, string> = {
   [RealtimeErrorType.BadSampleRate]: "Sample rate must be a positive integer",
   [RealtimeErrorType.AuthFailed]: "Not Authorized",
-  [RealtimeErrorType.InsufficientFundsOrFreeAccount]:
-    "Insufficient funds or you are using a free account. This feature is paid-only and requires you to add a credit card. Please visit https://assemblyai.com/dashboard/ to add a credit card to your account.",
+  [RealtimeErrorType.InsufficientFunds]: "Insufficient funds",
+  [RealtimeErrorType.FreeTierUser]:
+    "This feature is paid-only and requires you to add a credit card. Please visit https://app.assemblyai.com/ to add a credit card to your account.",
   [RealtimeErrorType.NonexistentSessionId]: "Session ID does not exist",
   [RealtimeErrorType.SessionExpired]: "Session has expired",
   [RealtimeErrorType.ClosedSession]: "Session is closed",
@@ -31,14 +47,23 @@ const RealtimeErrorMessages: Record<RealtimeErrorType, string> = {
   [RealtimeErrorType.SessionTimeout]: "Session Timeout",
   [RealtimeErrorType.AudioTooShort]: "Audio too short",
   [RealtimeErrorType.AudioTooLong]: "Audio too long",
+  [RealtimeErrorType.AudioTooSmallToTranscode]: "Audio too small to transcode",
   [RealtimeErrorType.BadJson]: "Bad JSON",
   [RealtimeErrorType.BadSchema]: "Bad schema",
   [RealtimeErrorType.TooManyStreams]: "Too many streams",
-  [RealtimeErrorType.Reconnected]: "Reconnected",
+  [RealtimeErrorType.Reconnected]:
+    "This session has been reconnected. This WebSocket is no longer valid.",
   [RealtimeErrorType.ReconnectAttemptsExhausted]:
     "Reconnect attempts exhausted",
+  [RealtimeErrorType.WordBoostParameterParsingFailed]:
+    "Could not parse word boost parameter",
 };
 
 class RealtimeError extends Error {}
 
-export { RealtimeError, RealtimeErrorType, RealtimeErrorMessages };
+export {
+  RealtimeError,
+  RealtimeErrorType,
+  RealtimeErrorTypeCodes,
+  RealtimeErrorMessages,
+};