assemblyai 2.0.2-beta → 2.0.2

package/README.md

@@ -10,7 +10,6 @@
 [![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)
 
-
 # AssemblyAI Node.js SDK
 
 The AssemblyAI Node.js SDK provides an easy-to-use interface for interacting with the AssemblyAI API,
@@ -165,13 +164,13 @@ const { response } = await client.lemur.task({
 Create the real-time service.
 
 ```typescript
-const service = client.realtime.createService();
+const rt = client.realtime.createService();
 ```
 
 You can also pass in the following options.
 
 ```typescript
-const service = client.realtime.createService({
+const rt = client.realtime.createService({
   realtimeUrl: 'wss://localhost/override',
   apiKey: process.env.ASSEMBLYAI_API_KEY // The API key passed to `AssemblyAI` will be used by default,
   sampleRate: 16_000,
@@ -209,7 +208,7 @@ After configuring your events, connect to the server.
 await rt.connect();
 ```
 
-Send audio data.
+Send audio data via chunks.
 
 ```typescript
 // Pseudo code for getting audio
@@ -217,6 +216,11 @@ getAudio((chunk) => {
   rt.sendAudio(chunk);
 });
 ```
+Or send audio data via a stream by piping to the realtime stream.
+
+```typescript
+audioStream.pipe(rt.stream());
+```
 
 Close the connection when you're finished.
 

package/dist/index.esm.js

@@ -1,5 +1,6 @@
 import axios, { isAxiosError } from 'axios';
 import WebSocket from 'ws';
+import { Writable } from 'stream';
 import { readFile } from 'fs/promises';
 
 function createAxiosClient(params) {
@@ -88,6 +89,16 @@ class LemurService extends BaseService {
             return data;
         });
     }
+    /**
+     * Delete the data for a previously submitted LeMUR request.
+     * @param id ID of the LeMUR request
+     */
+    purgeRequestData(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.client.delete(`/lemur/v3/${id}`);
+            return data;
+        });
+    }
 }
 
 var RealtimeErrorType;
@@ -246,6 +257,15 @@ class RealtimeService {
         };
         this.socket.send(JSON.stringify(payload));
     }
+    stream() {
+        const stream = new Writable({
+            write: (chunk, encoding, next) => {
+                this.sendAudio(chunk);
+                next();
+            },
+        });
+        return stream;
+    }
     close(waitForSessionTermination = true) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.socket) {
@@ -378,6 +398,23 @@ class TranscriptService extends BaseService {
             return res.data;
         });
     }
+    /**
+     * 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 id Keywords to search for.
+     * @return A promise that resolves to the sentences.
+     */
+    wordSearch(id, words) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.client.get(`/v2/transcript/${id}/word-search`, {
+                params: {
+                    words: JSON.stringify(words),
+                },
+            });
+            return data;
+        });
+    }
     /**
      * Retrieve all sentences of a transcript.
      * @param id The identifier of the transcript.

package/dist/index.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var axios = require('axios');
 var WebSocket = require('ws');
+var stream = require('stream');
 var promises = require('fs/promises');
 
 function createAxiosClient(params) {
@@ -92,6 +93,16 @@ class LemurService extends BaseService {
             return data;
         });
     }
+    /**
+     * Delete the data for a previously submitted LeMUR request.
+     * @param id ID of the LeMUR request
+     */
+    purgeRequestData(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.client.delete(`/lemur/v3/${id}`);
+            return data;
+        });
+    }
 }
 
 var RealtimeErrorType;
@@ -250,6 +261,15 @@ class RealtimeService {
         };
         this.socket.send(JSON.stringify(payload));
     }
+    stream() {
+        const stream$1 = new stream.Writable({
+            write: (chunk, encoding, next) => {
+                this.sendAudio(chunk);
+                next();
+            },
+        });
+        return stream$1;
+    }
     close(waitForSessionTermination = true) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.socket) {
@@ -382,6 +402,23 @@ class TranscriptService extends BaseService {
             return res.data;
         });
     }
+    /**
+     * 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 id Keywords to search for.
+     * @return A promise that resolves to the sentences.
+     */
+    wordSearch(id, words) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.client.get(`/v2/transcript/${id}/word-search`, {
+                params: {
+                    words: JSON.stringify(words),
+                },
+            });
+            return data;
+        });
+    }
     /**
      * Retrieve all sentences of a transcript.
      * @param id The identifier of the transcript.

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

@@ -1,8 +1,13 @@
-import { LemurSummaryParameters, LemurActionItemsParameters, LemurQuestionAnswerParameters, LemurTaskParameters, LemurSummaryResponse, LemurQuestionAnswerResponse, LemurActionItemsResponse, LemurTaskResponse } from "@/types";
+import { LemurSummaryParameters, LemurActionItemsParameters, LemurQuestionAnswerParameters, LemurTaskParameters, LemurSummaryResponse, LemurQuestionAnswerResponse, LemurActionItemsResponse, LemurTaskResponse, PurgeLemurRequestDataResponse } from "@/types";
 import { BaseService } from "@/services/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>;
+    /**
+     * Delete the data for a previously submitted LeMUR request.
+     * @param id ID of the LeMUR request
+     */
+    purgeRequestData(id: string): Promise<PurgeLemurRequestDataResponse>;
 }

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

@@ -1,4 +1,6 @@
+/// <reference types="node" />
 import { RealtimeServiceParams, RealtimeTranscript, PartialTranscript, FinalTranscript, SessionBeginsEventData } from "@/types";
+import { Writable } from "stream";
 export declare class RealtimeService {
     private realtimeUrl;
     private sampleRate;
@@ -18,5 +20,6 @@ export declare class RealtimeService {
     on(event: "close", listener: (code: number, reason: string) => void): void;
     connect(): Promise<SessionBeginsEventData>;
     sendAudio(audio: ArrayBuffer): void;
+    stream(): Writable;
     close(waitForSessionTermination?: boolean): Promise<void>;
 }

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

@@ -1,5 +1,5 @@
 import { BaseService } from "@/services/base";
-import { ParagraphsResponse, SentencesResponse, Transcript, TranscriptList, CreateTranscriptParameters, CreateTranscriptOptions, Createable, Deletable, Listable, Retrieveable, SubtitleFormat, RedactedAudioResponse } from "@/types";
+import { ParagraphsResponse, SentencesResponse, Transcript, TranscriptList, CreateTranscriptParameters, CreateTranscriptOptions, Createable, Deletable, Listable, Retrieveable, SubtitleFormat, RedactedAudioResponse, WordSearchResponse } from "@/types";
 import { AxiosInstance } from "axios";
 import { FileService } from "../files";
 export declare class TranscriptService extends BaseService implements Createable<Transcript, CreateTranscriptParameters, CreateTranscriptOptions>, Retrieveable<Transcript>, Deletable<Transcript>, Listable<TranscriptList> {
@@ -31,6 +31,14 @@ export declare class TranscriptService extends BaseService implements Createable
      * @returns A promise that resolves to the transcript.
      */
     delete(id: string): Promise<Transcript>;
+    /**
+     * 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 id Keywords to search for.
+     * @return A promise that resolves to the sentences.
+     */
+    wordSearch(id: string, words: string[]): Promise<WordSearchResponse>;
     /**
      * Retrieve all sentences of a transcript.
      * @param id The identifier of the transcript.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "2.0.2-beta",
+  "version": "2.0.2",
   "description": "The AssemblyAI Node.js 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.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -11,7 +11,7 @@
     "url": "git+https://github.com/AssemblyAI/assemblyai-node-sdk.git"
   },
   "publishConfig": {
-    "tag": "beta",
+    "tag": "latest",
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },

package/src/services/lemur/index.ts

@@ -7,6 +7,7 @@ import {
   LemurQuestionAnswerResponse,
   LemurActionItemsResponse,
   LemurTaskResponse,
+  PurgeLemurRequestDataResponse,
 } from "@/types";
 import { BaseService } from "@/services/base";
 
@@ -46,4 +47,15 @@ export class LemurService extends BaseService {
     );
     return data;
   }
+
+  /**
+   * Delete the data for a previously submitted LeMUR request.
+   * @param id ID of the LeMUR request
+   */
+  async purgeRequestData(id: string): Promise<PurgeLemurRequestDataResponse> {
+    const { data } = await this.client.delete<PurgeLemurRequestDataResponse>(
+      `/lemur/v3/${id}`
+    );
+    return data;
+  }
 }

package/src/services/realtime/service.ts

@@ -14,6 +14,7 @@ import {
   RealtimeErrorMessages,
   RealtimeErrorType,
 } from "@/utils/errors";
+import { Writable } from "stream";
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 
@@ -161,6 +162,16 @@ export class RealtimeService {
     this.socket.send(JSON.stringify(payload));
   }
 
+  stream(): Writable {
+    const stream = new Writable({
+      write: (chunk: Buffer, encoding, next) => {
+        this.sendAudio(chunk);
+        next();
+      },
+    });
+    return stream;
+  }
+
   async close(waitForSessionTermination = true) {
     if (this.socket) {
       if (this.socket.readyState === WebSocket.OPEN) {

package/src/services/transcripts/index.ts

@@ -12,6 +12,7 @@ import {
   Retrieveable,
   SubtitleFormat,
   RedactedAudioResponse,
+  WordSearchResponse,
 } from "@/types";
 import { AxiosInstance } from "axios";
 import { FileService } from "../files";
@@ -116,6 +117,25 @@ export class TranscriptService
     return res.data;
   }
 
+  /**
+   * 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 id Keywords to search for.
+   * @return A promise that resolves to the sentences.
+   */
+  async wordSearch(id: string, words: string[]): Promise<WordSearchResponse> {
+    const { data } = await this.client.get<WordSearchResponse>(
+      `/v2/transcript/${id}/word-search`,
+      {
+        params: {
+          words: JSON.stringify(words),
+        },
+      }
+    );
+    return data;
+  }
+
   /**
    * Retrieve all sentences of a transcript.
    * @param id The identifier of the transcript.