assemblyai 3.1.0 → 3.1.2

package/README.md

@@ -4,7 +4,7 @@
 
 [![npm](https://img.shields.io/npm/v/assemblyai)](https://www.npmjs.com/package/assemblyai)
 [![Test](https://github.com/AssemblyAI/assemblyai-node-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/AssemblyAI/assemblyai-node-sdk/actions/workflows/test.yml)
-[![GitHub License](https://img.shields.io/github/license/AssemblyAI/assemblyai-node-sdk)](https://github.com/AssemblyAI/assemblyai-node-sdk/blob/master/LICENSE)
+[![GitHub License](https://img.shields.io/github/license/AssemblyAI/assemblyai-node-sdk)](https://github.com/AssemblyAI/assemblyai-node-sdk/blob/main/LICENSE)
 [![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)
@@ -44,7 +44,7 @@ import { AssemblyAI } from "assemblyai";
 
 const client = new AssemblyAI({
   apiKey: process.env.ASSEMBLYAI_API_KEY,
-})
+});
 ```
 
 You can now use the `client` object to interact with the AssemblyAI API.
@@ -54,34 +54,43 @@ You can now use the `client` object to interact with the AssemblyAI API.
 When you create a transcript, you can either pass in a URL to an audio file, or upload a file directly.
 
 ```javascript
-// Using a remote URL
-const transcript = await client.transcripts.create({
-  audio_url: 'https://storage.googleapis.com/aai-web-samples/espn-bears.m4a',
-})
+// Transcribe file at remote URL
+let transcript = await client.transcripts.transcribe({
+  audio: "https://storage.googleapis.com/aai-web-samples/espn-bears.m4a",
+});
+
+// Upload a file via local path and transcribe
+let transcript = await client.transcripts.transcribe({
+  audio: "./news.mp4",
+});
 ```
 
+> **Note**
+> You can also pass streams and buffers to the `audio` property.
+
+`transcribe` queues a transcription job and polls it until the `status` is `completed` or `error`.
+You can configure the polling interval and polling timeout using these options:
+
 ```javascript
-// Uploading a file
-const transcript = await client.transcripts.create({
-  audio_url: './news.mp4',
-})
+let transcript = await client.transcripts.transcribe(
+  {
+    audio: "https://storage.googleapis.com/aai-web-samples/espn-bears.m4a",
+  },
+  {
+    // 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,
+  }
+);
 ```
 
-By default, when you create a transcript, it'll be polled until the status is `completed` or `error`.
-You can configure whether to poll, the polling interval, and polling timeout using these options:
+If you don't want to wait until the transcript is ready, you can use `submit`:
 
 ```javascript
-const transcript = await client.transcripts.create({
-  audio_url: 'https://storage.googleapis.com/aai-web-samples/espn-bears.m4a',
-},
-{
-  // Enable or disable polling. Defaults to true.
-  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 infinite (-1).
-  pollingTimeout: 5000,
-})
+let transcript = await client.transcripts.submit({
+  audio: "https://storage.googleapis.com/aai-web-samples/espn-bears.m4a",
+});
 ```
 
 ## Get a transcript
@@ -89,19 +98,18 @@ const transcript = await client.transcripts.create({
 This will return the transcript object in its current state. If the transcript is still processing, the `status` field will be `queued` or `processing`. Once the transcript is complete, the `status` field will be `completed`.
 
 ```javascript
-const transcript = await client.transcripts.get(transcript.id)
+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`:
+If you created a transcript using `submit`, you can still poll until the transcript `status` is `completed` or `error` using `waitUntilReady`:
 
 ```javascript
-const transcript = await client.transcripts.waitUntilReady(transcript.id,
-{
+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
@@ -109,7 +117,7 @@ const transcript = await client.transcripts.waitUntilReady(transcript.id,
 This will return a page of transcripts you created.
 
 ```javascript
-const page = await client.transcripts.list()
+const page = await client.transcripts.list();
 ```
 
 You can also paginate over all pages.
@@ -117,15 +125,15 @@ You can also paginate over all pages.
 ```typescript
 let nextPageUrl: string | null = null;
 do {
-  const page = await client.transcripts.list(nextPageUrl)
-  nextPageUrl = page.page_details.next_url
-} while(nextPageUrl !== null)
+  const page = await client.transcripts.list(nextPageUrl);
+  nextPageUrl = page.page_details.next_url;
+} while (nextPageUrl !== null);
 ```
 
 ## Delete a transcript
 
 ```javascript
-const res = await client.transcripts.delete(transcript.id)
+const res = await client.transcripts.delete(transcript.id);
 ```
 
 ## Use LeMUR
@@ -133,42 +141,46 @@ const res = await client.transcripts.delete(transcript.id)
 Call [LeMUR endpoints](https://www.assemblyai.com/docs/API%20reference/lemur) to summarize, ask questions, generate action items, or run a custom task.
 
 Custom Summary:
+
 ```javascript
 const { response } = await client.lemur.summary({
-  transcript_ids: ['0d295578-8c75-421a-885a-2c487f188927'],
-  answer_format: 'one sentence',
+  transcript_ids: ["0d295578-8c75-421a-885a-2c487f188927"],
+  answer_format: "one sentence",
   context: {
-    speakers: ['Alex', 'Bob'],
-  }
-})
+    speakers: ["Alex", "Bob"],
+  },
+});
 ```
 
 Question & Answer:
+
 ```javascript
 const { response } = await client.lemur.questionAnswer({
-  transcript_ids: ['0d295578-8c75-421a-885a-2c487f188927'],
+  transcript_ids: ["0d295578-8c75-421a-885a-2c487f188927"],
   questions: [
     {
-      question: 'What are they discussing?',
-      answer_format: 'text',
-    }
-  ]
-})
+      question: "What are they discussing?",
+      answer_format: "text",
+    },
+  ],
+});
 ```
 
 Action Items:
+
 ```javascript
 const { response } = await client.lemur.actionItems({
-  transcript_ids: ['0d295578-8c75-421a-885a-2c487f188927'],
-})
+  transcript_ids: ["0d295578-8c75-421a-885a-2c487f188927"],
+});
 ```
 
 Custom Task:
+
 ```javascript
 const { response } = await client.lemur.task({
-  transcript_ids: ['0d295578-8c75-421a-885a-2c487f188927'],
-  prompt: 'Write a haiku about this conversation.',
-})
+  transcript_ids: ["0d295578-8c75-421a-885a-2c487f188927"],
+  prompt: "Write a haiku about this conversation.",
+});
 ```
 
 ## Transcribe in real time
@@ -195,7 +207,7 @@ You can also generate a temporary auth token for real-time.
 ```typescript
 const token = await client.realtime.createTemporaryToken({ expires_in = 60 });
 const rt = client.realtime.createService({
-  token: token
+  token: token,
 });
 ```
 
@@ -205,6 +217,7 @@ const rt = client.realtime.createService({
 
 You can configure the following events.
 
+<!-- prettier-ignore -->
 ```typescript
 rt.on("open", ({ sessionId, expiresAt }) => console.log('Session ID:', sessionId, 'Expires at:', expiresAt));
 rt.on("close", (code: number, reason: string) => console.log('Closed', code, reason));
@@ -228,6 +241,7 @@ getAudio((chunk) => {
   rt.sendAudio(chunk);
 });
 ```
+
 Or send audio data via a stream by piping to the realtime stream.
 
 ```typescript

package/dist/index.esm.js

@@ -19,6 +19,18 @@ PERFORMANCE OF THIS SOFTWARE.
 /* global Reflect, Promise, SuppressedError, Symbol */
 
 
+function __rest(s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+}
+
 function __awaiter(thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -335,11 +347,55 @@ class TranscriptService extends BaseService {
         super(params);
         this.files = files;
     }
+    /**
+     * 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.
+     * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
+     */
+    transcribe(params, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const transcript = yield this.submit(params);
+            return yield this.waitUntilReady(transcript.id, options);
+        });
+    }
+    /**
+     * 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.
+     * @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);
+                }
+                else {
+                    // audio is not a local path, assume it's a URL
+                    audioUrl = audio;
+                }
+            }
+            else {
+                // audio is of uploadable type
+                audioUrl = yield this.files.upload(audio);
+            }
+            const data = yield this.fetchJson("/v2/transcript", {
+                method: "POST",
+                body: JSON.stringify(Object.assign(Object.assign({}, createParams), { audio_url: audioUrl })),
+            });
+            return data;
+        });
+    }
     /**
      * Create a 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 newly created 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;
@@ -359,6 +415,12 @@ class TranscriptService extends BaseService {
             return data;
         });
     }
+    /**
+     * 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.
+     * @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* () {

package/dist/index.js

@@ -21,6 +21,18 @@ PERFORMANCE OF THIS SOFTWARE.
 /* global Reflect, Promise, SuppressedError, Symbol */
 
 
+function __rest(s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+}
+
 function __awaiter(thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -337,11 +349,55 @@ class TranscriptService extends BaseService {
         super(params);
         this.files = files;
     }
+    /**
+     * 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.
+     * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
+     */
+    transcribe(params, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const transcript = yield this.submit(params);
+            return yield this.waitUntilReady(transcript.id, options);
+        });
+    }
+    /**
+     * 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.
+     * @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);
+                }
+                else {
+                    // audio is not a local path, assume it's a URL
+                    audioUrl = audio;
+                }
+            }
+            else {
+                // audio is of uploadable type
+                audioUrl = yield this.files.upload(audio);
+            }
+            const data = yield this.fetchJson("/v2/transcript", {
+                method: "POST",
+                body: JSON.stringify(Object.assign(Object.assign({}, createParams), { audio_url: audioUrl })),
+            });
+            return data;
+        });
+    }
     /**
      * Create a 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 newly created 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;
@@ -361,6 +417,12 @@ class TranscriptService extends BaseService {
             return data;
         });
     }
+    /**
+     * 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.
+     * @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* () {

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

@@ -1,10 +1,10 @@
 import { BaseService } from "../base";
-import { FileUploadParameters } from "../..";
+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.
      */
-    upload(input: FileUploadParameters): Promise<string>;
+    upload(input: FileUploadParams): Promise<string>;
 }

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

@@ -1,10 +1,10 @@
-import { LemurSummaryParameters, LemurActionItemsParameters, LemurQuestionAnswerParameters, LemurTaskParameters, LemurSummaryResponse, LemurQuestionAnswerResponse, LemurActionItemsResponse, LemurTaskResponse, PurgeLemurRequestDataResponse } from "../..";
+import { LemurSummaryParams, LemurActionItemsParams, LemurQuestionAnswerParams, LemurTaskParams, LemurSummaryResponse, LemurQuestionAnswerResponse, LemurActionItemsResponse, LemurTaskResponse, PurgeLemurRequestDataResponse } from "../..";
 import { BaseService } from "../base";
 export declare class LemurService extends BaseService {
-    summary(params: LemurSummaryParameters): Promise<LemurSummaryResponse>;
-    questionAnswer(params: LemurQuestionAnswerParameters): Promise<LemurQuestionAnswerResponse>;
-    actionItems(params: LemurActionItemsParameters): Promise<LemurActionItemsResponse>;
-    task(params: LemurTaskParameters): Promise<LemurTaskResponse>;
+    summary(params: LemurSummaryParams): Promise<LemurSummaryResponse>;
+    questionAnswer(params: LemurQuestionAnswerParams): Promise<LemurQuestionAnswerResponse>;
+    actionItems(params: LemurActionItemsParams): Promise<LemurActionItemsResponse>;
+    task(params: LemurTaskParams): Promise<LemurTaskResponse>;
     /**
      * Delete the data for a previously submitted LeMUR request.
      * @param id ID of the LeMUR request

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

@@ -1,16 +1,36 @@
 import { BaseService } from "../base";
-import { ParagraphsResponse, SentencesResponse, Transcript, TranscriptList, CreateTranscriptParameters, CreateTranscriptOptions, Createable, Deletable, Listable, Retrieveable, SubtitleFormat, RedactedAudioResponse, TranscriptListParameters, WordSearchResponse, BaseServiceParams, PollingOptions } from "../..";
+import { ParagraphsResponse, SentencesResponse, Transcript, TranscriptList, TranscriptParams, CreateTranscriptOptions, Createable, Deletable, Listable, Retrieveable, SubtitleFormat, RedactedAudioResponse, ListTranscriptParams, WordSearchResponse, BaseServiceParams, PollingOptions, TranscribeParams, TranscribeOptions, SubmitParams } from "../..";
 import { FileService } from "../files";
-export declare class TranscriptService extends BaseService implements Createable<Transcript, CreateTranscriptParameters, CreateTranscriptOptions>, Retrieveable<Transcript>, Deletable<Transcript>, Listable<TranscriptList> {
+export declare class TranscriptService extends BaseService implements Createable<Transcript, TranscriptParams, CreateTranscriptOptions>, Retrieveable<Transcript>, Deletable<Transcript>, Listable<TranscriptList> {
     private files;
     constructor(params: BaseServiceParams, files: FileService);
+    /**
+     * 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.
+     * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
+     */
+    transcribe(params: TranscribeParams, options?: TranscribeOptions): Promise<Transcript>;
+    /**
+     * 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.
+     * @returns A promise that resolves to the queued transcript.
+     */
+    submit(params: SubmitParams): Promise<Transcript>;
     /**
      * Create a 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 newly created 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: TranscriptParams, options?: CreateTranscriptOptions): Promise<Transcript>;
+    /**
+     * 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.
+     * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
      */
-    create(params: CreateTranscriptParameters, options?: CreateTranscriptOptions): Promise<Transcript>;
     waitUntilReady(transcriptId: string, options?: PollingOptions): Promise<Transcript>;
     /**
      * Retrieve a transcript.
@@ -22,7 +42,7 @@ export declare class TranscriptService extends BaseService implements Createable
      * 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.
      */
-    list(parameters?: TranscriptListParameters | string): Promise<TranscriptList>;
+    list(parameters?: ListTranscriptParams | string): Promise<TranscriptList>;
     /**
      * Delete a transcript
      * @param id The identifier of the transcript.

package/dist/types/deprecated.d.ts

@@ -0,0 +1,63 @@
+import { FileUploadParams } from "./files";
+import { CreateRealtimeTemporaryTokenParams, LemurActionItemsParams, LemurBaseParams, LemurQuestionAnswerParams, LemurSummaryParams, LemurTaskParams, ListTranscriptParams, TranscriptOptionalParams, TranscriptParams } from "./openapi.generated";
+import { SubmitParams, TranscribeParams } from "./transcripts";
+/**
+ * @deprecated
+ * Use`FileUploadParams` instead.
+ */
+export type FileUploadParameters = FileUploadParams;
+/**
+ * @deprecated
+ * Use`TranscribeParams` instead.
+ */
+export type TranscribeParameters = TranscribeParams;
+/**
+ * @deprecated
+ * Use`SubmitParams` instead.
+ */
+export type SubmitParameters = SubmitParams;
+/**
+ * @deprecated
+ * Use`CreateRealtimeTemporaryTokenParams` instead.
+ */
+export type CreateRealtimeTemporaryTokenParameters = CreateRealtimeTemporaryTokenParams;
+/**
+ * @deprecated
+ * Use`LemurActionItemsParams` instead.
+ */
+export type LemurActionItemsParameters = LemurActionItemsParams;
+/**
+ * @deprecated
+ * Use`LemurBaseParams` instead.
+ */
+export type LemurBaseParameters = LemurBaseParams;
+/**
+ * @deprecated
+ * Use`LemurQuestionAnswerParams` instead.
+ */
+export type LemurQuestionAnswerParameters = LemurQuestionAnswerParams;
+/**
+ * @deprecated
+ * Use`LemurSummaryParams` instead.
+ */
+export type LemurSummaryParameters = LemurSummaryParams;
+/**
+ * @deprecated
+ * Use`LemurTaskParams` instead.
+ */
+export type LemurTaskParameters = LemurTaskParams;
+/**
+ * @deprecated
+ * Use`ListTranscriptParams` instead.
+ */
+export type TranscriptListParameters = ListTranscriptParams;
+/**
+ * @deprecated
+ * Use`TranscriptOptionalParams` instead.
+ */
+export type CreateTranscriptOptionalParameters = TranscriptOptionalParams;
+/**
+ * @deprecated
+ * Use`TranscriptParams` instead.
+ */
+export type CreateTranscriptParameters = TranscriptParams;

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

@@ -1,4 +1,4 @@
 /// <reference types="node" />
-type FileUploadParameters = string | FileUploadData;
+type FileUploadParams = string | FileUploadData;
 type FileUploadData = NodeJS.ReadableStream | ReadableStream | Blob | BufferSource | ArrayBufferView | ArrayBufferLike | Uint8Array;
-export type { FileUploadParameters, FileUploadData };
+export type { FileUploadParams, FileUploadData };

package/dist/types/index.d.ts

@@ -4,3 +4,4 @@ export * from "./realtime";
 export * from "./services";
 export * from "./asyncapi.generated";
 export * from "./openapi.generated";
+export * from "./deprecated";