assemblyai 4.2.0 → 4.2.2

package/dist/node.cjs

@@ -129,7 +129,7 @@ class RealtimeError extends Error {
 }
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
-class RealtimeService {
+class RealtimeTranscriber {
     constructor(params) {
         this.listeners = {};
         this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
@@ -270,18 +270,29 @@ class RealtimeService {
         this.socket = undefined;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+class RealtimeService extends RealtimeTranscriber {
+}
 
-class RealtimeServiceFactory extends BaseService {
+class RealtimeTranscriberFactory extends BaseService {
     constructor(params) {
         super(params);
         this.rtFactoryParams = params;
     }
+    /**
+     * @deprecated Use transcriber(...) instead
+     */
     createService(params) {
+        return this.transcriber(params);
+    }
+    transcriber(params) {
         const serviceParams = { ...params };
         if (!serviceParams.token && !serviceParams.apiKey) {
             serviceParams.apiKey = this.rtFactoryParams.apiKey;
         }
-        return new RealtimeService(serviceParams);
+        return new RealtimeTranscriber(serviceParams);
     }
     async createTemporaryToken(params) {
         const data = await this.fetchJson("/v2/realtime/token", {
@@ -291,6 +302,23 @@ class RealtimeServiceFactory extends BaseService {
         return data.token;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+}
+
+function getPath(path) {
+    if (path.startsWith("http"))
+        return null;
+    if (path.startsWith("https"))
+        return null;
+    if (path.startsWith("file://"))
+        return path.substring(7);
+    if (path.startsWith("file:"))
+        return path.substring(5);
+    return path;
+}
 
 class TranscriptService extends BaseService {
     constructor(params, files) {
@@ -476,19 +504,6 @@ class TranscriptService extends BaseService {
         return this.fetchJson(`/v2/transcript/${id}/redacted-audio`);
     }
 }
-function getPath(path) {
-    let url;
-    try {
-        url = new URL(path);
-        if (url.protocol === "file:")
-            return url.pathname;
-        else
-            return null;
-    }
-    catch {
-        return path;
-    }
-}
 
 const readFile = async (path) => stream.Readable.toWeb(fs.createReadStream(path));
 
@@ -529,7 +544,7 @@ class AssemblyAI {
         this.files = new FileService(params);
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);
-        this.realtime = new RealtimeServiceFactory(params);
+        this.realtime = new RealtimeTranscriberFactory(params);
     }
 }
 
@@ -538,4 +553,6 @@ exports.FileService = FileService;
 exports.LemurService = LemurService;
 exports.RealtimeService = RealtimeService;
 exports.RealtimeServiceFactory = RealtimeServiceFactory;
+exports.RealtimeTranscriber = RealtimeTranscriber;
+exports.RealtimeTranscriberFactory = RealtimeTranscriberFactory;
 exports.TranscriptService = TranscriptService;

package/dist/node.mjs

@@ -127,7 +127,7 @@ class RealtimeError extends Error {
 }
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
-class RealtimeService {
+class RealtimeTranscriber {
     constructor(params) {
         this.listeners = {};
         this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
@@ -268,18 +268,29 @@ class RealtimeService {
         this.socket = undefined;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+class RealtimeService extends RealtimeTranscriber {
+}
 
-class RealtimeServiceFactory extends BaseService {
+class RealtimeTranscriberFactory extends BaseService {
     constructor(params) {
         super(params);
         this.rtFactoryParams = params;
     }
+    /**
+     * @deprecated Use transcriber(...) instead
+     */
     createService(params) {
+        return this.transcriber(params);
+    }
+    transcriber(params) {
         const serviceParams = { ...params };
         if (!serviceParams.token && !serviceParams.apiKey) {
             serviceParams.apiKey = this.rtFactoryParams.apiKey;
         }
-        return new RealtimeService(serviceParams);
+        return new RealtimeTranscriber(serviceParams);
     }
     async createTemporaryToken(params) {
         const data = await this.fetchJson("/v2/realtime/token", {
@@ -289,6 +300,23 @@ class RealtimeServiceFactory extends BaseService {
         return data.token;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+}
+
+function getPath(path) {
+    if (path.startsWith("http"))
+        return null;
+    if (path.startsWith("https"))
+        return null;
+    if (path.startsWith("file://"))
+        return path.substring(7);
+    if (path.startsWith("file:"))
+        return path.substring(5);
+    return path;
+}
 
 class TranscriptService extends BaseService {
     constructor(params, files) {
@@ -474,19 +502,6 @@ class TranscriptService extends BaseService {
         return this.fetchJson(`/v2/transcript/${id}/redacted-audio`);
     }
 }
-function getPath(path) {
-    let url;
-    try {
-        url = new URL(path);
-        if (url.protocol === "file:")
-            return url.pathname;
-        else
-            return null;
-    }
-    catch {
-        return path;
-    }
-}
 
 const readFile = async (path) => Readable.toWeb(createReadStream(path));
 
@@ -527,8 +542,8 @@ class AssemblyAI {
         this.files = new FileService(params);
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);
-        this.realtime = new RealtimeServiceFactory(params);
+        this.realtime = new RealtimeTranscriberFactory(params);
     }
 }
 
-export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, TranscriptService };
+export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, RealtimeTranscriber, RealtimeTranscriberFactory, TranscriptService };

package/dist/services/index.d.ts

@@ -1,6 +1,6 @@
 import { BaseServiceParams } from "..";
 import { LemurService } from "./lemur";
-import { RealtimeService, RealtimeServiceFactory } from "./realtime";
+import { RealtimeTranscriber, RealtimeTranscriberFactory, RealtimeService, RealtimeServiceFactory } from "./realtime";
 import { TranscriptService } from "./transcripts";
 import { FileService } from "./files";
 declare class AssemblyAI {
@@ -19,11 +19,11 @@ declare class AssemblyAI {
     /**
      * The realtime service.
      */
-    realtime: RealtimeServiceFactory;
+    realtime: RealtimeTranscriberFactory;
     /**
      * Create a new AssemblyAI client.
      * @param params The parameters for the service, including the API key and base URL, if any.
      */
     constructor(params: BaseServiceParams);
 }
-export { AssemblyAI, LemurService, RealtimeServiceFactory, RealtimeService, TranscriptService, FileService, };
+export { AssemblyAI, LemurService, RealtimeTranscriberFactory, RealtimeTranscriber, RealtimeServiceFactory, RealtimeService, TranscriptService, FileService, };

package/dist/services/realtime/factory.d.ts

@@ -1,9 +1,18 @@
-import { BaseServiceParams, RealtimeTokenParams, CreateRealtimeServiceParams } from "../..";
-import { RealtimeService } from "./service";
+import { BaseServiceParams, RealtimeTokenParams, CreateRealtimeTranscriberParams, CreateRealtimeServiceParams } from "../..";
+import { RealtimeService, RealtimeTranscriber } from "./service";
 import { BaseService } from "../base";
-export declare class RealtimeServiceFactory extends BaseService {
+export declare class RealtimeTranscriberFactory extends BaseService {
     private rtFactoryParams;
     constructor(params: BaseServiceParams);
+    /**
+     * @deprecated Use transcriber(...) instead
+     */
     createService(params?: CreateRealtimeServiceParams): RealtimeService;
+    transcriber(params?: CreateRealtimeTranscriberParams): RealtimeTranscriber;
     createTemporaryToken(params: RealtimeTokenParams): Promise<string>;
 }
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+export declare class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+}

package/dist/services/realtime/service.d.ts

@@ -1,5 +1,5 @@
-import { RealtimeServiceParams, RealtimeTranscript, PartialTranscript, FinalTranscript, SessionBeginsEventData } from "../..";
-export declare class RealtimeService {
+import { RealtimeTranscriberParams, RealtimeTranscript, PartialTranscript, FinalTranscript, SessionBeginsEventData, AudioData } from "../..";
+export declare class RealtimeTranscriber {
     private realtimeUrl;
     private sampleRate;
     private wordBoost?;
@@ -9,7 +9,7 @@ export declare class RealtimeService {
     private socket?;
     private listeners;
     private sessionTerminatedResolve?;
-    constructor(params: RealtimeServiceParams);
+    constructor(params: RealtimeTranscriberParams);
     private connectionUrl;
     on(event: "open", listener: (event: SessionBeginsEventData) => void): void;
     on(event: "transcript", listener: (transcript: RealtimeTranscript) => void): void;
@@ -18,7 +18,12 @@ export declare class RealtimeService {
     on(event: "error", listener: (error: Error) => void): void;
     on(event: "close", listener: (code: number, reason: string) => void): void;
     connect(): Promise<SessionBeginsEventData>;
-    sendAudio(audio: ArrayBufferLike): void;
-    stream(): WritableStream<ArrayBufferLike>;
+    sendAudio(audio: AudioData): void;
+    stream(): WritableStream<AudioData>;
     close(waitForSessionTermination?: boolean): Promise<void>;
 }
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+export declare class RealtimeService extends RealtimeTranscriber {
+}

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

@@ -1,7 +1,8 @@
-export type AudioData = {
-    /** @description Base64 encoded raw audio data */
-    audio_data: string;
-};
+/**
+ * Format: binary
+ * @description Binary audio data
+ */
+export type AudioData = ArrayBufferLike;
 /**
  * @description The encoding of the audio data
  * @default pcm_s16le

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

@@ -425,12 +425,21 @@ export type Error = {
  *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
  *   ],
  *   "context": "This is an interview about wildfires.",
+ *   "answer_format": "Bullet Points",
  *   "final_model": "default",
  *   "temperature": 0,
  *   "max_output_size": 3000
  * }
  */
-export type LemurActionItemsParams = LemurBaseParams;
+export type LemurActionItemsParams = LemurBaseParams & {
+    /**
+     * @description How you want the action items to be returned. This can be any text.
+     * Defaults to "Bullet Points".
+     *
+     * @default Bullet Points
+     */
+    answer_format?: string;
+};
 /**
  * @example {
  *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e",
@@ -825,6 +834,13 @@ export type RedactedAudioResponse = {
  * @enum {string}
  */
 export type RedactedAudioStatus = "redacted_audio_ready";
+/**
+ * @description Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+ * @default mp3
+ * @example mp3
+ * @enum {string}
+ */
+export type RedactPiiAudioQuality = "mp3" | "wav";
 /**
  * @example {
  *   "sentences": [
@@ -1954,7 +1970,7 @@ export type Transcript = {
      * @description The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled.
      * See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.
      */
-    redact_pii_audio_quality?: string | null;
+    redact_pii_audio_quality?: RedactPiiAudioQuality | null;
     /**
      * @description The list of PII Redaction policies that were enabled, if PII Redaction is enabled.
      * See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.
@@ -2097,7 +2113,7 @@ export type TranscriptList = {
  */
 export type TranscriptListItem = {
     audio_url: string;
-    completed?: Date;
+    completed: Date | null;
     created: Date;
     /** Format: uuid */
     id: string;
@@ -2198,7 +2214,7 @@ export type TranscriptOptionalParams = {
      * @description Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
      * @default mp3
      */
-    redact_pii_audio_quality?: string;
+    redact_pii_audio_quality?: RedactPiiAudioQuality;
     /** @description The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. */
     redact_pii_policies?: PiiPolicy[];
     /** @description The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. */

package/dist/types/realtime/index.d.ts

@@ -1,5 +1,5 @@
 import { AudioEncoding, FinalTranscript, PartialTranscript, RealtimeTranscript, RealtimeTranscriptType } from "../asyncapi.generated";
-type CreateRealtimeServiceParams = {
+type CreateRealtimeTranscriberParams = {
     realtimeUrl?: string;
     sampleRate?: number;
     wordBoost?: string[];
@@ -9,7 +9,11 @@ type CreateRealtimeServiceParams = {
 } | {
     token: string;
 });
-type RealtimeServiceParams = {
+/**
+ * @deprecated Use CreateRealtimeTranscriberParams instead
+ */
+type CreateRealtimeServiceParams = CreateRealtimeTranscriberParams;
+type RealtimeTranscriberParams = {
     realtimeUrl?: string;
     sampleRate?: number;
     wordBoost?: string[];
@@ -19,6 +23,10 @@ type RealtimeServiceParams = {
 } | {
     token: string;
 });
+/**
+ * @deprecated Use RealtimeTranscriberParams instead
+ */
+type RealtimeServiceParams = RealtimeTranscriberParams;
 type RealtimeEvents = "open" | "close" | "transcript" | "transcript.partial" | "transcript.final" | "error";
 type SessionBeginsEventData = {
     sessionId: string;
@@ -35,4 +43,4 @@ type RealtimeListeners = {
 type RealtimeTokenParams = {
     expires_in: number;
 };
-export type { CreateRealtimeServiceParams, RealtimeServiceParams, RealtimeEvents, RealtimeTranscriptType, SessionBeginsEventData, RealtimeListeners, RealtimeTokenParams, };
+export type { CreateRealtimeTranscriberParams, RealtimeTranscriberParams, CreateRealtimeServiceParams, RealtimeServiceParams, RealtimeEvents, RealtimeTranscriptType, SessionBeginsEventData, RealtimeListeners, RealtimeTokenParams, };

package/dist/utils/path.d.ts

@@ -0,0 +1 @@
+export declare function getPath(path: string): string | null;

package/docs/compat.md

@@ -13,7 +13,7 @@ If you do use an older version of Node.js like version 16, you'll need to polyfi
 To make the SDK compatible with the browser, the SDK aims to use web standards as much as possible.
 However, there are still incompatibilities between Node.js and the browser.
 
-- `RealtimeService` doesn't support the AssemblyAI API key in the browser.
+- `RealtimeTranscriber` doesn't support the AssemblyAI API key in the browser.
   Instead, you have to generate a temporary auth token using `client.realtime.createTemporaryToken`, and pass in the resulting token to the real-time transcriber.
 
   Generate a temporary auth token on the server.
@@ -31,16 +31,16 @@ However, there are still incompatibilities between Node.js and the browser.
   > If you embed the API key on the client, everyone can see it and use it for themselves.
 
   Then pass the token via an API to the client.
-  On the client, create an instance of `RealtimeService` using the token.
+  On the client, create an instance of `RealtimeTranscriber` using the token.
 
   ```js
-  import { RealtimeService } from "assemblyai";
+  import { RealtimeTranscriber } from "assemblyai";
   // or the following if you're using UMD
-  // const { RealtimeService } = assemblyai;
+  // const { RealtimeTranscriber } = assemblyai;
 
   const token = getToken(); // getToken is a function for you to implement
 
-  const rt = new RealtimeService({
+  const rt = new RealtimeTranscriber({
     token: token,
   });
   ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.2.0",
+  "version": "4.2.2",
   "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/index.ts

@@ -1,6 +1,11 @@
 import { BaseServiceParams } from "..";
 import { LemurService } from "./lemur";
-import { RealtimeService, RealtimeServiceFactory } from "./realtime";
+import {
+  RealtimeTranscriber,
+  RealtimeTranscriberFactory,
+  RealtimeService,
+  RealtimeServiceFactory,
+} from "./realtime";
 import { TranscriptService } from "./transcripts";
 import { FileService } from "./files";
 
@@ -25,7 +30,7 @@ class AssemblyAI {
   /**
    * The realtime service.
    */
-  public realtime: RealtimeServiceFactory;
+  public realtime: RealtimeTranscriberFactory;
 
   /**
    * Create a new AssemblyAI client.
@@ -38,13 +43,15 @@ class AssemblyAI {
     this.files = new FileService(params);
     this.transcripts = new TranscriptService(params, this.files);
     this.lemur = new LemurService(params);
-    this.realtime = new RealtimeServiceFactory(params);
+    this.realtime = new RealtimeTranscriberFactory(params);
   }
 }
 
 export {
   AssemblyAI,
   LemurService,
+  RealtimeTranscriberFactory,
+  RealtimeTranscriber,
   RealtimeServiceFactory,
   RealtimeService,
   TranscriptService,

package/src/services/realtime/factory.ts

@@ -1,27 +1,35 @@
 import {
   BaseServiceParams,
   RealtimeTokenParams,
-  CreateRealtimeServiceParams,
-  RealtimeServiceParams,
+  CreateRealtimeTranscriberParams,
+  RealtimeTranscriberParams,
   RealtimeTemporaryTokenResponse,
+  CreateRealtimeServiceParams,
 } from "../..";
-import { RealtimeService } from "./service";
+import { RealtimeService, RealtimeTranscriber } from "./service";
 import { BaseService } from "../base";
 
-export class RealtimeServiceFactory extends BaseService {
+export class RealtimeTranscriberFactory extends BaseService {
   private rtFactoryParams: BaseServiceParams;
   constructor(params: BaseServiceParams) {
     super(params);
     this.rtFactoryParams = params;
   }
 
+  /**
+   * @deprecated Use transcriber(...) instead
+   */
   createService(params?: CreateRealtimeServiceParams): RealtimeService {
+    return this.transcriber(params);
+  }
+
+  transcriber(params?: CreateRealtimeTranscriberParams): RealtimeTranscriber {
     const serviceParams = { ...params } as Record<string, unknown>;
     if (!serviceParams.token && !serviceParams.apiKey) {
       serviceParams.apiKey = this.rtFactoryParams.apiKey;
     }
 
-    return new RealtimeService(serviceParams as RealtimeServiceParams);
+    return new RealtimeTranscriber(serviceParams as RealtimeTranscriberParams);
   }
 
   async createTemporaryToken(params: RealtimeTokenParams) {
@@ -35,3 +43,8 @@ export class RealtimeServiceFactory extends BaseService {
     return data.token;
   }
 }
+
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+export class RealtimeServiceFactory extends RealtimeTranscriberFactory {}

package/src/services/realtime/service.ts

@@ -4,13 +4,14 @@ import { ErrorEvent, MessageEvent, CloseEvent } from "ws";
 import {
   RealtimeEvents,
   RealtimeListeners,
-  RealtimeServiceParams,
+  RealtimeTranscriberParams,
   RealtimeMessage,
   RealtimeTranscript,
   PartialTranscript,
   FinalTranscript,
   SessionBeginsEventData,
   AudioEncoding,
+  AudioData,
 } from "../..";
 import {
   RealtimeError,
@@ -20,7 +21,7 @@ import {
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 
-export class RealtimeService {
+export class RealtimeTranscriber {
   private realtimeUrl: string;
   private sampleRate: number;
   private wordBoost?: string[];
@@ -31,7 +32,7 @@ export class RealtimeService {
   private listeners: RealtimeListeners = {};
   private sessionTerminatedResolve?: () => void;
 
-  constructor(params: RealtimeServiceParams) {
+  constructor(params: RealtimeTranscriberParams) {
     this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
     this.sampleRate = params.sampleRate ?? 16_000;
     this.wordBoost = params.wordBoost;
@@ -157,16 +158,16 @@ export class RealtimeService {
     });
   }
 
-  sendAudio(audio: ArrayBufferLike) {
+  sendAudio(audio: AudioData) {
     if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
       throw new Error("Socket is not open for communication");
     }
     this.socket.send(audio);
   }
 
-  stream(): WritableStream<ArrayBufferLike> {
-    return new WritableStream<ArrayBufferLike>({
-      write: (chunk: ArrayBufferLike) => {
+  stream(): WritableStream<AudioData> {
+    return new WritableStream<AudioData>({
+      write: (chunk: AudioData) => {
         this.sendAudio(chunk);
       },
     });
@@ -194,3 +195,8 @@ export class RealtimeService {
     this.socket = undefined;
   }
 }
+
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+export class RealtimeService extends RealtimeTranscriber {}

package/src/services/transcripts/index.ts

@@ -21,6 +21,7 @@ import {
   SubmitParams,
 } from "../..";
 import { FileService } from "../files";
+import { getPath } from "../../utils/path";
 
 export class TranscriptService
   extends BaseService
@@ -249,14 +250,3 @@ export class TranscriptService
     );
   }
 }
-
-function getPath(path: string) {
-  let url: URL;
-  try {
-    url = new URL(path);
-    if (url.protocol === "file:") return url.pathname;
-    else return null;
-  } catch {
-    return path;
-  }
-}

package/src/types/asyncapi.generated.ts

@@ -15,10 +15,11 @@ type OneOf<T extends any[]> = T extends [infer Only]
   ? OneOf<[XOR<A, B>, ...Rest]>
   : never;
 
-export type AudioData = {
-  /** @description Base64 encoded raw audio data */
-  audio_data: string;
-};
+/**
+ * Format: binary
+ * @description Binary audio data
+ */
+export type AudioData = ArrayBufferLike;
 
 /**
  * @description The encoding of the audio data