assemblyai 3.0.1 → 3.1.0

package/README.md

@@ -8,7 +8,7 @@
 [![AssemblyAI Twitter](https://img.shields.io/twitter/follow/AssemblyAI?label=%40AssemblyAI&style=social)](https://twitter.com/AssemblyAI)
 [![AssemblyAI YouTube](https://img.shields.io/youtube/channel/subscribers/UCtatfZMf-8EkIwASXM4ts0A)](https://www.youtube.com/@AssemblyAI)
 [![Discord](https://img.shields.io/discord/875120158014853141?logo=discord&label=Discord&link=https%3A%2F%2Fdiscord.com%2Fchannels%2F875120158014853141&style=social)
-](https://discord.gg/5aQNZyq3)
+](https://assemblyai.com/discord)
 
 # AssemblyAI Node.js SDK
 
@@ -79,7 +79,7 @@ const transcript = await client.transcripts.create({
   poll: true,
   // How frequently the transcript is polled in ms. Defaults to 3000.
   pollingInterval: 1000,
-  // How long to wait in ms until the "Polling timeout" error is thrown. Defaults to 180000.
+  // How long to wait in ms until the "Polling timeout" error is thrown. Defaults to infinite (-1).
   pollingTimeout: 5000,
 })
 ```
@@ -92,9 +92,21 @@ This will return the transcript object in its current state. If the transcript i
 const transcript = await client.transcripts.get(transcript.id)
 ```
 
+If you disabled polling during transcript creation, you can still poll until the transcript `status` is `completed` or `error` using `waitUntilReady`:
+
+```javascript
+const transcript = await client.transcripts.waitUntilReady(transcript.id,
+{
+  // How frequently the transcript is polled in ms. Defaults to 3000.
+  pollingInterval: 1000,
+  // How long to wait in ms until the "Polling timeout" error is thrown. Defaults to infinite (-1).
+  pollingTimeout: 5000,
+})
+```
+
 ## List transcripts
 
-This will return a page of transcripts that you have transcript.
+This will return a page of transcripts you created.
 
 ```javascript
 const page = await client.transcripts.list()

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export type * from "./types";
+export * from "./types";
 export * from "./services";

package/dist/index.esm.js

@@ -354,14 +354,16 @@ class TranscriptService extends BaseService {
                 body: JSON.stringify(params),
             });
             if ((_a = options === null || options === void 0 ? void 0 : options.poll) !== null && _a !== void 0 ? _a : true) {
-                return yield this.poll(data.id, options);
+                return yield this.waitUntilReady(data.id, options);
             }
             return data;
         });
     }
-    poll(transcriptId, options) {
-        var _a;
+    waitUntilReady(transcriptId, options) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            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();
             // eslint-disable-next-line no-constant-condition
             while (true) {
@@ -369,12 +371,12 @@ class TranscriptService extends BaseService {
                 if (transcript.status === "completed" || transcript.status === "error") {
                     return transcript;
                 }
-                else if (Date.now() - startTime <
-                    ((_a = options === null || options === void 0 ? void 0 : options.pollingTimeout) !== null && _a !== void 0 ? _a : 180000)) {
-                    yield new Promise((resolve) => { var _a; return setTimeout(resolve, (_a = options === null || options === void 0 ? void 0 : options.pollingInterval) !== null && _a !== void 0 ? _a : 3000); });
+                else if (pollingTimeout > 0 &&
+                    Date.now() - startTime > pollingTimeout) {
+                    throw new Error("Polling timeout");
                 }
                 else {
-                    throw new Error("Polling timeout");
+                    yield new Promise((resolve) => setTimeout(resolve, pollingInterval));
                 }
             }
         });
@@ -432,7 +434,8 @@ class TranscriptService extends BaseService {
      * @return A promise that resolves to the sentences.
      */
     wordSearch(id, words) {
-        return this.fetchJson(`/v2/transcript/${id}/word-search?words=${JSON.stringify(words)}`);
+        const params = new URLSearchParams({ words: words.join(",") });
+        return this.fetchJson(`/v2/transcript/${id}/word-search?${params.toString()}`);
     }
     /**
      * Retrieve all sentences of a transcript.
@@ -454,11 +457,18 @@ class TranscriptService extends BaseService {
      * 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.
      */
-    subtitles(id, format = "srt") {
+    subtitles(id, format = "srt", chars_per_caption) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.fetch(`/v2/transcript/${id}/${format}`);
+            let url = `/v2/transcript/${id}/${format}`;
+            if (chars_per_caption) {
+                const params = new URLSearchParams();
+                params.set("chars_per_caption", chars_per_caption.toString());
+                url += `?${params.toString()}`;
+            }
+            const response = yield this.fetch(url);
             return yield response.text();
         });
     }

package/dist/index.js

@@ -356,14 +356,16 @@ class TranscriptService extends BaseService {
                 body: JSON.stringify(params),
             });
             if ((_a = options === null || options === void 0 ? void 0 : options.poll) !== null && _a !== void 0 ? _a : true) {
-                return yield this.poll(data.id, options);
+                return yield this.waitUntilReady(data.id, options);
             }
             return data;
         });
     }
-    poll(transcriptId, options) {
-        var _a;
+    waitUntilReady(transcriptId, options) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            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();
             // eslint-disable-next-line no-constant-condition
             while (true) {
@@ -371,12 +373,12 @@ class TranscriptService extends BaseService {
                 if (transcript.status === "completed" || transcript.status === "error") {
                     return transcript;
                 }
-                else if (Date.now() - startTime <
-                    ((_a = options === null || options === void 0 ? void 0 : options.pollingTimeout) !== null && _a !== void 0 ? _a : 180000)) {
-                    yield new Promise((resolve) => { var _a; return setTimeout(resolve, (_a = options === null || options === void 0 ? void 0 : options.pollingInterval) !== null && _a !== void 0 ? _a : 3000); });
+                else if (pollingTimeout > 0 &&
+                    Date.now() - startTime > pollingTimeout) {
+                    throw new Error("Polling timeout");
                 }
                 else {
-                    throw new Error("Polling timeout");
+                    yield new Promise((resolve) => setTimeout(resolve, pollingInterval));
                 }
             }
         });
@@ -434,7 +436,8 @@ class TranscriptService extends BaseService {
      * @return A promise that resolves to the sentences.
      */
     wordSearch(id, words) {
-        return this.fetchJson(`/v2/transcript/${id}/word-search?words=${JSON.stringify(words)}`);
+        const params = new URLSearchParams({ words: words.join(",") });
+        return this.fetchJson(`/v2/transcript/${id}/word-search?${params.toString()}`);
     }
     /**
      * Retrieve all sentences of a transcript.
@@ -456,11 +459,18 @@ class TranscriptService extends BaseService {
      * 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.
      */
-    subtitles(id, format = "srt") {
+    subtitles(id, format = "srt", chars_per_caption) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.fetch(`/v2/transcript/${id}/${format}`);
+            let url = `/v2/transcript/${id}/${format}`;
+            if (chars_per_caption) {
+                const params = new URLSearchParams();
+                params.set("chars_per_caption", chars_per_caption.toString());
+                url += `?${params.toString()}`;
+            }
+            const response = yield this.fetch(url);
             return yield response.text();
         });
     }

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

@@ -1,5 +1,5 @@
 import { BaseService } from "../base";
-import { ParagraphsResponse, SentencesResponse, Transcript, TranscriptList, CreateTranscriptParameters, CreateTranscriptOptions, Createable, Deletable, Listable, Retrieveable, SubtitleFormat, RedactedAudioResponse, TranscriptListParameters, WordSearchResponse, BaseServiceParams } from "../..";
+import { ParagraphsResponse, SentencesResponse, Transcript, TranscriptList, CreateTranscriptParameters, CreateTranscriptOptions, Createable, Deletable, Listable, Retrieveable, SubtitleFormat, RedactedAudioResponse, TranscriptListParameters, WordSearchResponse, BaseServiceParams, PollingOptions } from "../..";
 import { FileService } from "../files";
 export declare class TranscriptService extends BaseService implements Createable<Transcript, CreateTranscriptParameters, CreateTranscriptOptions>, Retrieveable<Transcript>, Deletable<Transcript>, Listable<TranscriptList> {
     private files;
@@ -11,7 +11,7 @@ export declare class TranscriptService extends BaseService implements Createable
      * @returns A promise that resolves to the newly created transcript.
      */
     create(params: CreateTranscriptParameters, options?: CreateTranscriptOptions): Promise<Transcript>;
-    private poll;
+    waitUntilReady(transcriptId: string, options?: PollingOptions): Promise<Transcript>;
     /**
      * Retrieve a transcript.
      * @param id The identifier of the transcript.
@@ -53,9 +53,10 @@ export declare class TranscriptService extends BaseService implements Createable
      * 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.
      */
-    subtitles(id: string, format?: SubtitleFormat): Promise<string>;
+    subtitles(id: string, format?: SubtitleFormat, chars_per_caption?: number): Promise<string>;
     /**
      * Retrieve redactions of a transcript.
      * @param id The identifier of the transcript.

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

@@ -1,46 +1,49 @@
 export type AudioData = {
-    /** @description Raw audio data, base64 encoded. This can be the raw data recorded directly from a microphone or read from an audio file. */
+    /** @description Base64 encoded raw audio data */
     audio_data: string;
 };
 export type FinalTranscript = RealtimeBaseTranscript & {
     /**
-     * @description Describes the type of message.
+     * @description Describes the type of message
      * @constant
      */
     message_type: "FinalTranscript";
-    /** @description Whether the text has been punctuated and cased. */
+    /** @description Whether the text is punctuated and cased */
     punctuated: boolean;
-    /** @description Whether the text has been formatted (e.g. Dollar -> $) */
+    /** @description Whether the text is formatted, for example Dollar -> $ */
     text_formatted: boolean;
 };
 /** @enum {string} */
 export type MessageType = "SessionBegins" | "PartialTranscript" | "FinalTranscript" | "SessionTerminated";
 export type PartialTranscript = RealtimeBaseTranscript & {
     /**
-     * @description Describes the type of message.
+     * @description Describes the type of message
      * @constant
      */
     message_type: "PartialTranscript";
 };
 export type RealtimeBaseMessage = {
-    /** @description Describes the type of the message. */
+    /** @description Describes the type of the message */
     message_type: MessageType;
 };
 export type RealtimeBaseTranscript = {
-    /** @description End time of audio sample relative to session start, in milliseconds. */
+    /** @description End time of audio sample relative to session start, in milliseconds */
     audio_end: number;
-    /** @description Start time of audio sample relative to session start, in milliseconds. */
+    /** @description Start time of audio sample relative to session start, in milliseconds */
     audio_start: number;
     /**
      * Format: double
-     * @description The confidence score of the entire transcription, between 0 and 1.
+     * @description The confidence score of the entire transcription, between 0 and 1
      */
     confidence: number;
-    /** @description The timestamp for the partial transcript. */
+    /** @description The timestamp for the partial transcript */
     created: Date;
-    /** @description The partial transcript for your audio. */
+    /** @description The partial transcript for your audio */
     text: string;
-    /** @description An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself). */
+    /**
+     * @description An array of objects, with the information for each word in the transcription text.
+     * Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.
+     */
     words: Word[];
 };
 export type RealtimeError = {
@@ -51,25 +54,25 @@ export type RealtimeTranscript = PartialTranscript | FinalTranscript;
 /** @enum {string} */
 export type RealtimeTranscriptType = "PartialTranscript" | "FinalTranscript";
 export type SessionBegins = RealtimeBaseMessage & {
-    /** @description Timestamp when this session will expire. */
+    /** @description Timestamp when this session will expire */
     expires_at: Date;
     /**
-     * @description Describes the type of the message.
+     * @description Describes the type of the message
      * @constant
      */
     message_type: "SessionBegins";
-    /** @description Unique identifier for the established session. */
+    /** @description Unique identifier for the established session */
     session_id: string;
 };
 export type SessionTerminated = RealtimeBaseMessage & {
     /**
-     * @description Describes the type of the message.
+     * @description Describes the type of the message
      * @constant
      */
     message_type: "SessionTerminated";
 };
 export type TerminateSession = RealtimeBaseMessage & {
-    /** @description A boolean value to communicate that you wish to end your real-time session forever. */
+    /** @description Set to true to end your real-time session forever */
     terminate_session: boolean;
 };
 export type Word = {

package/dist/types/index.d.ts

@@ -1,6 +1,6 @@
-export type * from "./files";
-export type * from "./transcripts";
-export type * from "./realtime";
-export type * from "./services";
-export type * from "./asyncapi.generated";
-export type * from "./openapi.generated";
+export * from "./files";
+export * from "./transcripts";
+export * from "./realtime";
+export * from "./services";
+export * from "./asyncapi.generated";
+export * from "./openapi.generated";