Merge pull request #106 from AssemblyAI/A94C23FD55A9C0ABC92E0EFBBB78972C

4.17.0

Author: mattgefen-aai

.prettierignore

@@ -16,5 +16,6 @@ BUILD.bazel
 copy.bara.sky
 copybara.sh
 .env
+**/.env.sample
 temp
 temp-docs

package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.16.1",
+  "version": "4.17.0",
   "description": "The AssemblyAI JavaScript SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async and real-time transcription, as well as the latest LeMUR models.",
   "engines": {
     "node": ">=18"

src/services/lemur/index.ts

@@ -13,62 +13,83 @@ import {
 import { BaseService } from "../base";
 
 export class LemurService extends BaseService {
-  summary(params: LemurSummaryParams): Promise<LemurSummaryResponse> {
+  summary(
+    params: LemurSummaryParams,
+    signal?: AbortSignal,
+  ): Promise<LemurSummaryResponse> {
     return this.fetchJson<LemurSummaryResponse>("/lemur/v3/generate/summary", {
       method: "POST",
       body: JSON.stringify(params),
+      signal,
     });
   }
 
   questionAnswer(
     params: LemurQuestionAnswerParams,
+    signal?: AbortSignal,
   ): Promise<LemurQuestionAnswerResponse> {
     return this.fetchJson<LemurQuestionAnswerResponse>(
       "/lemur/v3/generate/question-answer",
       {
         method: "POST",
         body: JSON.stringify(params),
+        signal,
       },
     );
   }
 
   actionItems(
     params: LemurActionItemsParams,
+    signal?: AbortSignal,
   ): Promise<LemurActionItemsResponse> {
     return this.fetchJson<LemurActionItemsResponse>(
       "/lemur/v3/generate/action-items",
       {
         method: "POST",
         body: JSON.stringify(params),
+        signal,
       },
     );
   }
 
-  task(params: LemurTaskParams): Promise<LemurTaskResponse> {
+  task(
+    params: LemurTaskParams,
+    signal?: AbortSignal,
+  ): Promise<LemurTaskResponse> {
     return this.fetchJson<LemurTaskResponse>("/lemur/v3/generate/task", {
       method: "POST",
       body: JSON.stringify(params),
+      signal,
     });
   }
 
   /**
    * Retrieve a LeMUR response that was previously generated.
    * @param id - The ID of the LeMUR request you previously made. This would be found in the response of the original request.
+   * @param signal - Optional AbortSignal to cancel the request
    * @returns The LeMUR response.
    */
-  getResponse<T extends LemurResponse>(id: string): Promise<T>;
-  getResponse(id: string): Promise<LemurResponse>;
-  getResponse(id: string): Promise<LemurResponse> {
-    return this.fetchJson<LemurResponse>(`/lemur/v3/${id}`);
+  getResponse<T extends LemurResponse>(
+    id: string,
+    signal?: AbortSignal,
+  ): Promise<T>;
+  getResponse(id: string, signal?: AbortSignal): Promise<LemurResponse>;
+  getResponse(id: string, signal?: AbortSignal): Promise<LemurResponse> {
+    return this.fetchJson<LemurResponse>(`/lemur/v3/${id}`, { signal });
   }
 
   /**
    * Delete the data for a previously submitted LeMUR request.
    * @param id - ID of the LeMUR request
+   * @param signal - Optional AbortSignal to cancel the request
    */
-  purgeRequestData(id: string): Promise<PurgeLemurRequestDataResponse> {
+  purgeRequestData(
+    id: string,
+    signal?: AbortSignal,
+  ): Promise<PurgeLemurRequestDataResponse> {
     return this.fetchJson<PurgeLemurRequestDataResponse>(`/lemur/v3/${id}`, {
       method: "DELETE",
+      signal,
     });
   }
 }

src/services/streaming/service.ts

@@ -118,7 +118,10 @@ export class StreamingTranscriber {
     }
 
     if (this.params.filterProfanity) {
-      searchParams.set("filter_profanity", this.params.filterProfanity.toString());
+      searchParams.set(
+        "filter_profanity",
+        this.params.filterProfanity.toString(),
+      );
     }
 
     url.search = searchParams.toString();

tests/integration/lemur.test.ts

@@ -101,4 +101,41 @@ describe("lemur", () => {
     expect(deletionRequest.deleted).toBeTruthy();
     expect(deletionRequest.request_id_to_purge).toBe(request_id);
   });
+
+  it("should abort a summary request", async () => {
+    const controller = new AbortController();
+
+    // Start the request
+    const promise = client.lemur.summary(
+      {
+        final_model: "basic",
+        transcript_ids: knownTranscriptIds,
+        answer_format: "one sentence",
+      },
+      controller.signal,
+    );
+
+    // Abort immediately
+    controller.abort();
+
+    // Should throw an error
+    await expect(promise).rejects.toThrow();
+  });
+
+  it("should abort a task request", async () => {
+    const controller = new AbortController();
+
+    const promise = client.lemur.task(
+      {
+        final_model: "basic",
+        transcript_ids: knownTranscriptIds,
+        prompt: "Write a haiku about this conversation.",
+      },
+      controller.signal,
+    );
+
+    controller.abort();
+
+    await expect(promise).rejects.toThrow();
+  });
 });