assemblyai 4.5.0 → 4.6.1

package/dist/index.cjs

@@ -63,7 +63,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.5.0" },
+    sdk: { name: "JavaScript", version: "4.6.1" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -243,7 +243,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) {
         var _a, _b;
         this.listeners = {};
@@ -284,10 +291,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) {
@@ -369,9 +385,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) => {
@@ -399,6 +423,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.
+     */
     close() {
         return __awaiter(this, arguments, void 0, function* (waitForSessionTermination = true) {
             var _a;
@@ -491,7 +520,6 @@ class TranscriptService extends BaseService {
      */
     transcribe(params, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            deprecateConformer2(params);
             const transcript = yield this.submit(params);
             return yield this.waitUntilReady(transcript.id, options);
         });
@@ -503,7 +531,6 @@ class TranscriptService extends BaseService {
      */
     submit(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            deprecateConformer2(params);
             let audioUrl;
             let transcriptParams = undefined;
             if ("audio" in params) {
@@ -550,7 +577,6 @@ class TranscriptService extends BaseService {
     create(params, options) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            deprecateConformer2(params);
             const path = getPath(params.audio_url);
             if (path !== null) {
                 const uploadUrl = yield this.files.upload(path);
@@ -726,13 +752,6 @@ class TranscriptService extends BaseService {
         });
     }
 }
-function deprecateConformer2(params) {
-    if (!params)
-        return;
-    if (params.speech_model === "conformer-2") {
-        console.warn("The speech_model conformer-2 option is deprecated and will stop working in the near future. Use best or nano instead.");
-    }
-}
 
 const readFile = function (
 // eslint-disable-next-line @typescript-eslint/no-unused-vars

package/dist/index.mjs

@@ -61,7 +61,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.5.0" },
+    sdk: { name: "JavaScript", version: "4.6.1" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -241,7 +241,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) {
         var _a, _b;
         this.listeners = {};
@@ -282,10 +289,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) {
@@ -367,9 +383,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) => {
@@ -397,6 +421,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.
+     */
     close() {
         return __awaiter(this, arguments, void 0, function* (waitForSessionTermination = true) {
             var _a;
@@ -489,7 +518,6 @@ class TranscriptService extends BaseService {
      */
     transcribe(params, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            deprecateConformer2(params);
             const transcript = yield this.submit(params);
             return yield this.waitUntilReady(transcript.id, options);
         });
@@ -501,7 +529,6 @@ class TranscriptService extends BaseService {
      */
     submit(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            deprecateConformer2(params);
             let audioUrl;
             let transcriptParams = undefined;
             if ("audio" in params) {
@@ -548,7 +575,6 @@ class TranscriptService extends BaseService {
     create(params, options) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            deprecateConformer2(params);
             const path = getPath(params.audio_url);
             if (path !== null) {
                 const uploadUrl = yield this.files.upload(path);
@@ -724,13 +750,6 @@ class TranscriptService extends BaseService {
         });
     }
 }
-function deprecateConformer2(params) {
-    if (!params)
-        return;
-    if (params.speech_model === "conformer-2") {
-        console.warn("The speech_model conformer-2 option is deprecated and will stop working in the near future. Use best or nano instead.");
-    }
-}
 
 const readFile = function (
 // eslint-disable-next-line @typescript-eslint/no-unused-vars

package/dist/node.cjs

@@ -22,7 +22,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.5.0" },
+    sdk: { name: "JavaScript", version: "4.6.1" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -192,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;
@@ -232,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) {
@@ -314,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) => {
@@ -344,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) {
@@ -430,7 +459,6 @@ class TranscriptService extends BaseService {
      * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
      */
     async transcribe(params, options) {
-        deprecateConformer2(params);
         const transcript = await this.submit(params);
         return await this.waitUntilReady(transcript.id, options);
     }
@@ -440,7 +468,6 @@ class TranscriptService extends BaseService {
      * @returns A promise that resolves to the queued transcript.
      */
     async submit(params) {
-        deprecateConformer2(params);
         let audioUrl;
         let transcriptParams = undefined;
         if ("audio" in params) {
@@ -484,7 +511,6 @@ class TranscriptService extends BaseService {
      * @deprecated Use `transcribe` instead to transcribe a audio file that includes polling, or `submit` to transcribe a audio file without polling.
      */
     async create(params, options) {
-        deprecateConformer2(params);
         const path = getPath(params.audio_url);
         if (path !== null) {
             const uploadUrl = await this.files.upload(path);
@@ -647,13 +673,6 @@ class TranscriptService extends BaseService {
         };
     }
 }
-function deprecateConformer2(params) {
-    if (!params)
-        return;
-    if (params.speech_model === "conformer-2") {
-        console.warn("The speech_model conformer-2 option is deprecated and will stop working in the near future. Use best or nano instead.");
-    }
-}
 
 const readFile = async (path) => stream.Readable.toWeb(fs.createReadStream(path));
 

package/dist/node.mjs

@@ -20,7 +20,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.5.0" },
+    sdk: { name: "JavaScript", version: "4.6.1" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -190,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;
@@ -230,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) {
@@ -312,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) => {
@@ -342,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) {
@@ -428,7 +457,6 @@ class TranscriptService extends BaseService {
      * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
      */
     async transcribe(params, options) {
-        deprecateConformer2(params);
         const transcript = await this.submit(params);
         return await this.waitUntilReady(transcript.id, options);
     }
@@ -438,7 +466,6 @@ class TranscriptService extends BaseService {
      * @returns A promise that resolves to the queued transcript.
      */
     async submit(params) {
-        deprecateConformer2(params);
         let audioUrl;
         let transcriptParams = undefined;
         if ("audio" in params) {
@@ -482,7 +509,6 @@ class TranscriptService extends BaseService {
      * @deprecated Use `transcribe` instead to transcribe a audio file that includes polling, or `submit` to transcribe a audio file without polling.
      */
     async create(params, options) {
-        deprecateConformer2(params);
         const path = getPath(params.audio_url);
         if (path !== null) {
             const uploadUrl = await this.files.upload(path);
@@ -645,13 +671,6 @@ class TranscriptService extends BaseService {
         };
     }
 }
-function deprecateConformer2(params) {
-    if (!params)
-        return;
-    if (params.speech_model === "conformer-2") {
-        console.warn("The speech_model conformer-2 option is deprecated and will stop working in the near future. Use best or nano instead.");
-    }
-}
 
 const readFile = async (path) => Readable.toWeb(createReadStream(path));
 

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>;
 }
 /**

package/dist/streaming.browser.mjs

@@ -56,7 +56,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;
@@ -96,10 +103,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) {
@@ -178,9 +194,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) => {
@@ -208,6 +232,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) {

package/dist/streaming.cjs

@@ -86,7 +86,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) {
         var _a, _b;
         this.listeners = {};
@@ -127,10 +134,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) {
@@ -212,9 +228,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) => {
@@ -242,6 +266,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.
+     */
     close() {
         return __awaiter(this, arguments, void 0, function* (waitForSessionTermination = true) {
             var _a;