assemblyai 4.5.0-beta.0 → 4.6.0

package/dist/node.cjs

@@ -5,6 +5,45 @@ var ws = require('ws');
 var fs = require('fs');
 var stream = require('stream');
 
+const DEFAULT_FETCH_INIT = {
+    cache: "no-store",
+};
+
+const buildUserAgent = (userAgent) => defaultUserAgentString +
+    (userAgent === false
+        ? ""
+        : " AssemblyAI/1.0 (" +
+            Object.entries({ ...defaultUserAgent, ...userAgent })
+                .map(([key, item]) => item ? `${key}=${item.name}/${item.version}` : "")
+                .join(" ") +
+            ")");
+let defaultUserAgentString = "";
+if (typeof navigator !== "undefined" && navigator.userAgent) {
+    defaultUserAgentString += navigator.userAgent;
+}
+const defaultUserAgent = {
+    sdk: { name: "JavaScript", version: "4.6.0" },
+};
+if (typeof process !== "undefined") {
+    if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
+        defaultUserAgent.runtime_env = {
+            name: "Node",
+            version: process.versions.node,
+        };
+    }
+    if (process.versions.bun && defaultUserAgentString.indexOf("Bun") === -1) {
+        defaultUserAgent.runtime_env = {
+            name: "Bun",
+            version: process.versions.bun,
+        };
+    }
+}
+if (typeof Deno !== "undefined") {
+    if (process.versions.bun && defaultUserAgentString.indexOf("Deno") === -1) {
+        defaultUserAgent.runtime_env = { name: "Deno", version: Deno.version.deno };
+    }
+}
+
 /**
  * Base class for services that communicate with the API.
  */
@@ -15,15 +54,32 @@ class BaseService {
      */
     constructor(params) {
         this.params = params;
+        if (params.userAgent === false) {
+            this.userAgent = undefined;
+        }
+        else {
+            this.userAgent = buildUserAgent(params.userAgent || {});
+        }
     }
     async fetch(input, init) {
-        init = init ?? {};
-        init.headers = init.headers ?? {};
-        init.headers = {
+        init = { ...DEFAULT_FETCH_INIT, ...init };
+        let headers = {
             Authorization: this.params.apiKey,
             "Content-Type": "application/json",
-            ...init.headers,
         };
+        if (DEFAULT_FETCH_INIT?.headers)
+            headers = { ...headers, ...DEFAULT_FETCH_INIT.headers };
+        if (init?.headers)
+            headers = { ...headers, ...init.headers };
+        if (this.userAgent) {
+            headers["User-Agent"] = this.userAgent;
+            // chromium browsers have a bug where the user agent can't be modified
+            if (typeof window !== "undefined" && "chrome" in window) {
+                headers["AssemblyAI-Agent"] =
+                    this.userAgent;
+            }
+        }
+        init.headers = headers;
         if (!input.startsWith("http"))
             input = this.params.baseUrl + input;
         const response = await fetch(input, init);
@@ -76,6 +132,9 @@ class LemurService extends BaseService {
             body: JSON.stringify(params),
         });
     }
+    getResponse(id) {
+        return this.fetchJson(`/lemur/v3/${id}`);
+    }
     /**
      * Delete the data for a previously submitted LeMUR request.
      * @param id - ID of the LeMUR request
@@ -133,7 +192,14 @@ class RealtimeError extends Error {
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 const forceEndOfUtteranceMessage = `{"force_end_utterance":true}`;
 const terminateSessionMessage = `{"terminate_session":true}`;
+/**
+ * RealtimeTranscriber connects to the Streaming Speech-to-Text API and lets you transcribe audio in real-time.
+ */
 class RealtimeTranscriber {
+    /**
+     * Create a new RealtimeTranscriber.
+     * @param params - Parameters to configure the RealtimeTranscriber
+     */
     constructor(params) {
         this.listeners = {};
         this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
@@ -173,10 +239,19 @@ class RealtimeTranscriber {
         url.search = searchParams.toString();
         return url;
     }
+    /**
+     * Add a listener for an event.
+     * @param event - The event to listen for.
+     * @param listener - The function to call when the event is emitted.
+     */
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     on(event, listener) {
         this.listeners[event] = listener;
     }
+    /**
+     * Connect to the server and begin a new session.
+     * @returns A promise that resolves when the connection is established and the session begins.
+     */
     connect() {
         return new Promise((resolve) => {
             if (this.socket) {
@@ -255,9 +330,17 @@ class RealtimeTranscriber {
             };
         });
     }
+    /**
+     * Send audio data to the server.
+     * @param audio - The audio data to send to the server.
+     */
     sendAudio(audio) {
         this.send(audio);
     }
+    /**
+     * Create a writable stream that can be used to send audio data to the server.
+     * @returns A writable stream that can be used to send audio data to the server.
+     */
     stream() {
         return new web.WritableStream({
             write: (chunk) => {
@@ -285,6 +368,11 @@ class RealtimeTranscriber {
         }
         this.socket.send(data);
     }
+    /**
+     * Close the connection to the server.
+     * @param waitForSessionTermination - If true, the method will wait for the session to be terminated before closing the connection.
+     * While waiting for the session to be terminated, you will receive the final transcript and session information.
+     */
     async close(waitForSessionTermination = true) {
         if (this.socket) {
             if (this.socket.readyState === this.socket.OPEN) {
@@ -350,6 +438,8 @@ function getPath(path) {
         return null;
     if (path.startsWith("https"))
         return null;
+    if (path.startsWith("data:"))
+        return null;
     if (path.startsWith("file://"))
         return path.substring(7);
     if (path.startsWith("file:"))
@@ -391,8 +481,13 @@ class TranscriptService extends BaseService {
                     audioUrl = await this.files.upload(path);
                 }
                 else {
-                    // audio is not a local path, assume it's a URL
-                    audioUrl = audio;
+                    if (audio.startsWith("data:")) {
+                        audioUrl = await this.files.upload(audio);
+                    }
+                    else {
+                        // audio is not a local path, and not a data-URI, assume it's a normal URL
+                        audioUrl = audio;
+                    }
                 }
             }
             else {
@@ -543,13 +638,43 @@ class TranscriptService extends BaseService {
         return await response.text();
     }
     /**
-     * Retrieve redactions of a transcript.
+     * Retrieve the redacted audio URL of a transcript.
      * @param id - The identifier of the transcript.
-     * @returns A promise that resolves to the subtitles text.
+     * @returns A promise that resolves to the details of the redacted audio.
+     * @deprecated Use `redactedAudio` instead.
      */
     redactions(id) {
+        return this.redactedAudio(id);
+    }
+    /**
+     * Retrieve the redacted audio URL of a transcript.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the details of the redacted audio.
+     */
+    redactedAudio(id) {
         return this.fetchJson(`/v2/transcript/${id}/redacted-audio`);
     }
+    /**
+     * Retrieve the redacted audio file of a transcript.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the fetch HTTP response of the redacted audio file.
+     */
+    async redactedAudioFile(id) {
+        const { redacted_audio_url, status } = await this.redactedAudio(id);
+        if (status !== "redacted_audio_ready") {
+            throw new Error(`Redacted audio status is ${status}`);
+        }
+        const response = await fetch(redacted_audio_url);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch redacted audio: ${response.statusText}`);
+        }
+        return {
+            arrayBuffer: response.arrayBuffer.bind(response),
+            blob: response.blob.bind(response),
+            body: response.body,
+            bodyUsed: response.bodyUsed,
+        };
+    }
 }
 function deprecateConformer2(params) {
     if (!params)
@@ -569,8 +694,14 @@ class FileService extends BaseService {
      */
     async upload(input) {
         let fileData;
-        if (typeof input === "string")
-            fileData = await readFile(input);
+        if (typeof input === "string") {
+            if (input.startsWith("data:")) {
+                fileData = dataUrlToBlob(input);
+            }
+            else {
+                fileData = await readFile(input);
+            }
+        }
         else
             fileData = input;
         const data = await this.fetchJson("/v2/upload", {
@@ -584,6 +715,17 @@ class FileService extends BaseService {
         return data.upload_url;
     }
 }
+function dataUrlToBlob(dataUrl) {
+    const arr = dataUrl.split(",");
+    const mime = arr[0].match(/:(.*?);/)[1];
+    const bstr = atob(arr[1]);
+    let n = bstr.length;
+    const u8arr = new Uint8Array(n);
+    while (n--) {
+        u8arr[n] = bstr.charCodeAt(n);
+    }
+    return new Blob([u8arr], { type: mime });
+}
 
 const defaultBaseUrl = "https://api.assemblyai.com";
 class AssemblyAI {
@@ -593,8 +735,9 @@ class AssemblyAI {
      */
     constructor(params) {
         params.baseUrl = params.baseUrl || defaultBaseUrl;
-        if (params.baseUrl && params.baseUrl.endsWith("/"))
+        if (params.baseUrl && params.baseUrl.endsWith("/")) {
             params.baseUrl = params.baseUrl.slice(0, -1);
+        }
         this.files = new FileService(params);
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);

package/dist/node.mjs

@@ -3,6 +3,45 @@ import ws from 'ws';
 import { createReadStream } from 'fs';
 import { Readable } from 'stream';
 
+const DEFAULT_FETCH_INIT = {
+    cache: "no-store",
+};
+
+const buildUserAgent = (userAgent) => defaultUserAgentString +
+    (userAgent === false
+        ? ""
+        : " AssemblyAI/1.0 (" +
+            Object.entries({ ...defaultUserAgent, ...userAgent })
+                .map(([key, item]) => item ? `${key}=${item.name}/${item.version}` : "")
+                .join(" ") +
+            ")");
+let defaultUserAgentString = "";
+if (typeof navigator !== "undefined" && navigator.userAgent) {
+    defaultUserAgentString += navigator.userAgent;
+}
+const defaultUserAgent = {
+    sdk: { name: "JavaScript", version: "4.6.0" },
+};
+if (typeof process !== "undefined") {
+    if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
+        defaultUserAgent.runtime_env = {
+            name: "Node",
+            version: process.versions.node,
+        };
+    }
+    if (process.versions.bun && defaultUserAgentString.indexOf("Bun") === -1) {
+        defaultUserAgent.runtime_env = {
+            name: "Bun",
+            version: process.versions.bun,
+        };
+    }
+}
+if (typeof Deno !== "undefined") {
+    if (process.versions.bun && defaultUserAgentString.indexOf("Deno") === -1) {
+        defaultUserAgent.runtime_env = { name: "Deno", version: Deno.version.deno };
+    }
+}
+
 /**
  * Base class for services that communicate with the API.
  */
@@ -13,15 +52,32 @@ class BaseService {
      */
     constructor(params) {
         this.params = params;
+        if (params.userAgent === false) {
+            this.userAgent = undefined;
+        }
+        else {
+            this.userAgent = buildUserAgent(params.userAgent || {});
+        }
     }
     async fetch(input, init) {
-        init = init ?? {};
-        init.headers = init.headers ?? {};
-        init.headers = {
+        init = { ...DEFAULT_FETCH_INIT, ...init };
+        let headers = {
             Authorization: this.params.apiKey,
             "Content-Type": "application/json",
-            ...init.headers,
         };
+        if (DEFAULT_FETCH_INIT?.headers)
+            headers = { ...headers, ...DEFAULT_FETCH_INIT.headers };
+        if (init?.headers)
+            headers = { ...headers, ...init.headers };
+        if (this.userAgent) {
+            headers["User-Agent"] = this.userAgent;
+            // chromium browsers have a bug where the user agent can't be modified
+            if (typeof window !== "undefined" && "chrome" in window) {
+                headers["AssemblyAI-Agent"] =
+                    this.userAgent;
+            }
+        }
+        init.headers = headers;
         if (!input.startsWith("http"))
             input = this.params.baseUrl + input;
         const response = await fetch(input, init);
@@ -74,6 +130,9 @@ class LemurService extends BaseService {
             body: JSON.stringify(params),
         });
     }
+    getResponse(id) {
+        return this.fetchJson(`/lemur/v3/${id}`);
+    }
     /**
      * Delete the data for a previously submitted LeMUR request.
      * @param id - ID of the LeMUR request
@@ -131,7 +190,14 @@ class RealtimeError extends Error {
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 const forceEndOfUtteranceMessage = `{"force_end_utterance":true}`;
 const terminateSessionMessage = `{"terminate_session":true}`;
+/**
+ * RealtimeTranscriber connects to the Streaming Speech-to-Text API and lets you transcribe audio in real-time.
+ */
 class RealtimeTranscriber {
+    /**
+     * Create a new RealtimeTranscriber.
+     * @param params - Parameters to configure the RealtimeTranscriber
+     */
     constructor(params) {
         this.listeners = {};
         this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
@@ -171,10 +237,19 @@ class RealtimeTranscriber {
         url.search = searchParams.toString();
         return url;
     }
+    /**
+     * Add a listener for an event.
+     * @param event - The event to listen for.
+     * @param listener - The function to call when the event is emitted.
+     */
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     on(event, listener) {
         this.listeners[event] = listener;
     }
+    /**
+     * Connect to the server and begin a new session.
+     * @returns A promise that resolves when the connection is established and the session begins.
+     */
     connect() {
         return new Promise((resolve) => {
             if (this.socket) {
@@ -253,9 +328,17 @@ class RealtimeTranscriber {
             };
         });
     }
+    /**
+     * Send audio data to the server.
+     * @param audio - The audio data to send to the server.
+     */
     sendAudio(audio) {
         this.send(audio);
     }
+    /**
+     * Create a writable stream that can be used to send audio data to the server.
+     * @returns A writable stream that can be used to send audio data to the server.
+     */
     stream() {
         return new WritableStream({
             write: (chunk) => {
@@ -283,6 +366,11 @@ class RealtimeTranscriber {
         }
         this.socket.send(data);
     }
+    /**
+     * Close the connection to the server.
+     * @param waitForSessionTermination - If true, the method will wait for the session to be terminated before closing the connection.
+     * While waiting for the session to be terminated, you will receive the final transcript and session information.
+     */
     async close(waitForSessionTermination = true) {
         if (this.socket) {
             if (this.socket.readyState === this.socket.OPEN) {
@@ -348,6 +436,8 @@ function getPath(path) {
         return null;
     if (path.startsWith("https"))
         return null;
+    if (path.startsWith("data:"))
+        return null;
     if (path.startsWith("file://"))
         return path.substring(7);
     if (path.startsWith("file:"))
@@ -389,8 +479,13 @@ class TranscriptService extends BaseService {
                     audioUrl = await this.files.upload(path);
                 }
                 else {
-                    // audio is not a local path, assume it's a URL
-                    audioUrl = audio;
+                    if (audio.startsWith("data:")) {
+                        audioUrl = await this.files.upload(audio);
+                    }
+                    else {
+                        // audio is not a local path, and not a data-URI, assume it's a normal URL
+                        audioUrl = audio;
+                    }
                 }
             }
             else {
@@ -541,13 +636,43 @@ class TranscriptService extends BaseService {
         return await response.text();
     }
     /**
-     * Retrieve redactions of a transcript.
+     * Retrieve the redacted audio URL of a transcript.
      * @param id - The identifier of the transcript.
-     * @returns A promise that resolves to the subtitles text.
+     * @returns A promise that resolves to the details of the redacted audio.
+     * @deprecated Use `redactedAudio` instead.
      */
     redactions(id) {
+        return this.redactedAudio(id);
+    }
+    /**
+     * Retrieve the redacted audio URL of a transcript.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the details of the redacted audio.
+     */
+    redactedAudio(id) {
         return this.fetchJson(`/v2/transcript/${id}/redacted-audio`);
     }
+    /**
+     * Retrieve the redacted audio file of a transcript.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the fetch HTTP response of the redacted audio file.
+     */
+    async redactedAudioFile(id) {
+        const { redacted_audio_url, status } = await this.redactedAudio(id);
+        if (status !== "redacted_audio_ready") {
+            throw new Error(`Redacted audio status is ${status}`);
+        }
+        const response = await fetch(redacted_audio_url);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch redacted audio: ${response.statusText}`);
+        }
+        return {
+            arrayBuffer: response.arrayBuffer.bind(response),
+            blob: response.blob.bind(response),
+            body: response.body,
+            bodyUsed: response.bodyUsed,
+        };
+    }
 }
 function deprecateConformer2(params) {
     if (!params)
@@ -567,8 +692,14 @@ class FileService extends BaseService {
      */
     async upload(input) {
         let fileData;
-        if (typeof input === "string")
-            fileData = await readFile(input);
+        if (typeof input === "string") {
+            if (input.startsWith("data:")) {
+                fileData = dataUrlToBlob(input);
+            }
+            else {
+                fileData = await readFile(input);
+            }
+        }
         else
             fileData = input;
         const data = await this.fetchJson("/v2/upload", {
@@ -582,6 +713,17 @@ class FileService extends BaseService {
         return data.upload_url;
     }
 }
+function dataUrlToBlob(dataUrl) {
+    const arr = dataUrl.split(",");
+    const mime = arr[0].match(/:(.*?);/)[1];
+    const bstr = atob(arr[1]);
+    let n = bstr.length;
+    const u8arr = new Uint8Array(n);
+    while (n--) {
+        u8arr[n] = bstr.charCodeAt(n);
+    }
+    return new Blob([u8arr], { type: mime });
+}
 
 const defaultBaseUrl = "https://api.assemblyai.com";
 class AssemblyAI {
@@ -591,8 +733,9 @@ class AssemblyAI {
      */
     constructor(params) {
         params.baseUrl = params.baseUrl || defaultBaseUrl;
-        if (params.baseUrl && params.baseUrl.endsWith("/"))
+        if (params.baseUrl && params.baseUrl.endsWith("/")) {
             params.baseUrl = params.baseUrl.slice(0, -1);
+        }
         this.files = new FileService(params);
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);

package/dist/polyfills/fetch/default.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_FETCH_INIT: Record<string, unknown>;

package/dist/polyfills/fetch/workerd.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_FETCH_INIT: Record<string, unknown>;

package/dist/services/base.d.ts

@@ -4,6 +4,7 @@ import { BaseServiceParams } from "..";
  */
 export declare abstract class BaseService {
     private params;
+    private userAgent;
     /**
      * Create a new service.
      * @param params - The parameters to use for the service.

package/dist/services/lemur/index.d.ts

@@ -1,10 +1,17 @@
-import { LemurSummaryParams, LemurActionItemsParams, LemurQuestionAnswerParams, LemurTaskParams, LemurSummaryResponse, LemurQuestionAnswerResponse, LemurActionItemsResponse, LemurTaskResponse, PurgeLemurRequestDataResponse } from "../..";
+import { LemurSummaryParams, LemurActionItemsParams, LemurQuestionAnswerParams, LemurTaskParams, LemurSummaryResponse, LemurQuestionAnswerResponse, LemurActionItemsResponse, LemurTaskResponse, PurgeLemurRequestDataResponse, LemurResponse } from "../..";
 import { BaseService } from "../base";
 export declare class LemurService extends BaseService {
     summary(params: LemurSummaryParams): Promise<LemurSummaryResponse>;
     questionAnswer(params: LemurQuestionAnswerParams): Promise<LemurQuestionAnswerResponse>;
     actionItems(params: LemurActionItemsParams): Promise<LemurActionItemsResponse>;
     task(params: LemurTaskParams): Promise<LemurTaskResponse>;
+    /**
+     * Retrieve a LeMUR response that was previously generated.
+     * @param id - The ID of the LeMUR request you previously made. This would be found in the response of the original request.
+     * @returns The LeMUR response.
+     */
+    getResponse<T extends LemurResponse>(id: string): Promise<T>;
+    getResponse(id: string): Promise<LemurResponse>;
     /**
      * Delete the data for a previously submitted LeMUR request.
      * @param id - ID of the LeMUR request

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

@@ -1,4 +1,7 @@
 import { RealtimeTranscriberParams, RealtimeTranscript, PartialTranscript, FinalTranscript, SessionBeginsEventData, AudioData, SessionInformation } from "../..";
+/**
+ * RealtimeTranscriber connects to the Streaming Speech-to-Text API and lets you transcribe audio in real-time.
+ */
 export declare class RealtimeTranscriber {
     private realtimeUrl;
     private sampleRate;
@@ -11,17 +14,69 @@ export declare class RealtimeTranscriber {
     private socket?;
     private listeners;
     private sessionTerminatedResolve?;
+    /**
+     * Create a new RealtimeTranscriber.
+     * @param params - Parameters to configure the RealtimeTranscriber
+     */
     constructor(params: RealtimeTranscriberParams);
     private connectionUrl;
+    /**
+     * Listen for the open event which is emitted when the connection is established and the session begins.
+     * @param event - The open event.
+     * @param listener - The function to call when the event is emitted.
+     */
     on(event: "open", listener: (event: SessionBeginsEventData) => void): void;
+    /**
+     * Listen for the transcript event which is emitted when a partian or final transcript is received.
+     * @param event - The transcript event.
+     * @param listener - The function to call when the event is emitted.
+     */
     on(event: "transcript", listener: (transcript: RealtimeTranscript) => void): void;
+    /**
+     * Listen for the partial transcript event which is emitted when a partial transcript is received.
+     * @param event - The partial transcript event.
+     * @param listener - The function to call when the event is emitted.
+     */
     on(event: "transcript.partial", listener: (transcript: PartialTranscript) => void): void;
+    /**
+     * Listen for the final transcript event which is emitted when a final transcript is received.
+     * @param event - The final transcript event.
+     * @param listener - The function to call when the event is emitted.
+     */
     on(event: "transcript.final", listener: (transcript: FinalTranscript) => void): void;
+    /**
+     * Listen for the session information event which is emitted when session information is received.
+     * The session information is sent right before the session is terminated.
+     * @param event - The session information event.
+     * @param listener - The function to call when the event is emitted.
+     */
     on(event: "session_information", listener: (info: SessionInformation) => void): void;
+    /**
+     * Listen for the error event which is emitted when an error occurs.
+     * @param event - The error event.
+     * @param listener - The function to call when the event is emitted.
+     */
     on(event: "error", listener: (error: Error) => void): void;
+    /**
+     * Listen for the close event which is emitted when the connection is closed.
+     * @param event - The close event.
+     * @param listener - The function to call when the event is emitted.
+     */
     on(event: "close", listener: (code: number, reason: string) => void): void;
+    /**
+     * Connect to the server and begin a new session.
+     * @returns A promise that resolves when the connection is established and the session begins.
+     */
     connect(): Promise<SessionBeginsEventData>;
+    /**
+     * Send audio data to the server.
+     * @param audio - The audio data to send to the server.
+     */
     sendAudio(audio: AudioData): void;
+    /**
+     * Create a writable stream that can be used to send audio data to the server.
+     * @returns A writable stream that can be used to send audio data to the server.
+     */
     stream(): WritableStream<AudioData>;
     /**
      * Manually end an utterance
@@ -34,6 +89,11 @@ export declare class RealtimeTranscriber {
      */
     configureEndUtteranceSilenceThreshold(threshold: number): void;
     private send;
+    /**
+     * Close the connection to the server.
+     * @param waitForSessionTermination - If true, the method will wait for the session to be terminated before closing the connection.
+     * While waiting for the session to be terminated, you will receive the final transcript and session information.
+     */
     close(waitForSessionTermination?: boolean): Promise<void>;
 }
 /**