assemblyai 4.3.1 → 4.3.2

package/dist/node.cjs

@@ -11,7 +11,7 @@ var stream = require('stream');
 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;
@@ -78,7 +78,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}`, {
@@ -135,11 +135,10 @@ class RealtimeTranscriber {
     constructor(params) {
         this.listeners = {};
         this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
-        this.sampleRate = params.sampleRate ?? 16000;
+        this.sampleRate = params.sampleRate ?? 16_000;
         this.wordBoost = params.wordBoost;
         this.encoding = params.encoding;
-        this.endUtteranceSilenceThreshold =
-            params.endUtteranceSilenceThreshold;
+        this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
         if ("token" in params && params.token)
             this.token = params.token;
         if ("apiKey" in params && params.apiKey)
@@ -263,8 +262,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}}`);
@@ -354,8 +353,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".
      */
     async transcribe(params, options) {
@@ -364,37 +363,44 @@ 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.
      */
     async submit(params) {
-        const { audio, ...createParams } = params;
         let audioUrl;
-        if (typeof audio === "string") {
-            const path = getPath(audio);
-            if (path !== null) {
-                // audio is local path, upload local file
-                audioUrl = await this.files.upload(path);
+        let transcriptParams = undefined;
+        if ("audio" in params) {
+            const { audio, ...audioTranscriptParams } = params;
+            if (typeof audio === "string") {
+                const path = getPath(audio);
+                if (path !== null) {
+                    // audio is local path, upload local file
+                    audioUrl = await 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 = await this.files.upload(audio);
             }
+            transcriptParams = { ...audioTranscriptParams, audio_url: audioUrl };
         }
         else {
-            // audio is of uploadable type
-            audioUrl = await this.files.upload(audio);
+            transcriptParams = params;
         }
         const data = await this.fetchJson("/v2/transcript", {
             method: "POST",
-            body: JSON.stringify({ ...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.
      */
@@ -415,12 +421,12 @@ 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".
      */
     async waitUntilReady(transcriptId, options) {
-        const pollingInterval = options?.pollingInterval ?? 3000;
+        const pollingInterval = options?.pollingInterval ?? 3_000;
         const pollingTimeout = options?.pollingTimeout ?? -1;
         const startTime = Date.now();
         // eslint-disable-next-line no-constant-condition
@@ -440,7 +446,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) {
@@ -448,17 +454,17 @@ 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.
      */
-    async list(parameters) {
+    async list(params) {
         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) => [
                 key,
-                parameters[key]?.toString() || "",
+                params[key]?.toString() || "",
             ]))}`;
         }
         const data = await this.fetchJson(url);
@@ -472,7 +478,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) {
@@ -481,9 +487,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(",") });
@@ -491,26 +497,26 @@ 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.
      */
     async subtitles(id, format = "srt", chars_per_caption) {
         let url = `/v2/transcript/${id}/${format}`;
@@ -524,8 +530,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`);
@@ -537,8 +543,8 @@ const readFile = async (path) => stream.Readable.toWeb(fs.createReadStream(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.
      */
     async upload(input) {
         let fileData;
@@ -562,7 +568,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/node.mjs

@@ -9,7 +9,7 @@ import { Readable } from 'stream';
 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;
@@ -76,7 +76,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}`, {
@@ -133,11 +133,10 @@ class RealtimeTranscriber {
     constructor(params) {
         this.listeners = {};
         this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
-        this.sampleRate = params.sampleRate ?? 16000;
+        this.sampleRate = params.sampleRate ?? 16_000;
         this.wordBoost = params.wordBoost;
         this.encoding = params.encoding;
-        this.endUtteranceSilenceThreshold =
-            params.endUtteranceSilenceThreshold;
+        this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
         if ("token" in params && params.token)
             this.token = params.token;
         if ("apiKey" in params && params.apiKey)
@@ -261,8 +260,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}}`);
@@ -352,8 +351,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".
      */
     async transcribe(params, options) {
@@ -362,37 +361,44 @@ 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.
      */
     async submit(params) {
-        const { audio, ...createParams } = params;
         let audioUrl;
-        if (typeof audio === "string") {
-            const path = getPath(audio);
-            if (path !== null) {
-                // audio is local path, upload local file
-                audioUrl = await this.files.upload(path);
+        let transcriptParams = undefined;
+        if ("audio" in params) {
+            const { audio, ...audioTranscriptParams } = params;
+            if (typeof audio === "string") {
+                const path = getPath(audio);
+                if (path !== null) {
+                    // audio is local path, upload local file
+                    audioUrl = await 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 = await this.files.upload(audio);
             }
+            transcriptParams = { ...audioTranscriptParams, audio_url: audioUrl };
         }
         else {
-            // audio is of uploadable type
-            audioUrl = await this.files.upload(audio);
+            transcriptParams = params;
         }
         const data = await this.fetchJson("/v2/transcript", {
             method: "POST",
-            body: JSON.stringify({ ...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.
      */
@@ -413,12 +419,12 @@ 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".
      */
     async waitUntilReady(transcriptId, options) {
-        const pollingInterval = options?.pollingInterval ?? 3000;
+        const pollingInterval = options?.pollingInterval ?? 3_000;
         const pollingTimeout = options?.pollingTimeout ?? -1;
         const startTime = Date.now();
         // eslint-disable-next-line no-constant-condition
@@ -438,7 +444,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) {
@@ -446,17 +452,17 @@ 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.
      */
-    async list(parameters) {
+    async list(params) {
         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) => [
                 key,
-                parameters[key]?.toString() || "",
+                params[key]?.toString() || "",
             ]))}`;
         }
         const data = await this.fetchJson(url);
@@ -470,7 +476,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) {
@@ -479,9 +485,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(",") });
@@ -489,26 +495,26 @@ 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.
      */
     async subtitles(id, format = "srt", chars_per_caption) {
         let url = `/v2/transcript/${id}/${format}`;
@@ -522,8 +528,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`);
@@ -535,8 +541,8 @@ const readFile = async (path) => Readable.toWeb(createReadStream(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.
      */
     async upload(input) {
         let fileData;
@@ -560,7 +566,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/services/base.d.ts

@@ -6,7 +6,7 @@ export declare abstract class BaseService {
     private params;
     /**
      * Create a new service.
-     * @param params The parameters to use for the service.
+     * @param params - The parameters to use for the service.
      */
     constructor(params: BaseServiceParams);
     protected fetch(input: string, init?: RequestInit | undefined): Promise<Response>;

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

@@ -3,8 +3,8 @@ import { FileUploadParams } from "../..";
 export declare 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: FileUploadParams): Promise<string>;
 }

package/dist/services/index.d.ts

@@ -22,7 +22,7 @@ declare class AssemblyAI {
     realtime: RealtimeTranscriberFactory;
     /**
      * 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: BaseServiceParams);
 }

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

@@ -7,7 +7,7 @@ export declare class LemurService extends BaseService {
     task(params: LemurTaskParams): Promise<LemurTaskResponse>;
     /**
      * 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: string): Promise<PurgeLemurRequestDataResponse>;
 }

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

@@ -27,8 +27,8 @@ export declare class RealtimeTranscriber {
     forceEndUtterance(): void;
     /**
      * 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: number): void;
     private send;