assemblyai 4.3.0 → 4.3.2

package/dist/index.cjs

@@ -52,14 +52,14 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
 class BaseService {
     /**
      * Create a new service.
-     * @param params The parameters to use for the service.
+     * @param params - The parameters to use for the service.
      */
     constructor(params) {
         this.params = params;
     }
     fetch(input, init) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             init = init !== null && init !== void 0 ? init : {};
             init.headers = (_a = init.headers) !== null && _a !== void 0 ? _a : {};
             init.headers = Object.assign({ Authorization: this.params.apiKey, "Content-Type": "application/json" }, init.headers);
@@ -120,7 +120,7 @@ class LemurService extends BaseService {
     }
     /**
      * Delete the data for a previously submitted LeMUR request.
-     * @param id ID of the LeMUR request
+     * @param id - ID of the LeMUR request
      */
     purgeRequestData(id) {
         return this.fetchJson(`/lemur/v3/${id}`, {
@@ -187,8 +187,7 @@ class RealtimeTranscriber {
         this.sampleRate = (_b = params.sampleRate) !== null && _b !== void 0 ? _b : 16000;
         this.wordBoost = params.wordBoost;
         this.encoding = params.encoding;
-        this.end_utterance_silence_threshold =
-            params.end_utterance_silence_threshold;
+        this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
         if ("token" in params && params.token)
             this.token = params.token;
         if ("apiKey" in params && params.apiKey)
@@ -236,11 +235,11 @@ class RealtimeTranscriber {
             }
             this.socket.binaryType = "arraybuffer";
             this.socket.onopen = () => {
-                if (this.end_utterance_silence_threshold === undefined ||
-                    this.end_utterance_silence_threshold === null) {
+                if (this.endUtteranceSilenceThreshold === undefined ||
+                    this.endUtteranceSilenceThreshold === null) {
                     return;
                 }
-                this.configureEndUtteranceSilenceThreshold(this.end_utterance_silence_threshold);
+                this.configureEndUtteranceSilenceThreshold(this.endUtteranceSilenceThreshold);
             };
             this.socket.onclose = ({ code, reason }) => {
                 var _a, _b;
@@ -315,8 +314,8 @@ class RealtimeTranscriber {
     }
     /**
      * Configure the threshold for how long to wait before ending an utterance. Default is 700ms.
-     * @param threshold The duration of the end utterance silence threshold in milliseconds
-     * @format integer
+     * @param threshold - The duration of the end utterance silence threshold in milliseconds.
+     * This value must be an integer between 0 and 20_000.
      */
     configureEndUtteranceSilenceThreshold(threshold) {
         this.send(`{"end_utterance_silence_threshold":${threshold}}`);
@@ -327,8 +326,8 @@ class RealtimeTranscriber {
         }
         this.socket.send(data);
     }
-    close(waitForSessionTermination = true) {
-        return __awaiter(this, void 0, void 0, function* () {
+    close() {
+        return __awaiter(this, arguments, void 0, function* (waitForSessionTermination = true) {
             if (this.socket) {
                 if (this.socket.readyState === WebSocket.OPEN) {
                     if (waitForSessionTermination) {
@@ -410,8 +409,8 @@ class TranscriptService extends BaseService {
     }
     /**
      * Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".
-     * @param params The parameters to transcribe an audio file.
-     * @param options The options to transcribe an audio file.
+     * @param params - The parameters to transcribe an audio file.
+     * @param options - The options to transcribe an audio file.
      * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
      */
     transcribe(params, options) {
@@ -422,45 +421,52 @@ class TranscriptService extends BaseService {
     }
     /**
      * Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".
-     * @param params The parameters to start the transcription of an audio file.
+     * @param params - The parameters to start the transcription of an audio file.
      * @returns A promise that resolves to the queued transcript.
      */
     submit(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { audio } = params, createParams = __rest(params, ["audio"]);
             let audioUrl;
-            if (typeof audio === "string") {
-                const path = getPath(audio);
-                if (path !== null) {
-                    // audio is local path, upload local file
-                    audioUrl = yield this.files.upload(path);
+            let transcriptParams = undefined;
+            if ("audio" in params) {
+                const { audio } = params, audioTranscriptParams = __rest(params, ["audio"]);
+                if (typeof audio === "string") {
+                    const path = getPath(audio);
+                    if (path !== null) {
+                        // audio is local path, upload local file
+                        audioUrl = yield this.files.upload(path);
+                    }
+                    else {
+                        // audio is not a local path, assume it's a URL
+                        audioUrl = audio;
+                    }
                 }
                 else {
-                    // audio is not a local path, assume it's a URL
-                    audioUrl = audio;
+                    // audio is of uploadable type
+                    audioUrl = yield this.files.upload(audio);
                 }
+                transcriptParams = Object.assign(Object.assign({}, audioTranscriptParams), { audio_url: audioUrl });
             }
             else {
-                // audio is of uploadable type
-                audioUrl = yield this.files.upload(audio);
+                transcriptParams = params;
             }
             const data = yield this.fetchJson("/v2/transcript", {
                 method: "POST",
-                body: JSON.stringify(Object.assign(Object.assign({}, createParams), { audio_url: audioUrl })),
+                body: JSON.stringify(transcriptParams),
             });
             return data;
         });
     }
     /**
      * Create a transcript.
-     * @param params The parameters to create a transcript.
-     * @param options The options used for creating the new transcript.
+     * @param params - The parameters to create a transcript.
+     * @param options - The options used for creating the new transcript.
      * @returns A promise that resolves to the transcript.
      * @deprecated Use `transcribe` instead to transcribe a audio file that includes polling, or `submit` to transcribe a audio file without polling.
      */
     create(params, options) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const path = getPath(params.audio_url);
             if (path !== null) {
                 const uploadUrl = yield this.files.upload(path);
@@ -478,13 +484,13 @@ class TranscriptService extends BaseService {
     }
     /**
      * Wait until the transcript ready, either the status is "completed" or "error".
-     * @param transcriptId The ID of the transcript.
-     * @param options The options to wait until the transcript is ready.
+     * @param transcriptId - The ID of the transcript.
+     * @param options - The options to wait until the transcript is ready.
      * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
      */
     waitUntilReady(transcriptId, options) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             const pollingInterval = (_a = options === null || options === void 0 ? void 0 : options.pollingInterval) !== null && _a !== void 0 ? _a : 3000;
             const pollingTimeout = (_b = options === null || options === void 0 ? void 0 : options.pollingTimeout) !== null && _b !== void 0 ? _b : -1;
             const startTime = Date.now();
@@ -506,7 +512,7 @@ class TranscriptService extends BaseService {
     }
     /**
      * Retrieve a transcript.
-     * @param id The identifier of the transcript.
+     * @param id - The identifier of the transcript.
      * @returns A promise that resolves to the transcript.
      */
     get(id) {
@@ -514,20 +520,20 @@ class TranscriptService extends BaseService {
     }
     /**
      * Retrieves a page of transcript listings.
-     * @param parameters The parameters to filter the transcript list by, or the URL to retrieve the transcript list from.
+     * @param params - The parameters to filter the transcript list by, or the URL to retrieve the transcript list from.
      */
-    list(parameters) {
+    list(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let url = "/v2/transcript";
-            if (typeof parameters === "string") {
-                url = parameters;
+            if (typeof params === "string") {
+                url = params;
             }
-            else if (parameters) {
-                url = `${url}?${new URLSearchParams(Object.keys(parameters).map((key) => {
+            else if (params) {
+                url = `${url}?${new URLSearchParams(Object.keys(params).map((key) => {
                     var _a;
                     return [
                         key,
-                        ((_a = parameters[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "",
+                        ((_a = params[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "",
                     ];
                 }))}`;
             }
@@ -543,7 +549,7 @@ class TranscriptService extends BaseService {
     }
     /**
      * Delete a transcript
-     * @param id The identifier of the transcript.
+     * @param id - The identifier of the transcript.
      * @returns A promise that resolves to the transcript.
      */
     delete(id) {
@@ -552,9 +558,9 @@ class TranscriptService extends BaseService {
     /**
      * Search through the transcript for a specific set of keywords.
      * You can search for individual words, numbers, or phrases containing up to five words or numbers.
-     * @param id The identifier of the transcript.
-     * @param words Keywords to search for.
-     * @return A promise that resolves to the sentences.
+     * @param id - The identifier of the transcript.
+     * @param words - Keywords to search for.
+     * @returns A promise that resolves to the sentences.
      */
     wordSearch(id, words) {
         const params = new URLSearchParams({ words: words.join(",") });
@@ -562,29 +568,29 @@ class TranscriptService extends BaseService {
     }
     /**
      * Retrieve all sentences of a transcript.
-     * @param id The identifier of the transcript.
-     * @return A promise that resolves to the sentences.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the sentences.
      */
     sentences(id) {
         return this.fetchJson(`/v2/transcript/${id}/sentences`);
     }
     /**
      * Retrieve all paragraphs of a transcript.
-     * @param id The identifier of the transcript.
-     * @return A promise that resolves to the paragraphs.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the paragraphs.
      */
     paragraphs(id) {
         return this.fetchJson(`/v2/transcript/${id}/paragraphs`);
     }
     /**
      * Retrieve subtitles of a transcript.
-     * @param id The identifier of the transcript.
-     * @param format The format of the subtitles.
-     * @param chars_per_caption The maximum number of characters per caption.
-     * @return A promise that resolves to the subtitles text.
+     * @param id - The identifier of the transcript.
+     * @param format - The format of the subtitles.
+     * @param chars_per_caption - The maximum number of characters per caption.
+     * @returns A promise that resolves to the subtitles text.
      */
-    subtitles(id, format = "srt", chars_per_caption) {
-        return __awaiter(this, void 0, void 0, function* () {
+    subtitles(id_1) {
+        return __awaiter(this, arguments, void 0, function* (id, format = "srt", chars_per_caption) {
             let url = `/v2/transcript/${id}/${format}`;
             if (chars_per_caption) {
                 const params = new URLSearchParams();
@@ -597,8 +603,8 @@ class TranscriptService extends BaseService {
     }
     /**
      * Retrieve redactions of a transcript.
-     * @param id The identifier of the transcript.
-     * @return A promise that resolves to the subtitles text.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the subtitles text.
      */
     redactions(id) {
         return this.fetchJson(`/v2/transcript/${id}/redacted-audio`);
@@ -616,8 +622,8 @@ path) {
 class FileService extends BaseService {
     /**
      * Upload a local file to AssemblyAI.
-     * @param input The local file path to upload, or a stream or buffer of the file to upload.
-     * @return A promise that resolves to the uploaded file URL.
+     * @param input - The local file path to upload, or a stream or buffer of the file to upload.
+     * @returns A promise that resolves to the uploaded file URL.
      */
     upload(input) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -643,7 +649,7 @@ const defaultBaseUrl = "https://api.assemblyai.com";
 class AssemblyAI {
     /**
      * Create a new AssemblyAI client.
-     * @param params The parameters for the service, including the API key and base URL, if any.
+     * @param params - The parameters for the service, including the API key and base URL, if any.
      */
     constructor(params) {
         params.baseUrl = params.baseUrl || defaultBaseUrl;

package/dist/index.mjs

@@ -50,14 +50,14 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
 class BaseService {
     /**
      * Create a new service.
-     * @param params The parameters to use for the service.
+     * @param params - The parameters to use for the service.
      */
     constructor(params) {
         this.params = params;
     }
     fetch(input, init) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             init = init !== null && init !== void 0 ? init : {};
             init.headers = (_a = init.headers) !== null && _a !== void 0 ? _a : {};
             init.headers = Object.assign({ Authorization: this.params.apiKey, "Content-Type": "application/json" }, init.headers);
@@ -118,7 +118,7 @@ class LemurService extends BaseService {
     }
     /**
      * Delete the data for a previously submitted LeMUR request.
-     * @param id ID of the LeMUR request
+     * @param id - ID of the LeMUR request
      */
     purgeRequestData(id) {
         return this.fetchJson(`/lemur/v3/${id}`, {
@@ -185,8 +185,7 @@ class RealtimeTranscriber {
         this.sampleRate = (_b = params.sampleRate) !== null && _b !== void 0 ? _b : 16000;
         this.wordBoost = params.wordBoost;
         this.encoding = params.encoding;
-        this.end_utterance_silence_threshold =
-            params.end_utterance_silence_threshold;
+        this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
         if ("token" in params && params.token)
             this.token = params.token;
         if ("apiKey" in params && params.apiKey)
@@ -234,11 +233,11 @@ class RealtimeTranscriber {
             }
             this.socket.binaryType = "arraybuffer";
             this.socket.onopen = () => {
-                if (this.end_utterance_silence_threshold === undefined ||
-                    this.end_utterance_silence_threshold === null) {
+                if (this.endUtteranceSilenceThreshold === undefined ||
+                    this.endUtteranceSilenceThreshold === null) {
                     return;
                 }
-                this.configureEndUtteranceSilenceThreshold(this.end_utterance_silence_threshold);
+                this.configureEndUtteranceSilenceThreshold(this.endUtteranceSilenceThreshold);
             };
             this.socket.onclose = ({ code, reason }) => {
                 var _a, _b;
@@ -313,8 +312,8 @@ class RealtimeTranscriber {
     }
     /**
      * Configure the threshold for how long to wait before ending an utterance. Default is 700ms.
-     * @param threshold The duration of the end utterance silence threshold in milliseconds
-     * @format integer
+     * @param threshold - The duration of the end utterance silence threshold in milliseconds.
+     * This value must be an integer between 0 and 20_000.
      */
     configureEndUtteranceSilenceThreshold(threshold) {
         this.send(`{"end_utterance_silence_threshold":${threshold}}`);
@@ -325,8 +324,8 @@ class RealtimeTranscriber {
         }
         this.socket.send(data);
     }
-    close(waitForSessionTermination = true) {
-        return __awaiter(this, void 0, void 0, function* () {
+    close() {
+        return __awaiter(this, arguments, void 0, function* (waitForSessionTermination = true) {
             if (this.socket) {
                 if (this.socket.readyState === WebSocket.OPEN) {
                     if (waitForSessionTermination) {
@@ -408,8 +407,8 @@ class TranscriptService extends BaseService {
     }
     /**
      * Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".
-     * @param params The parameters to transcribe an audio file.
-     * @param options The options to transcribe an audio file.
+     * @param params - The parameters to transcribe an audio file.
+     * @param options - The options to transcribe an audio file.
      * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
      */
     transcribe(params, options) {
@@ -420,45 +419,52 @@ class TranscriptService extends BaseService {
     }
     /**
      * Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".
-     * @param params The parameters to start the transcription of an audio file.
+     * @param params - The parameters to start the transcription of an audio file.
      * @returns A promise that resolves to the queued transcript.
      */
     submit(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { audio } = params, createParams = __rest(params, ["audio"]);
             let audioUrl;
-            if (typeof audio === "string") {
-                const path = getPath(audio);
-                if (path !== null) {
-                    // audio is local path, upload local file
-                    audioUrl = yield this.files.upload(path);
+            let transcriptParams = undefined;
+            if ("audio" in params) {
+                const { audio } = params, audioTranscriptParams = __rest(params, ["audio"]);
+                if (typeof audio === "string") {
+                    const path = getPath(audio);
+                    if (path !== null) {
+                        // audio is local path, upload local file
+                        audioUrl = yield this.files.upload(path);
+                    }
+                    else {
+                        // audio is not a local path, assume it's a URL
+                        audioUrl = audio;
+                    }
                 }
                 else {
-                    // audio is not a local path, assume it's a URL
-                    audioUrl = audio;
+                    // audio is of uploadable type
+                    audioUrl = yield this.files.upload(audio);
                 }
+                transcriptParams = Object.assign(Object.assign({}, audioTranscriptParams), { audio_url: audioUrl });
             }
             else {
-                // audio is of uploadable type
-                audioUrl = yield this.files.upload(audio);
+                transcriptParams = params;
             }
             const data = yield this.fetchJson("/v2/transcript", {
                 method: "POST",
-                body: JSON.stringify(Object.assign(Object.assign({}, createParams), { audio_url: audioUrl })),
+                body: JSON.stringify(transcriptParams),
             });
             return data;
         });
     }
     /**
      * Create a transcript.
-     * @param params The parameters to create a transcript.
-     * @param options The options used for creating the new transcript.
+     * @param params - The parameters to create a transcript.
+     * @param options - The options used for creating the new transcript.
      * @returns A promise that resolves to the transcript.
      * @deprecated Use `transcribe` instead to transcribe a audio file that includes polling, or `submit` to transcribe a audio file without polling.
      */
     create(params, options) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const path = getPath(params.audio_url);
             if (path !== null) {
                 const uploadUrl = yield this.files.upload(path);
@@ -476,13 +482,13 @@ class TranscriptService extends BaseService {
     }
     /**
      * Wait until the transcript ready, either the status is "completed" or "error".
-     * @param transcriptId The ID of the transcript.
-     * @param options The options to wait until the transcript is ready.
+     * @param transcriptId - The ID of the transcript.
+     * @param options - The options to wait until the transcript is ready.
      * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
      */
     waitUntilReady(transcriptId, options) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             const pollingInterval = (_a = options === null || options === void 0 ? void 0 : options.pollingInterval) !== null && _a !== void 0 ? _a : 3000;
             const pollingTimeout = (_b = options === null || options === void 0 ? void 0 : options.pollingTimeout) !== null && _b !== void 0 ? _b : -1;
             const startTime = Date.now();
@@ -504,7 +510,7 @@ class TranscriptService extends BaseService {
     }
     /**
      * Retrieve a transcript.
-     * @param id The identifier of the transcript.
+     * @param id - The identifier of the transcript.
      * @returns A promise that resolves to the transcript.
      */
     get(id) {
@@ -512,20 +518,20 @@ class TranscriptService extends BaseService {
     }
     /**
      * Retrieves a page of transcript listings.
-     * @param parameters The parameters to filter the transcript list by, or the URL to retrieve the transcript list from.
+     * @param params - The parameters to filter the transcript list by, or the URL to retrieve the transcript list from.
      */
-    list(parameters) {
+    list(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let url = "/v2/transcript";
-            if (typeof parameters === "string") {
-                url = parameters;
+            if (typeof params === "string") {
+                url = params;
             }
-            else if (parameters) {
-                url = `${url}?${new URLSearchParams(Object.keys(parameters).map((key) => {
+            else if (params) {
+                url = `${url}?${new URLSearchParams(Object.keys(params).map((key) => {
                     var _a;
                     return [
                         key,
-                        ((_a = parameters[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "",
+                        ((_a = params[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "",
                     ];
                 }))}`;
             }
@@ -541,7 +547,7 @@ class TranscriptService extends BaseService {
     }
     /**
      * Delete a transcript
-     * @param id The identifier of the transcript.
+     * @param id - The identifier of the transcript.
      * @returns A promise that resolves to the transcript.
      */
     delete(id) {
@@ -550,9 +556,9 @@ class TranscriptService extends BaseService {
     /**
      * Search through the transcript for a specific set of keywords.
      * You can search for individual words, numbers, or phrases containing up to five words or numbers.
-     * @param id The identifier of the transcript.
-     * @param words Keywords to search for.
-     * @return A promise that resolves to the sentences.
+     * @param id - The identifier of the transcript.
+     * @param words - Keywords to search for.
+     * @returns A promise that resolves to the sentences.
      */
     wordSearch(id, words) {
         const params = new URLSearchParams({ words: words.join(",") });
@@ -560,29 +566,29 @@ class TranscriptService extends BaseService {
     }
     /**
      * Retrieve all sentences of a transcript.
-     * @param id The identifier of the transcript.
-     * @return A promise that resolves to the sentences.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the sentences.
      */
     sentences(id) {
         return this.fetchJson(`/v2/transcript/${id}/sentences`);
     }
     /**
      * Retrieve all paragraphs of a transcript.
-     * @param id The identifier of the transcript.
-     * @return A promise that resolves to the paragraphs.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the paragraphs.
      */
     paragraphs(id) {
         return this.fetchJson(`/v2/transcript/${id}/paragraphs`);
     }
     /**
      * Retrieve subtitles of a transcript.
-     * @param id The identifier of the transcript.
-     * @param format The format of the subtitles.
-     * @param chars_per_caption The maximum number of characters per caption.
-     * @return A promise that resolves to the subtitles text.
+     * @param id - The identifier of the transcript.
+     * @param format - The format of the subtitles.
+     * @param chars_per_caption - The maximum number of characters per caption.
+     * @returns A promise that resolves to the subtitles text.
      */
-    subtitles(id, format = "srt", chars_per_caption) {
-        return __awaiter(this, void 0, void 0, function* () {
+    subtitles(id_1) {
+        return __awaiter(this, arguments, void 0, function* (id, format = "srt", chars_per_caption) {
             let url = `/v2/transcript/${id}/${format}`;
             if (chars_per_caption) {
                 const params = new URLSearchParams();
@@ -595,8 +601,8 @@ class TranscriptService extends BaseService {
     }
     /**
      * Retrieve redactions of a transcript.
-     * @param id The identifier of the transcript.
-     * @return A promise that resolves to the subtitles text.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the subtitles text.
      */
     redactions(id) {
         return this.fetchJson(`/v2/transcript/${id}/redacted-audio`);
@@ -614,8 +620,8 @@ path) {
 class FileService extends BaseService {
     /**
      * Upload a local file to AssemblyAI.
-     * @param input The local file path to upload, or a stream or buffer of the file to upload.
-     * @return A promise that resolves to the uploaded file URL.
+     * @param input - The local file path to upload, or a stream or buffer of the file to upload.
+     * @returns A promise that resolves to the uploaded file URL.
      */
     upload(input) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -641,7 +647,7 @@ const defaultBaseUrl = "https://api.assemblyai.com";
 class AssemblyAI {
     /**
      * Create a new AssemblyAI client.
-     * @param params The parameters for the service, including the API key and base URL, if any.
+     * @param params - The parameters for the service, including the API key and base URL, if any.
      */
     constructor(params) {
         params.baseUrl = params.baseUrl || defaultBaseUrl;