@livekit/agents-plugin-deepgram 0.4.6 → 0.5.1

package/README.md

@@ -0,0 +1,17 @@
+<!--
+SPDX-FileCopyrightText: 2024 LiveKit, Inc.
+
+SPDX-License-Identifier: Apache-2.0
+-->
+# Deepgram plugin for LiveKit Agents
+
+The Agents Framework is designed for building realtime, programmable
+participants that run on servers. Use it to create conversational, multi-modal
+voice agents that can see, hear, and understand.
+
+This package contains the Deepgram plugin, which allows for speech recognition.
+Refer to the [documentation](https://docs.livekit.io/agents/overview/) for
+information on how to use it, or browse the [API
+reference](https://docs.livekit.io/agents-js/modules/plugins_agents_plugin_deepgram.html).
+See the [repository](https://github.com/livekit/agents-js) for more information
+about the framework as a whole.

package/dist/index.cjs

@@ -0,0 +1,23 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+__reExport(src_exports, require("./stt.cjs"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./stt.cjs")
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\n\nexport * from './stt.js';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAIA,wBAAc,qBAJd;","names":[]}

package/dist/index.js

@@ -1,5 +1,2 @@
-// SPDX-FileCopyrightText: 2024 LiveKit, Inc.
-//
-// SPDX-License-Identifier: Apache-2.0
-export * from './stt.js';
+export * from "./stt.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,EAAE;AACF,sCAAsC;AAEtC,cAAc,UAAU,CAAC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\n\nexport * from './stt.js';\n"],"mappings":"AAIA,cAAc;","names":[]}

package/dist/models.cjs

@@ -0,0 +1,17 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var models_exports = {};
+module.exports = __toCommonJS(models_exports);
+//# sourceMappingURL=models.cjs.map

package/dist/models.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/models.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\n\nexport type STTModels =\n  | 'nova-general'\n  | 'nova-phonecall'\n  | 'nova-meeting'\n  | 'nova-2-general'\n  | 'nova-2-meeting'\n  | 'nova-2-phonecall'\n  | 'nova-2-finance'\n  | 'nova-2-conversationalai'\n  | 'nova-2-voicemail'\n  | 'nova-2-video'\n  | 'nova-2-medical'\n  | 'nova-2-drivethru'\n  | 'nova-2-automotive'\n  | 'enhanced-general'\n  | 'enhanced-meeting'\n  | 'enhanced-phonecall'\n  | 'enhanced-finance'\n  | 'base'\n  | 'meeting'\n  | 'phonecall'\n  | 'finance'\n  | 'conversationalai'\n  | 'voicemail'\n  | 'video'\n  | 'whisper-tiny'\n  | 'whisper-base'\n  | 'whisper-small'\n  | 'whisper-medium'\n  | 'whisper-large';\n\nexport type STTLanguages =\n  | 'da'\n  | 'de'\n  | 'en'\n  | 'en-AU'\n  | 'en-GB'\n  | 'en-IN'\n  | 'en-NZ'\n  | 'en-US'\n  | 'es'\n  | 'es-419'\n  | 'es-LATAM'\n  | 'fr'\n  | 'fr-CA'\n  | 'hi'\n  | 'hi-Latn'\n  | 'id'\n  | 'it'\n  | 'ja'\n  | 'ko'\n  | 'nl'\n  | 'no'\n  | 'pl'\n  | 'pt'\n  | 'pt-BR'\n  | 'ru'\n  | 'sv'\n  | 'ta'\n  | 'taq'\n  | 'th'\n  | 'tr'\n  | 'uk'\n  | 'zh'\n  | 'zh-CN'\n  | 'zh-TW';\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/models.js

@@ -1,5 +1 @@
-// SPDX-FileCopyrightText: 2024 LiveKit, Inc.
-//
-// SPDX-License-Identifier: Apache-2.0
-export {};
 //# sourceMappingURL=models.js.map

package/dist/models.js.map

@@ -1 +1 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../src/models.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,EAAE;AACF,sCAAsC"}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/stt.cjs

@@ -0,0 +1,274 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var stt_exports = {};
+__export(stt_exports, {
+  STT: () => STT,
+  SpeechStream: () => SpeechStream
+});
+module.exports = __toCommonJS(stt_exports);
+var import_agents = require("@livekit/agents");
+var import_ws = require("ws");
+const API_BASE_URL_V1 = "wss://api.deepgram.com/v1/listen";
+const defaultSTTOptions = {
+  apiKey: process.env.DEEPGRAM_API_KEY,
+  language: "en-US",
+  detectLanguage: false,
+  interimResults: true,
+  punctuate: true,
+  model: "nova-2-general",
+  smartFormat: true,
+  noDelay: true,
+  endpointing: 25,
+  fillerWords: false,
+  sampleRate: 16e3,
+  numChannels: 1,
+  keywords: [],
+  profanityFilter: false
+};
+class STT extends import_agents.stt.STT {
+  #opts;
+  #logger = (0, import_agents.log)();
+  label = "deepgram.STT";
+  constructor(opts = defaultSTTOptions) {
+    super({
+      streaming: true,
+      interimResults: opts.interimResults ?? defaultSTTOptions.interimResults
+    });
+    if (opts.apiKey === void 0 && defaultSTTOptions.apiKey === void 0) {
+      throw new Error(
+        "Deepgram API key is required, whether as an argument or as $DEEPGRAM_API_KEY"
+      );
+    }
+    this.#opts = { ...defaultSTTOptions, ...opts };
+    if (this.#opts.detectLanguage) {
+      this.#opts.language = void 0;
+    } else if (this.#opts.language && !["en-US", "en"].includes(this.#opts.language) && [
+      "nova-2-meeting",
+      "nova-2-phonecall",
+      "nova-2-finance",
+      "nova-2-conversationalai",
+      "nova-2-voicemail",
+      "nova-2-video",
+      "nova-2-medical",
+      "nova-2-drivethru",
+      "nova-2-automotive"
+    ].includes(this.#opts.model)) {
+      this.#logger.warn(
+        `${this.#opts.model} does not support language ${this.#opts.language}, falling back to nova-2-general`
+      );
+      this.#opts.model = "nova-2-general";
+    }
+  }
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async _recognize(_) {
+    throw new Error("Recognize is not supported on Deepgram STT");
+  }
+  stream() {
+    return new SpeechStream(this, this.#opts);
+  }
+}
+class SpeechStream extends import_agents.stt.SpeechStream {
+  #opts;
+  #audioEnergyFilter;
+  #logger = (0, import_agents.log)();
+  #speaking = false;
+  label = "deepgram.SpeechStream";
+  constructor(stt2, opts) {
+    super(stt2);
+    this.#opts = opts;
+    this.closed = false;
+    this.#audioEnergyFilter = new import_agents.AudioEnergyFilter();
+    this.#run();
+  }
+  async #run(maxRetry = 32) {
+    let retries = 0;
+    let ws;
+    while (!this.input.closed) {
+      const streamURL = new URL(API_BASE_URL_V1);
+      const params = {
+        model: this.#opts.model,
+        punctuate: this.#opts.punctuate,
+        smart_format: this.#opts.smartFormat,
+        no_delay: this.#opts.noDelay,
+        interim_results: this.#opts.interimResults,
+        encoding: "linear16",
+        vad_events: true,
+        sample_rate: this.#opts.sampleRate,
+        channels: this.#opts.numChannels,
+        endpointing: this.#opts.endpointing || false,
+        filler_words: this.#opts.fillerWords,
+        keywords: this.#opts.keywords.map((x) => x.join(":")),
+        profanity_filter: this.#opts.profanityFilter,
+        language: this.#opts.language
+      };
+      Object.entries(params).forEach(([k, v]) => {
+        if (v !== void 0) {
+          if (typeof v === "string" || typeof v === "number" || typeof v === "boolean") {
+            streamURL.searchParams.append(k, encodeURIComponent(v));
+          } else {
+            v.forEach((x) => streamURL.searchParams.append("keywords", encodeURIComponent(x)));
+          }
+        }
+      });
+      ws = new import_ws.WebSocket(streamURL, {
+        headers: { Authorization: `Token ${this.#opts.apiKey}` }
+      });
+      try {
+        await new Promise((resolve, reject) => {
+          ws.on("open", resolve);
+          ws.on("error", (error) => reject(error));
+          ws.on("close", (code) => reject(`WebSocket returned ${code}`));
+        });
+        await this.#runWS(ws);
+      } catch (e) {
+        if (retries >= maxRetry) {
+          throw new Error(`failed to connect to Deepgram after ${retries} attempts: ${e}`);
+        }
+        const delay = Math.min(retries * 5, 10);
+        retries++;
+        this.#logger.warn(
+          `failed to connect to Deepgram, retrying in ${delay} seconds: ${e} (${retries}/${maxRetry})`
+        );
+        await new Promise((resolve) => setTimeout(resolve, delay * 1e3));
+      }
+    }
+    this.closed = true;
+  }
+  async #runWS(ws) {
+    let closing = false;
+    const keepalive = setInterval(() => {
+      try {
+        ws.send(JSON.stringify({ type: "KeepAlive" }));
+      } catch {
+        clearInterval(keepalive);
+        return;
+      }
+    }, 5e3);
+    const sendTask = async () => {
+      const samples100Ms = Math.floor(this.#opts.sampleRate / 10);
+      const stream = new import_agents.AudioByteStream(
+        this.#opts.sampleRate,
+        this.#opts.numChannels,
+        samples100Ms
+      );
+      for await (const data of this.input) {
+        let frames;
+        if (data === SpeechStream.FLUSH_SENTINEL) {
+          frames = stream.flush();
+        } else if (data.sampleRate === this.#opts.sampleRate || data.channels === this.#opts.numChannels) {
+          frames = stream.write(data.data.buffer);
+        } else {
+          throw new Error(`sample rate or channel count of frame does not match`);
+        }
+        for await (const frame of frames) {
+          if (this.#audioEnergyFilter.pushFrame(frame)) {
+            ws.send(frame.data.buffer);
+          }
+        }
+      }
+      closing = true;
+      ws.send(JSON.stringify({ type: "CloseStream" }));
+    };
+    const listenTask = async () => {
+      new Promise(
+        (_, reject) => ws.once("close", (code, reason) => {
+          if (!closing) {
+            this.#logger.error(`WebSocket closed with code ${code}: ${reason}`);
+            reject();
+          }
+        })
+      );
+      while (!this.closed) {
+        try {
+          await new Promise((resolve) => {
+            ws.once("message", (data) => resolve(data));
+          }).then((msg) => {
+            const json = JSON.parse(msg.toString());
+            switch (json["type"]) {
+              case "SpeechStarted": {
+                if (this.#speaking) return;
+                this.#speaking = true;
+                this.queue.put({ type: import_agents.stt.SpeechEventType.START_OF_SPEECH });
+                break;
+              }
+              // see this page:
+              // https://developers.deepgram.com/docs/understand-endpointing-interim-results#using-endpointing-speech_final
+              // for more information about the different types of events
+              case "Results": {
+                const isFinal = json["is_final"];
+                const isEndpoint = json["speech_final"];
+                const alternatives = liveTranscriptionToSpeechData(this.#opts.language, json);
+                if (alternatives[0] && alternatives[0].text) {
+                  if (!this.#speaking) {
+                    this.#speaking = true;
+                    this.queue.put({ type: import_agents.stt.SpeechEventType.START_OF_SPEECH });
+                  }
+                  if (isFinal) {
+                    this.queue.put({
+                      type: import_agents.stt.SpeechEventType.FINAL_TRANSCRIPT,
+                      alternatives: [alternatives[0], ...alternatives.slice(1)]
+                    });
+                  } else {
+                    this.queue.put({
+                      type: import_agents.stt.SpeechEventType.INTERIM_TRANSCRIPT,
+                      alternatives: [alternatives[0], ...alternatives.slice(1)]
+                    });
+                  }
+                }
+                if (isEndpoint && this.#speaking) {
+                  this.#speaking = false;
+                  this.queue.put({ type: import_agents.stt.SpeechEventType.END_OF_SPEECH });
+                }
+                break;
+              }
+              case "Metadata": {
+                break;
+              }
+              default: {
+                this.#logger.child({ msg: json }).warn("received unexpected message from Deepgram");
+                break;
+              }
+            }
+          });
+        } catch (error) {
+          this.#logger.child({ error }).warn("unrecoverable error, exiting");
+          break;
+        }
+      }
+    };
+    await Promise.all([sendTask(), listenTask()]);
+    clearInterval(keepalive);
+  }
+}
+const liveTranscriptionToSpeechData = (language, data) => {
+  const alts = data["channel"]["alternatives"];
+  return alts.map((alt) => ({
+    language,
+    startTime: alt["words"].length ? alt["words"][0]["start"] : 0,
+    endTime: alt["words"].length ? alt["words"][alt["words"].length - 1]["end"] : 0,
+    confidence: alt["confidence"],
+    text: alt["transcript"]
+  }));
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  STT,
+  SpeechStream
+});
+//# sourceMappingURL=stt.cjs.map

package/dist/stt.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/stt.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport { type AudioBuffer, AudioByteStream, AudioEnergyFilter, log, stt } from '@livekit/agents';\nimport type { AudioFrame } from '@livekit/rtc-node';\nimport { type RawData, WebSocket } from 'ws';\nimport type { STTLanguages, STTModels } from './models.js';\n\nconst API_BASE_URL_V1 = 'wss://api.deepgram.com/v1/listen';\n\nexport interface STTOptions {\n  apiKey?: string;\n  language?: STTLanguages | string;\n  detectLanguage: boolean;\n  interimResults: boolean;\n  punctuate: boolean;\n  model: STTModels;\n  smartFormat: boolean;\n  noDelay: boolean;\n  endpointing: number;\n  fillerWords: boolean;\n  sampleRate: number;\n  numChannels: number;\n  keywords: [string, number][];\n  profanityFilter: boolean;\n}\n\nconst defaultSTTOptions: STTOptions = {\n  apiKey: process.env.DEEPGRAM_API_KEY,\n  language: 'en-US',\n  detectLanguage: false,\n  interimResults: true,\n  punctuate: true,\n  model: 'nova-2-general',\n  smartFormat: true,\n  noDelay: true,\n  endpointing: 25,\n  fillerWords: false,\n  sampleRate: 16000,\n  numChannels: 1,\n  keywords: [],\n  profanityFilter: false,\n};\n\nexport class STT extends stt.STT {\n  #opts: STTOptions;\n  #logger = log();\n  label = 'deepgram.STT';\n\n  constructor(opts: Partial<STTOptions> = defaultSTTOptions) {\n    super({\n      streaming: true,\n      interimResults: opts.interimResults ?? defaultSTTOptions.interimResults,\n    });\n    if (opts.apiKey === undefined && defaultSTTOptions.apiKey === undefined) {\n      throw new Error(\n        'Deepgram API key is required, whether as an argument or as $DEEPGRAM_API_KEY',\n      );\n    }\n\n    this.#opts = { ...defaultSTTOptions, ...opts };\n\n    if (this.#opts.detectLanguage) {\n      this.#opts.language = undefined;\n    } else if (\n      this.#opts.language &&\n      !['en-US', 'en'].includes(this.#opts.language) &&\n      [\n        'nova-2-meeting',\n        'nova-2-phonecall',\n        'nova-2-finance',\n        'nova-2-conversationalai',\n        'nova-2-voicemail',\n        'nova-2-video',\n        'nova-2-medical',\n        'nova-2-drivethru',\n        'nova-2-automotive',\n      ].includes(this.#opts.model)\n    ) {\n      this.#logger.warn(\n        `${this.#opts.model} does not support language ${this.#opts.language}, falling back to nova-2-general`,\n      );\n      this.#opts.model = 'nova-2-general';\n    }\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  async _recognize(_: AudioBuffer): Promise<stt.SpeechEvent> {\n    throw new Error('Recognize is not supported on Deepgram STT');\n  }\n\n  stream(): stt.SpeechStream {\n    return new SpeechStream(this, this.#opts);\n  }\n}\n\nexport class SpeechStream extends stt.SpeechStream {\n  #opts: STTOptions;\n  #audioEnergyFilter: AudioEnergyFilter;\n  #logger = log();\n  #speaking = false;\n  label = 'deepgram.SpeechStream';\n\n  constructor(stt: STT, opts: STTOptions) {\n    super(stt);\n    this.#opts = opts;\n    this.closed = false;\n    this.#audioEnergyFilter = new AudioEnergyFilter();\n\n    this.#run();\n  }\n\n  async #run(maxRetry = 32) {\n    let retries = 0;\n    let ws: WebSocket;\n    while (!this.input.closed) {\n      const streamURL = new URL(API_BASE_URL_V1);\n      const params = {\n        model: this.#opts.model,\n        punctuate: this.#opts.punctuate,\n        smart_format: this.#opts.smartFormat,\n        no_delay: this.#opts.noDelay,\n        interim_results: this.#opts.interimResults,\n        encoding: 'linear16',\n        vad_events: true,\n        sample_rate: this.#opts.sampleRate,\n        channels: this.#opts.numChannels,\n        endpointing: this.#opts.endpointing || false,\n        filler_words: this.#opts.fillerWords,\n        keywords: this.#opts.keywords.map((x) => x.join(':')),\n        profanity_filter: this.#opts.profanityFilter,\n        language: this.#opts.language,\n      };\n      Object.entries(params).forEach(([k, v]) => {\n        if (v !== undefined) {\n          if (typeof v === 'string' || typeof v === 'number' || typeof v === 'boolean') {\n            streamURL.searchParams.append(k, encodeURIComponent(v));\n          } else {\n            v.forEach((x) => streamURL.searchParams.append('keywords', encodeURIComponent(x)));\n          }\n        }\n      });\n\n      ws = new WebSocket(streamURL, {\n        headers: { Authorization: `Token ${this.#opts.apiKey}` },\n      });\n\n      try {\n        await new Promise((resolve, reject) => {\n          ws.on('open', resolve);\n          ws.on('error', (error) => reject(error));\n          ws.on('close', (code) => reject(`WebSocket returned ${code}`));\n        });\n\n        await this.#runWS(ws);\n      } catch (e) {\n        if (retries >= maxRetry) {\n          throw new Error(`failed to connect to Deepgram after ${retries} attempts: ${e}`);\n        }\n\n        const delay = Math.min(retries * 5, 10);\n        retries++;\n\n        this.#logger.warn(\n          `failed to connect to Deepgram, retrying in ${delay} seconds: ${e} (${retries}/${maxRetry})`,\n        );\n        await new Promise((resolve) => setTimeout(resolve, delay * 1000));\n      }\n    }\n\n    this.closed = true;\n  }\n\n  async #runWS(ws: WebSocket) {\n    let closing = false;\n\n    const keepalive = setInterval(() => {\n      try {\n        ws.send(JSON.stringify({ type: 'KeepAlive' }));\n      } catch {\n        clearInterval(keepalive);\n        return;\n      }\n    }, 5000);\n\n    const sendTask = async () => {\n      const samples100Ms = Math.floor(this.#opts.sampleRate / 10);\n      const stream = new AudioByteStream(\n        this.#opts.sampleRate,\n        this.#opts.numChannels,\n        samples100Ms,\n      );\n\n      for await (const data of this.input) {\n        let frames: AudioFrame[];\n        if (data === SpeechStream.FLUSH_SENTINEL) {\n          frames = stream.flush();\n        } else if (\n          data.sampleRate === this.#opts.sampleRate ||\n          data.channels === this.#opts.numChannels\n        ) {\n          frames = stream.write(data.data.buffer);\n        } else {\n          throw new Error(`sample rate or channel count of frame does not match`);\n        }\n\n        for await (const frame of frames) {\n          if (this.#audioEnergyFilter.pushFrame(frame)) {\n            ws.send(frame.data.buffer);\n          }\n        }\n      }\n\n      closing = true;\n      ws.send(JSON.stringify({ type: 'CloseStream' }));\n    };\n\n    const listenTask = async () => {\n      new Promise<void>((_, reject) =>\n        ws.once('close', (code, reason) => {\n          if (!closing) {\n            this.#logger.error(`WebSocket closed with code ${code}: ${reason}`);\n            reject();\n          }\n        }),\n      );\n\n      while (!this.closed) {\n        try {\n          await new Promise<RawData>((resolve) => {\n            ws.once('message', (data) => resolve(data));\n          }).then((msg) => {\n            const json = JSON.parse(msg.toString());\n            switch (json['type']) {\n              case 'SpeechStarted': {\n                // This is a normal case. Deepgram's SpeechStarted events\n                // are not correlated with speech_final or utterance end.\n                // It's possible that we receive two in a row without an endpoint\n                // It's also possible we receive a transcript without a SpeechStarted event.\n                if (this.#speaking) return;\n                this.#speaking = true;\n                this.queue.put({ type: stt.SpeechEventType.START_OF_SPEECH });\n                break;\n              }\n              // see this page:\n              // https://developers.deepgram.com/docs/understand-endpointing-interim-results#using-endpointing-speech_final\n              // for more information about the different types of events\n              case 'Results': {\n                const isFinal = json['is_final'];\n                const isEndpoint = json['speech_final'];\n\n                const alternatives = liveTranscriptionToSpeechData(this.#opts.language!, json);\n\n                // If, for some reason, we didn't get a SpeechStarted event but we got\n                // a transcript with text, we should start speaking. It's rare but has\n                // been observed.\n                if (alternatives[0] && alternatives[0].text) {\n                  if (!this.#speaking) {\n                    this.#speaking = true;\n                    this.queue.put({ type: stt.SpeechEventType.START_OF_SPEECH });\n                  }\n\n                  if (isFinal) {\n                    this.queue.put({\n                      type: stt.SpeechEventType.FINAL_TRANSCRIPT,\n                      alternatives: [alternatives[0], ...alternatives.slice(1)],\n                    });\n                  } else {\n                    this.queue.put({\n                      type: stt.SpeechEventType.INTERIM_TRANSCRIPT,\n                      alternatives: [alternatives[0], ...alternatives.slice(1)],\n                    });\n                  }\n                }\n\n                // if we receive an endpoint, only end the speech if\n                // we either had a SpeechStarted event or we have a seen\n                // a non-empty transcript (deepgram doesn't have a SpeechEnded event)\n                if (isEndpoint && this.#speaking) {\n                  this.#speaking = false;\n                  this.queue.put({ type: stt.SpeechEventType.END_OF_SPEECH });\n                }\n\n                break;\n              }\n              case 'Metadata': {\n                break;\n              }\n              default: {\n                this.#logger.child({ msg: json }).warn('received unexpected message from Deepgram');\n                break;\n              }\n            }\n          });\n        } catch (error) {\n          this.#logger.child({ error }).warn('unrecoverable error, exiting');\n          break;\n        }\n      }\n    };\n\n    await Promise.all([sendTask(), listenTask()]);\n    clearInterval(keepalive);\n  }\n}\n\nconst liveTranscriptionToSpeechData = (\n  language: STTLanguages | string,\n  data: { [id: string]: any },\n): stt.SpeechData[] => {\n  const alts: any[] = data['channel']['alternatives'];\n\n  return alts.map((alt) => ({\n    language,\n    startTime: alt['words'].length ? alt['words'][0]['start'] : 0,\n    endTime: alt['words'].length ? alt['words'][alt['words'].length - 1]['end'] : 0,\n    confidence: alt['confidence'],\n    text: alt['transcript'],\n  }));\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,oBAA+E;AAE/E,gBAAwC;AAGxC,MAAM,kBAAkB;AAmBxB,MAAM,oBAAgC;AAAA,EACpC,QAAQ,QAAQ,IAAI;AAAA,EACpB,UAAU;AAAA,EACV,gBAAgB;AAAA,EAChB,gBAAgB;AAAA,EAChB,WAAW;AAAA,EACX,OAAO;AAAA,EACP,aAAa;AAAA,EACb,SAAS;AAAA,EACT,aAAa;AAAA,EACb,aAAa;AAAA,EACb,YAAY;AAAA,EACZ,aAAa;AAAA,EACb,UAAU,CAAC;AAAA,EACX,iBAAiB;AACnB;AAEO,MAAM,YAAY,kBAAI,IAAI;AAAA,EAC/B;AAAA,EACA,cAAU,mBAAI;AAAA,EACd,QAAQ;AAAA,EAER,YAAY,OAA4B,mBAAmB;AACzD,UAAM;AAAA,MACJ,WAAW;AAAA,MACX,gBAAgB,KAAK,kBAAkB,kBAAkB;AAAA,IAC3D,CAAC;AACD,QAAI,KAAK,WAAW,UAAa,kBAAkB,WAAW,QAAW;AACvE,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,SAAK,QAAQ,EAAE,GAAG,mBAAmB,GAAG,KAAK;AAE7C,QAAI,KAAK,MAAM,gBAAgB;AAC7B,WAAK,MAAM,WAAW;AAAA,IACxB,WACE,KAAK,MAAM,YACX,CAAC,CAAC,SAAS,IAAI,EAAE,SAAS,KAAK,MAAM,QAAQ,KAC7C;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,EAAE,SAAS,KAAK,MAAM,KAAK,GAC3B;AACA,WAAK,QAAQ;AAAA,QACX,GAAG,KAAK,MAAM,KAAK,8BAA8B,KAAK,MAAM,QAAQ;AAAA,MACtE;AACA,WAAK,MAAM,QAAQ;AAAA,IACrB;AAAA,EACF;AAAA;AAAA,EAGA,MAAM,WAAW,GAA0C;AACzD,UAAM,IAAI,MAAM,4CAA4C;AAAA,EAC9D;AAAA,EAEA,SAA2B;AACzB,WAAO,IAAI,aAAa,MAAM,KAAK,KAAK;AAAA,EAC1C;AACF;AAEO,MAAM,qBAAqB,kBAAI,aAAa;AAAA,EACjD;AAAA,EACA;AAAA,EACA,cAAU,mBAAI;AAAA,EACd,YAAY;AAAA,EACZ,QAAQ;AAAA,EAER,YAAYA,MAAU,MAAkB;AACtC,UAAMA,IAAG;AACT,SAAK,QAAQ;AACb,SAAK,SAAS;AACd,SAAK,qBAAqB,IAAI,gCAAkB;AAEhD,SAAK,KAAK;AAAA,EACZ;AAAA,EAEA,MAAM,KAAK,WAAW,IAAI;AACxB,QAAI,UAAU;AACd,QAAI;AACJ,WAAO,CAAC,KAAK,MAAM,QAAQ;AACzB,YAAM,YAAY,IAAI,IAAI,eAAe;AACzC,YAAM,SAAS;AAAA,QACb,OAAO,KAAK,MAAM;AAAA,QAClB,WAAW,KAAK,MAAM;AAAA,QACtB,cAAc,KAAK,MAAM;AAAA,QACzB,UAAU,KAAK,MAAM;AAAA,QACrB,iBAAiB,KAAK,MAAM;AAAA,QAC5B,UAAU;AAAA,QACV,YAAY;AAAA,QACZ,aAAa,KAAK,MAAM;AAAA,QACxB,UAAU,KAAK,MAAM;AAAA,QACrB,aAAa,KAAK,MAAM,eAAe;AAAA,QACvC,cAAc,KAAK,MAAM;AAAA,QACzB,UAAU,KAAK,MAAM,SAAS,IAAI,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC;AAAA,QACpD,kBAAkB,KAAK,MAAM;AAAA,QAC7B,UAAU,KAAK,MAAM;AAAA,MACvB;AACA,aAAO,QAAQ,MAAM,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,MAAM;AACzC,YAAI,MAAM,QAAW;AACnB,cAAI,OAAO,MAAM,YAAY,OAAO,MAAM,YAAY,OAAO,MAAM,WAAW;AAC5E,sBAAU,aAAa,OAAO,GAAG,mBAAmB,CAAC,CAAC;AAAA,UACxD,OAAO;AACL,cAAE,QAAQ,CAAC,MAAM,UAAU,aAAa,OAAO,YAAY,mBAAmB,CAAC,CAAC,CAAC;AAAA,UACnF;AAAA,QACF;AAAA,MACF,CAAC;AAED,WAAK,IAAI,oBAAU,WAAW;AAAA,QAC5B,SAAS,EAAE,eAAe,SAAS,KAAK,MAAM,MAAM,GAAG;AAAA,MACzD,CAAC;AAED,UAAI;AACF,cAAM,IAAI,QAAQ,CAAC,SAAS,WAAW;AACrC,aAAG,GAAG,QAAQ,OAAO;AACrB,aAAG,GAAG,SAAS,CAAC,UAAU,OAAO,KAAK,CAAC;AACvC,aAAG,GAAG,SAAS,CAAC,SAAS,OAAO,sBAAsB,IAAI,EAAE,CAAC;AAAA,QAC/D,CAAC;AAED,cAAM,KAAK,OAAO,EAAE;AAAA,MACtB,SAAS,GAAG;AACV,YAAI,WAAW,UAAU;AACvB,gBAAM,IAAI,MAAM,uCAAuC,OAAO,cAAc,CAAC,EAAE;AAAA,QACjF;AAEA,cAAM,QAAQ,KAAK,IAAI,UAAU,GAAG,EAAE;AACtC;AAEA,aAAK,QAAQ;AAAA,UACX,8CAA8C,KAAK,aAAa,CAAC,KAAK,OAAO,IAAI,QAAQ;AAAA,QAC3F;AACA,cAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,QAAQ,GAAI,CAAC;AAAA,MAClE;AAAA,IACF;AAEA,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,MAAM,OAAO,IAAe;AAC1B,QAAI,UAAU;AAEd,UAAM,YAAY,YAAY,MAAM;AAClC,UAAI;AACF,WAAG,KAAK,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC,CAAC;AAAA,MAC/C,QAAQ;AACN,sBAAc,SAAS;AACvB;AAAA,MACF;AAAA,IACF,GAAG,GAAI;AAEP,UAAM,WAAW,YAAY;AAC3B,YAAM,eAAe,KAAK,MAAM,KAAK,MAAM,aAAa,EAAE;AAC1D,YAAM,SAAS,IAAI;AAAA,QACjB,KAAK,MAAM;AAAA,QACX,KAAK,MAAM;AAAA,QACX;AAAA,MACF;AAEA,uBAAiB,QAAQ,KAAK,OAAO;AACnC,YAAI;AACJ,YAAI,SAAS,aAAa,gBAAgB;AACxC,mBAAS,OAAO,MAAM;AAAA,QACxB,WACE,KAAK,eAAe,KAAK,MAAM,cAC/B,KAAK,aAAa,KAAK,MAAM,aAC7B;AACA,mBAAS,OAAO,MAAM,KAAK,KAAK,MAAM;AAAA,QACxC,OAAO;AACL,gBAAM,IAAI,MAAM,sDAAsD;AAAA,QACxE;AAEA,yBAAiB,SAAS,QAAQ;AAChC,cAAI,KAAK,mBAAmB,UAAU,KAAK,GAAG;AAC5C,eAAG,KAAK,MAAM,KAAK,MAAM;AAAA,UAC3B;AAAA,QACF;AAAA,MACF;AAEA,gBAAU;AACV,SAAG,KAAK,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC,CAAC;AAAA,IACjD;AAEA,UAAM,aAAa,YAAY;AAC7B,UAAI;AAAA,QAAc,CAAC,GAAG,WACpB,GAAG,KAAK,SAAS,CAAC,MAAM,WAAW;AACjC,cAAI,CAAC,SAAS;AACZ,iBAAK,QAAQ,MAAM,8BAA8B,IAAI,KAAK,MAAM,EAAE;AAClE,mBAAO;AAAA,UACT;AAAA,QACF,CAAC;AAAA,MACH;AAEA,aAAO,CAAC,KAAK,QAAQ;AACnB,YAAI;AACF,gBAAM,IAAI,QAAiB,CAAC,YAAY;AACtC,eAAG,KAAK,WAAW,CAAC,SAAS,QAAQ,IAAI,CAAC;AAAA,UAC5C,CAAC,EAAE,KAAK,CAAC,QAAQ;AACf,kBAAM,OAAO,KAAK,MAAM,IAAI,SAAS,CAAC;AACtC,oBAAQ,KAAK,MAAM,GAAG;AAAA,cACpB,KAAK,iBAAiB;AAKpB,oBAAI,KAAK,UAAW;AACpB,qBAAK,YAAY;AACjB,qBAAK,MAAM,IAAI,EAAE,MAAM,kBAAI,gBAAgB,gBAAgB,CAAC;AAC5D;AAAA,cACF;AAAA;AAAA;AAAA;AAAA,cAIA,KAAK,WAAW;AACd,sBAAM,UAAU,KAAK,UAAU;AAC/B,sBAAM,aAAa,KAAK,cAAc;AAEtC,sBAAM,eAAe,8BAA8B,KAAK,MAAM,UAAW,IAAI;AAK7E,oBAAI,aAAa,CAAC,KAAK,aAAa,CAAC,EAAE,MAAM;AAC3C,sBAAI,CAAC,KAAK,WAAW;AACnB,yBAAK,YAAY;AACjB,yBAAK,MAAM,IAAI,EAAE,MAAM,kBAAI,gBAAgB,gBAAgB,CAAC;AAAA,kBAC9D;AAEA,sBAAI,SAAS;AACX,yBAAK,MAAM,IAAI;AAAA,sBACb,MAAM,kBAAI,gBAAgB;AAAA,sBAC1B,cAAc,CAAC,aAAa,CAAC,GAAG,GAAG,aAAa,MAAM,CAAC,CAAC;AAAA,oBAC1D,CAAC;AAAA,kBACH,OAAO;AACL,yBAAK,MAAM,IAAI;AAAA,sBACb,MAAM,kBAAI,gBAAgB;AAAA,sBAC1B,cAAc,CAAC,aAAa,CAAC,GAAG,GAAG,aAAa,MAAM,CAAC,CAAC;AAAA,oBAC1D,CAAC;AAAA,kBACH;AAAA,gBACF;AAKA,oBAAI,cAAc,KAAK,WAAW;AAChC,uBAAK,YAAY;AACjB,uBAAK,MAAM,IAAI,EAAE,MAAM,kBAAI,gBAAgB,cAAc,CAAC;AAAA,gBAC5D;AAEA;AAAA,cACF;AAAA,cACA,KAAK,YAAY;AACf;AAAA,cACF;AAAA,cACA,SAAS;AACP,qBAAK,QAAQ,MAAM,EAAE,KAAK,KAAK,CAAC,EAAE,KAAK,2CAA2C;AAClF;AAAA,cACF;AAAA,YACF;AAAA,UACF,CAAC;AAAA,QACH,SAAS,OAAO;AACd,eAAK,QAAQ,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,8BAA8B;AACjE;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,UAAM,QAAQ,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,CAAC;AAC5C,kBAAc,SAAS;AAAA,EACzB;AACF;AAEA,MAAM,gCAAgC,CACpC,UACA,SACqB;AACrB,QAAM,OAAc,KAAK,SAAS,EAAE,cAAc;AAElD,SAAO,KAAK,IAAI,CAAC,SAAS;AAAA,IACxB;AAAA,IACA,WAAW,IAAI,OAAO,EAAE,SAAS,IAAI,OAAO,EAAE,CAAC,EAAE,OAAO,IAAI;AAAA,IAC5D,SAAS,IAAI,OAAO,EAAE,SAAS,IAAI,OAAO,EAAE,IAAI,OAAO,EAAE,SAAS,CAAC,EAAE,KAAK,IAAI;AAAA,IAC9E,YAAY,IAAI,YAAY;AAAA,IAC5B,MAAM,IAAI,YAAY;AAAA,EACxB,EAAE;AACJ;","names":["stt"]}

package/dist/stt.d.ts

@@ -18,12 +18,14 @@ export interface STTOptions {
 }
 export declare class STT extends stt.STT {
     #private;
+    label: string;
     constructor(opts?: Partial<STTOptions>);
-    recognize(_: AudioBuffer): Promise<stt.SpeechEvent>;
+    _recognize(_: AudioBuffer): Promise<stt.SpeechEvent>;
     stream(): stt.SpeechStream;
 }
 export declare class SpeechStream extends stt.SpeechStream {
     #private;
-    constructor(opts: STTOptions);
+    label: string;
+    constructor(stt: STT, opts: STTOptions);
 }
 //# sourceMappingURL=stt.d.ts.map

package/dist/stt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stt.d.ts","sourceRoot":"","sources":["../src/stt.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,WAAW,EAA2C,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAGjG,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAI3D,MAAM,WAAW,UAAU;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IACjC,cAAc,EAAE,OAAO,CAAC;IACxB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,SAAS,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAC7B,eAAe,EAAE,OAAO,CAAC;CAC1B;AAmBD,qBAAa,GAAI,SAAQ,GAAG,CAAC,GAAG;;gBAIlB,IAAI,GAAE,OAAO,CAAC,UAAU,CAAqB;IAsCnD,SAAS,CAAC,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IAIzD,MAAM,IAAI,GAAG,CAAC,YAAY;CAG3B;AAED,qBAAa,YAAa,SAAQ,GAAG,CAAC,YAAY;;gBAMpC,IAAI,EAAE,UAAU;CAyM7B"}
+{"version":3,"file":"stt.d.ts","sourceRoot":"","sources":["../src/stt.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,WAAW,EAA2C,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAGjG,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAI3D,MAAM,WAAW,UAAU;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IACjC,cAAc,EAAE,OAAO,CAAC;IACxB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,SAAS,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAC7B,eAAe,EAAE,OAAO,CAAC;CAC1B;AAmBD,qBAAa,GAAI,SAAQ,GAAG,CAAC,GAAG;;IAG9B,KAAK,SAAkB;gBAEX,IAAI,GAAE,OAAO,CAAC,UAAU,CAAqB;IAsCnD,UAAU,CAAC,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IAI1D,MAAM,IAAI,GAAG,CAAC,YAAY;CAG3B;AAED,qBAAa,YAAa,SAAQ,GAAG,CAAC,YAAY;;IAKhD,KAAK,SAA2B;gBAEpB,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU;CAyMvC"}

package/dist/stt.js

@@ -1,258 +1,249 @@
-var _a;
-// SPDX-FileCopyrightText: 2024 LiveKit, Inc.
-//
-// SPDX-License-Identifier: Apache-2.0
-import { AudioByteStream, AudioEnergyFilter, log, stt } from '@livekit/agents';
-import { WebSocket } from 'ws';
-const API_BASE_URL_V1 = 'wss://api.deepgram.com/v1/listen';
+import { AudioByteStream, AudioEnergyFilter, log, stt } from "@livekit/agents";
+import { WebSocket } from "ws";
+const API_BASE_URL_V1 = "wss://api.deepgram.com/v1/listen";
 const defaultSTTOptions = {
-    apiKey: process.env.DEEPGRAM_API_KEY,
-    language: 'en-US',
-    detectLanguage: false,
-    interimResults: true,
-    punctuate: true,
-    model: 'nova-2-general',
-    smartFormat: true,
-    noDelay: true,
-    endpointing: 25,
-    fillerWords: false,
-    sampleRate: 16000,
-    numChannels: 1,
-    keywords: [],
-    profanityFilter: false,
+  apiKey: process.env.DEEPGRAM_API_KEY,
+  language: "en-US",
+  detectLanguage: false,
+  interimResults: true,
+  punctuate: true,
+  model: "nova-2-general",
+  smartFormat: true,
+  noDelay: true,
+  endpointing: 25,
+  fillerWords: false,
+  sampleRate: 16e3,
+  numChannels: 1,
+  keywords: [],
+  profanityFilter: false
 };
-export class STT extends stt.STT {
-    #opts;
-    #logger = log();
-    constructor(opts = defaultSTTOptions) {
-        super({
-            streaming: true,
-            interimResults: opts.interimResults || defaultSTTOptions.interimResults,
-        });
-        if (opts.apiKey === undefined && defaultSTTOptions.apiKey === undefined) {
-            throw new Error('Deepgram API key is required, whether as an argument or as $DEEPGRAM_API_KEY');
-        }
-        this.#opts = { ...defaultSTTOptions, ...opts };
-        if (this.#opts.detectLanguage) {
-            this.#opts.language = undefined;
-        }
-        else if (this.#opts.language &&
-            !['en-US', 'en'].includes(this.#opts.language) &&
-            [
-                'nova-2-meeting',
-                'nova-2-phonecall',
-                'nova-2-finance',
-                'nova-2-conversationalai',
-                'nova-2-voicemail',
-                'nova-2-video',
-                'nova-2-medical',
-                'nova-2-drivethru',
-                'nova-2-automotive',
-            ].includes(this.#opts.model)) {
-            this.#logger.warn(`${this.#opts.model} does not support language ${this.#opts.language}, falling back to nova-2-general`);
-            this.#opts.model = 'nova-2-general';
-        }
+class STT extends stt.STT {
+  #opts;
+  #logger = log();
+  label = "deepgram.STT";
+  constructor(opts = defaultSTTOptions) {
+    super({
+      streaming: true,
+      interimResults: opts.interimResults ?? defaultSTTOptions.interimResults
+    });
+    if (opts.apiKey === void 0 && defaultSTTOptions.apiKey === void 0) {
+      throw new Error(
+        "Deepgram API key is required, whether as an argument or as $DEEPGRAM_API_KEY"
+      );
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    async recognize(_) {
-        throw new Error('Recognize is not supported on Deepgram STT');
-    }
-    stream() {
-        return new SpeechStream(this.#opts);
+    this.#opts = { ...defaultSTTOptions, ...opts };
+    if (this.#opts.detectLanguage) {
+      this.#opts.language = void 0;
+    } else if (this.#opts.language && !["en-US", "en"].includes(this.#opts.language) && [
+      "nova-2-meeting",
+      "nova-2-phonecall",
+      "nova-2-finance",
+      "nova-2-conversationalai",
+      "nova-2-voicemail",
+      "nova-2-video",
+      "nova-2-medical",
+      "nova-2-drivethru",
+      "nova-2-automotive"
+    ].includes(this.#opts.model)) {
+      this.#logger.warn(
+        `${this.#opts.model} does not support language ${this.#opts.language}, falling back to nova-2-general`
+      );
+      this.#opts.model = "nova-2-general";
     }
+  }
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async _recognize(_) {
+    throw new Error("Recognize is not supported on Deepgram STT");
+  }
+  stream() {
+    return new SpeechStream(this, this.#opts);
+  }
 }
-export class SpeechStream extends stt.SpeechStream {
-    #opts;
-    #audioEnergyFilter;
-    #logger = log();
-    #speaking = false;
-    constructor(opts) {
-        super();
-        this.#opts = opts;
-        this.closed = false;
-        this.#audioEnergyFilter = new AudioEnergyFilter();
-        this.#run();
-    }
-    async #run(maxRetry = 32) {
-        let retries = 0;
-        let ws;
-        while (!this.input.closed) {
-            const streamURL = new URL(API_BASE_URL_V1);
-            const params = {
-                model: this.#opts.model,
-                punctuate: this.#opts.punctuate,
-                smart_format: this.#opts.smartFormat,
-                no_delay: this.#opts.noDelay,
-                interim_results: this.#opts.interimResults,
-                encoding: 'linear16',
-                vad_events: true,
-                sample_rate: this.#opts.sampleRate,
-                channels: this.#opts.numChannels,
-                endpointing: this.#opts.endpointing || false,
-                filler_words: this.#opts.fillerWords,
-                keywords: this.#opts.keywords.map((x) => x.join(':')),
-                profanity_filter: this.#opts.profanityFilter,
-                language: this.#opts.language,
-            };
-            Object.entries(params).forEach(([k, v]) => {
-                if (v !== undefined) {
-                    if (typeof v === 'string' || typeof v === 'number' || typeof v === 'boolean') {
-                        streamURL.searchParams.append(k, encodeURIComponent(v));
-                    }
-                    else {
-                        v.forEach((x) => streamURL.searchParams.append('keywords', encodeURIComponent(x)));
-                    }
-                }
-            });
-            ws = new WebSocket(streamURL, {
-                headers: { Authorization: `Token ${this.#opts.apiKey}` },
-            });
-            try {
-                await new Promise((resolve, reject) => {
-                    ws.on('open', resolve);
-                    ws.on('error', (error) => reject(error));
-                    ws.on('close', (code) => reject(`WebSocket returned ${code}`));
-                });
-                await this.#runWS(ws);
-            }
-            catch (e) {
-                if (retries >= maxRetry) {
-                    throw new Error(`failed to connect to Deepgram after ${retries} attempts: ${e}`);
-                }
-                const delay = Math.min(retries * 5, 10);
-                retries++;
-                this.#logger.warn(`failed to connect to Deepgram, retrying in ${delay} seconds: ${e} (${retries}/${maxRetry})`);
-                await new Promise((resolve) => setTimeout(resolve, delay * 1000));
-            }
+class SpeechStream extends stt.SpeechStream {
+  #opts;
+  #audioEnergyFilter;
+  #logger = log();
+  #speaking = false;
+  label = "deepgram.SpeechStream";
+  constructor(stt2, opts) {
+    super(stt2);
+    this.#opts = opts;
+    this.closed = false;
+    this.#audioEnergyFilter = new AudioEnergyFilter();
+    this.#run();
+  }
+  async #run(maxRetry = 32) {
+    let retries = 0;
+    let ws;
+    while (!this.input.closed) {
+      const streamURL = new URL(API_BASE_URL_V1);
+      const params = {
+        model: this.#opts.model,
+        punctuate: this.#opts.punctuate,
+        smart_format: this.#opts.smartFormat,
+        no_delay: this.#opts.noDelay,
+        interim_results: this.#opts.interimResults,
+        encoding: "linear16",
+        vad_events: true,
+        sample_rate: this.#opts.sampleRate,
+        channels: this.#opts.numChannels,
+        endpointing: this.#opts.endpointing || false,
+        filler_words: this.#opts.fillerWords,
+        keywords: this.#opts.keywords.map((x) => x.join(":")),
+        profanity_filter: this.#opts.profanityFilter,
+        language: this.#opts.language
+      };
+      Object.entries(params).forEach(([k, v]) => {
+        if (v !== void 0) {
+          if (typeof v === "string" || typeof v === "number" || typeof v === "boolean") {
+            streamURL.searchParams.append(k, encodeURIComponent(v));
+          } else {
+            v.forEach((x) => streamURL.searchParams.append("keywords", encodeURIComponent(x)));
+          }
         }
-        this.closed = true;
+      });
+      ws = new WebSocket(streamURL, {
+        headers: { Authorization: `Token ${this.#opts.apiKey}` }
+      });
+      try {
+        await new Promise((resolve, reject) => {
+          ws.on("open", resolve);
+          ws.on("error", (error) => reject(error));
+          ws.on("close", (code) => reject(`WebSocket returned ${code}`));
+        });
+        await this.#runWS(ws);
+      } catch (e) {
+        if (retries >= maxRetry) {
+          throw new Error(`failed to connect to Deepgram after ${retries} attempts: ${e}`);
+        }
+        const delay = Math.min(retries * 5, 10);
+        retries++;
+        this.#logger.warn(
+          `failed to connect to Deepgram, retrying in ${delay} seconds: ${e} (${retries}/${maxRetry})`
+        );
+        await new Promise((resolve) => setTimeout(resolve, delay * 1e3));
+      }
     }
-    async #runWS(ws) {
-        let closing = false;
-        const keepalive = setInterval(() => {
-            try {
-                ws.send(JSON.stringify({ type: 'KeepAlive' }));
-            }
-            catch {
-                clearInterval(keepalive);
-                return;
-            }
-        }, 5000);
-        const sendTask = async () => {
-            const samples100Ms = Math.floor(this.#opts.sampleRate / 10);
-            const stream = new AudioByteStream(this.#opts.sampleRate, this.#opts.numChannels, samples100Ms);
-            for await (const data of this.input) {
-                let frames;
-                if (data === _a.FLUSH_SENTINEL) {
-                    frames = stream.flush();
-                }
-                else if (data.sampleRate === this.#opts.sampleRate ||
-                    data.channels === this.#opts.numChannels) {
-                    frames = stream.write(data.data.buffer);
-                }
-                else {
-                    throw new Error(`sample rate or channel count of frame does not match`);
-                }
-                for await (const frame of frames) {
-                    if (this.#audioEnergyFilter.pushFrame(frame)) {
-                        ws.send(frame.data.buffer);
-                    }
-                }
-            }
-            closing = true;
-            ws.send(JSON.stringify({ type: 'CloseStream' }));
-        };
-        const listenTask = async () => {
-            new Promise((_, reject) => ws.once('close', (code, reason) => {
-                if (!closing) {
-                    this.#logger.error(`WebSocket closed with code ${code}: ${reason}`);
-                    reject();
-                }
-            }));
-            while (!this.closed) {
-                try {
-                    await new Promise((resolve) => {
-                        ws.once('message', (data) => resolve(data));
-                    }).then((msg) => {
-                        const json = JSON.parse(msg.toString());
-                        switch (json['type']) {
-                            case 'SpeechStarted': {
-                                // This is a normal case. Deepgram's SpeechStarted events
-                                // are not correlated with speech_final or utterance end.
-                                // It's possible that we receive two in a row without an endpoint
-                                // It's also possible we receive a transcript without a SpeechStarted event.
-                                if (this.#speaking)
-                                    return;
-                                this.#speaking = true;
-                                this.queue.put({ type: stt.SpeechEventType.START_OF_SPEECH });
-                                break;
-                            }
-                            // see this page:
-                            // https://developers.deepgram.com/docs/understand-endpointing-interim-results#using-endpointing-speech_final
-                            // for more information about the different types of events
-                            case 'Results': {
-                                const isFinal = json['is_final'];
-                                const isEndpoint = json['speech_final'];
-                                const alternatives = liveTranscriptionToSpeechData(this.#opts.language, json);
-                                // If, for some reason, we didn't get a SpeechStarted event but we got
-                                // a transcript with text, we should start speaking. It's rare but has
-                                // been observed.
-                                if (alternatives[0] && alternatives[0].text) {
-                                    if (!this.#speaking) {
-                                        this.#speaking = true;
-                                        this.queue.put({ type: stt.SpeechEventType.START_OF_SPEECH });
-                                    }
-                                    if (isFinal) {
-                                        this.queue.put({
-                                            type: stt.SpeechEventType.FINAL_TRANSCRIPT,
-                                            alternatives: [alternatives[0], ...alternatives.splice(0)],
-                                        });
-                                    }
-                                    else {
-                                        this.queue.put({
-                                            type: stt.SpeechEventType.INTERIM_TRANSCRIPT,
-                                            alternatives: [alternatives[0], ...alternatives.splice(0)],
-                                        });
-                                    }
-                                }
-                                // if we receive an endpoint, only end the speech if
-                                // we either had a SpeechStarted event or we have a seen
-                                // a non-empty transcript (deepgram doesn't have a SpeechEnded event)
-                                if (isEndpoint && this.#speaking) {
-                                    this.#speaking = false;
-                                    this.queue.put({ type: stt.SpeechEventType.END_OF_SPEECH });
-                                }
-                                break;
-                            }
-                            case 'Metadata': {
-                                break;
-                            }
-                            default: {
-                                this.#logger.child({ msg: json }).warn('received unexpected message from Deepgram');
-                                break;
-                            }
-                        }
+    this.closed = true;
+  }
+  async #runWS(ws) {
+    let closing = false;
+    const keepalive = setInterval(() => {
+      try {
+        ws.send(JSON.stringify({ type: "KeepAlive" }));
+      } catch {
+        clearInterval(keepalive);
+        return;
+      }
+    }, 5e3);
+    const sendTask = async () => {
+      const samples100Ms = Math.floor(this.#opts.sampleRate / 10);
+      const stream = new AudioByteStream(
+        this.#opts.sampleRate,
+        this.#opts.numChannels,
+        samples100Ms
+      );
+      for await (const data of this.input) {
+        let frames;
+        if (data === SpeechStream.FLUSH_SENTINEL) {
+          frames = stream.flush();
+        } else if (data.sampleRate === this.#opts.sampleRate || data.channels === this.#opts.numChannels) {
+          frames = stream.write(data.data.buffer);
+        } else {
+          throw new Error(`sample rate or channel count of frame does not match`);
+        }
+        for await (const frame of frames) {
+          if (this.#audioEnergyFilter.pushFrame(frame)) {
+            ws.send(frame.data.buffer);
+          }
+        }
+      }
+      closing = true;
+      ws.send(JSON.stringify({ type: "CloseStream" }));
+    };
+    const listenTask = async () => {
+      new Promise(
+        (_, reject) => ws.once("close", (code, reason) => {
+          if (!closing) {
+            this.#logger.error(`WebSocket closed with code ${code}: ${reason}`);
+            reject();
+          }
+        })
+      );
+      while (!this.closed) {
+        try {
+          await new Promise((resolve) => {
+            ws.once("message", (data) => resolve(data));
+          }).then((msg) => {
+            const json = JSON.parse(msg.toString());
+            switch (json["type"]) {
+              case "SpeechStarted": {
+                if (this.#speaking) return;
+                this.#speaking = true;
+                this.queue.put({ type: stt.SpeechEventType.START_OF_SPEECH });
+                break;
+              }
+              // see this page:
+              // https://developers.deepgram.com/docs/understand-endpointing-interim-results#using-endpointing-speech_final
+              // for more information about the different types of events
+              case "Results": {
+                const isFinal = json["is_final"];
+                const isEndpoint = json["speech_final"];
+                const alternatives = liveTranscriptionToSpeechData(this.#opts.language, json);
+                if (alternatives[0] && alternatives[0].text) {
+                  if (!this.#speaking) {
+                    this.#speaking = true;
+                    this.queue.put({ type: stt.SpeechEventType.START_OF_SPEECH });
+                  }
+                  if (isFinal) {
+                    this.queue.put({
+                      type: stt.SpeechEventType.FINAL_TRANSCRIPT,
+                      alternatives: [alternatives[0], ...alternatives.slice(1)]
                     });
+                  } else {
+                    this.queue.put({
+                      type: stt.SpeechEventType.INTERIM_TRANSCRIPT,
+                      alternatives: [alternatives[0], ...alternatives.slice(1)]
+                    });
+                  }
                 }
-                catch (error) {
-                    this.#logger.child({ error }).warn('unrecoverable error, exiting');
-                    break;
+                if (isEndpoint && this.#speaking) {
+                  this.#speaking = false;
+                  this.queue.put({ type: stt.SpeechEventType.END_OF_SPEECH });
                 }
+                break;
+              }
+              case "Metadata": {
+                break;
+              }
+              default: {
+                this.#logger.child({ msg: json }).warn("received unexpected message from Deepgram");
+                break;
+              }
             }
-        };
-        await Promise.all([sendTask(), listenTask()]);
-        clearInterval(keepalive);
-    }
+          });
+        } catch (error) {
+          this.#logger.child({ error }).warn("unrecoverable error, exiting");
+          break;
+        }
+      }
+    };
+    await Promise.all([sendTask(), listenTask()]);
+    clearInterval(keepalive);
+  }
 }
-_a = SpeechStream;
 const liveTranscriptionToSpeechData = (language, data) => {
-    const alts = data['channel']['alternatives'];
-    return alts.map((alt) => ({
-        language,
-        startTime: alt['words'].length ? alt['words'][0]['start'] : 0,
-        endTime: alt['words'].length ? alt['words'][alt['words'].length - 1]['end'] : 0,
-        confidence: alt['confidence'],
-        text: alt['transcript'],
-    }));
+  const alts = data["channel"]["alternatives"];
+  return alts.map((alt) => ({
+    language,
+    startTime: alt["words"].length ? alt["words"][0]["start"] : 0,
+    endTime: alt["words"].length ? alt["words"][alt["words"].length - 1]["end"] : 0,
+    confidence: alt["confidence"],
+    text: alt["transcript"]
+  }));
+};
+export {
+  STT,
+  SpeechStream
 };
 //# sourceMappingURL=stt.js.map

package/dist/stt.js.map

@@ -1 +1 @@
-{"version":3,"file":"stt.js","sourceRoot":"","sources":["../src/stt.ts"],"names":[],"mappings":";AAAA,6CAA6C;AAC7C,EAAE;AACF,sCAAsC;AACtC,OAAO,EAAoB,eAAe,EAAE,iBAAiB,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAEjG,OAAO,EAAgB,SAAS,EAAE,MAAM,IAAI,CAAC;AAG7C,MAAM,eAAe,GAAG,kCAAkC,CAAC;AAmB3D,MAAM,iBAAiB,GAAe;IACpC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB;IACpC,QAAQ,EAAE,OAAO;IACjB,cAAc,EAAE,KAAK;IACrB,cAAc,EAAE,IAAI;IACpB,SAAS,EAAE,IAAI;IACf,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,IAAI;IACjB,OAAO,EAAE,IAAI;IACb,WAAW,EAAE,EAAE;IACf,WAAW,EAAE,KAAK;IAClB,UAAU,EAAE,KAAK;IACjB,WAAW,EAAE,CAAC;IACd,QAAQ,EAAE,EAAE;IACZ,eAAe,EAAE,KAAK;CACvB,CAAC;AAEF,MAAM,OAAO,GAAI,SAAQ,GAAG,CAAC,GAAG;IAC9B,KAAK,CAAa;IAClB,OAAO,GAAG,GAAG,EAAE,CAAC;IAEhB,YAAY,OAA4B,iBAAiB;QACvD,KAAK,CAAC;YACJ,SAAS,EAAE,IAAI;YACf,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,iBAAiB,CAAC,cAAc;SACxE,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACxE,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,iBAAiB,EAAE,GAAG,IAAI,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;YAC9B,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;QAClC,CAAC;aAAM,IACL,IAAI,CAAC,KAAK,CAAC,QAAQ;YACnB,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC9C;gBACE,gBAAgB;gBAChB,kBAAkB;gBAClB,gBAAgB;gBAChB,yBAAyB;gBACzB,kBAAkB;gBAClB,cAAc;gBACd,gBAAgB;gBAChB,kBAAkB;gBAClB,mBAAmB;aACpB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAC5B,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,CACf,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,8BAA8B,IAAI,CAAC,KAAK,CAAC,QAAQ,kCAAkC,CACvG,CAAC;YACF,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,gBAAgB,CAAC;QACtC,CAAC;IACH,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,SAAS,CAAC,CAAc;QAC5B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,GAAG,CAAC,YAAY;IAChD,KAAK,CAAa;IAClB,kBAAkB,CAAoB;IACtC,OAAO,GAAG,GAAG,EAAE,CAAC;IAChB,SAAS,GAAG,KAAK,CAAC;IAElB,YAAY,IAAgB;QAC1B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,kBAAkB,GAAG,IAAI,iBAAiB,EAAE,CAAC;QAElD,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,EAAE;QACtB,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,IAAI,EAAa,CAAC;QAClB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,CAAC;YAC3C,MAAM,MAAM,GAAG;gBACb,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;gBACvB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;gBAC/B,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW;gBACpC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;gBAC5B,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc;gBAC1C,QAAQ,EAAE,UAAU;gBACpB,UAAU,EAAE,IAAI;gBAChB,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU;gBAClC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW;gBAChC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,KAAK;gBAC5C,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW;gBACpC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrD,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe;gBAC5C,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;aAC9B,CAAC;YACF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;gBACxC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;oBACpB,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;wBAC7E,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1D,CAAC;yBAAM,CAAC;wBACN,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBACrF,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,EAAE,GAAG,IAAI,SAAS,CAAC,SAAS,EAAE;gBAC5B,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE;aACzD,CAAC,CAAC;YAEH,IAAI,CAAC;gBACH,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACpC,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;oBACvB,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;oBACzC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC,CAAC;gBACjE,CAAC,CAAC,CAAC;gBAEH,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACxB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CAAC,uCAAuC,OAAO,cAAc,CAAC,EAAE,CAAC,CAAC;gBACnF,CAAC;gBAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;gBACxC,OAAO,EAAE,CAAC;gBAEV,IAAI,CAAC,OAAO,CAAC,IAAI,CACf,8CAA8C,KAAK,aAAa,CAAC,KAAK,OAAO,IAAI,QAAQ,GAAG,CAC7F,CAAC;gBACF,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAa;QACxB,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE;YACjC,IAAI,CAAC;gBACH,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;YACjD,CAAC;YAAC,MAAM,CAAC;gBACP,aAAa,CAAC,SAAS,CAAC,CAAC;gBACzB,OAAO;YACT,CAAC;QACH,CAAC,EAAE,IAAI,CAAC,CAAC;QAET,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;YAC1B,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;YAC5D,MAAM,MAAM,GAAG,IAAI,eAAe,CAChC,IAAI,CAAC,KAAK,CAAC,UAAU,EACrB,IAAI,CAAC,KAAK,CAAC,WAAW,EACtB,YAAY,CACb,CAAC;YAEF,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACpC,IAAI,MAAoB,CAAC;gBACzB,IAAI,IAAI,KAAK,EAAY,CAAC,cAAc,EAAE,CAAC;oBACzC,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC1B,CAAC;qBAAM,IACL,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,KAAK,CAAC,UAAU;oBACzC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,WAAW,EACxC,CAAC;oBACD,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC1C,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;gBAC1E,CAAC;gBAED,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBACjC,IAAI,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC7C,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC7B,CAAC;gBACH,CAAC;YACH,CAAC;YAED,OAAO,GAAG,IAAI,CAAC;YACf,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;QACnD,CAAC,CAAC;QAEF,MAAM,UAAU,GAAG,KAAK,IAAI,EAAE;YAC5B,IAAI,OAAO,CAAO,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAC9B,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;gBAChC,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,8BAA8B,IAAI,KAAK,MAAM,EAAE,CAAC,CAAC;oBACpE,MAAM,EAAE,CAAC;gBACX,CAAC;YACH,CAAC,CAAC,CACH,CAAC;YAEF,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACpB,IAAI,CAAC;oBACH,MAAM,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,EAAE;wBACrC,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC9C,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;wBACd,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;wBACxC,QAAQ,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;4BACrB,KAAK,eAAe,CAAC,CAAC,CAAC;gCACrB,yDAAyD;gCACzD,yDAAyD;gCACzD,iEAAiE;gCACjE,4EAA4E;gCAC5E,IAAI,IAAI,CAAC,SAAS;oCAAE,OAAO;gCAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;gCACtB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;gCAC9D,MAAM;4BACR,CAAC;4BACD,iBAAiB;4BACjB,6GAA6G;4BAC7G,2DAA2D;4BAC3D,KAAK,SAAS,CAAC,CAAC,CAAC;gCACf,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;gCACjC,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;gCAExC,MAAM,YAAY,GAAG,6BAA6B,CAAC,IAAI,CAAC,KAAK,CAAC,QAAS,EAAE,IAAI,CAAC,CAAC;gCAE/E,sEAAsE;gCACtE,sEAAsE;gCACtE,iBAAiB;gCACjB,IAAI,YAAY,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;oCAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;wCACpB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;wCACtB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;oCAChE,CAAC;oCAED,IAAI,OAAO,EAAE,CAAC;wCACZ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;4CACb,IAAI,EAAE,GAAG,CAAC,eAAe,CAAC,gBAAgB;4CAC1C,YAAY,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;yCAC3D,CAAC,CAAC;oCACL,CAAC;yCAAM,CAAC;wCACN,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;4CACb,IAAI,EAAE,GAAG,CAAC,eAAe,CAAC,kBAAkB;4CAC5C,YAAY,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;yCAC3D,CAAC,CAAC;oCACL,CAAC;gCACH,CAAC;gCAED,oDAAoD;gCACpD,wDAAwD;gCACxD,qEAAqE;gCACrE,IAAI,UAAU,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;oCACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;oCACvB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,eAAe,CAAC,aAAa,EAAE,CAAC,CAAC;gCAC9D,CAAC;gCAED,MAAM;4BACR,CAAC;4BACD,KAAK,UAAU,CAAC,CAAC,CAAC;gCAChB,MAAM;4BACR,CAAC;4BACD,OAAO,CAAC,CAAC,CAAC;gCACR,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;gCACpF,MAAM;4BACR,CAAC;wBACH,CAAC;oBACH,CAAC,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;oBACnE,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAC9C,aAAa,CAAC,SAAS,CAAC,CAAC;IAC3B,CAAC;CACF;;AAED,MAAM,6BAA6B,GAAG,CACpC,QAA+B,EAC/B,IAA2B,EACT,EAAE;IACpB,MAAM,IAAI,GAAU,IAAI,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;IAEpD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACxB,QAAQ;QACR,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7D,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/E,UAAU,EAAE,GAAG,CAAC,YAAY,CAAC;QAC7B,IAAI,EAAE,GAAG,CAAC,YAAY,CAAC;KACxB,CAAC,CAAC,CAAC;AACN,CAAC,CAAC"}
+{"version":3,"sources":["../src/stt.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport { type AudioBuffer, AudioByteStream, AudioEnergyFilter, log, stt } from '@livekit/agents';\nimport type { AudioFrame } from '@livekit/rtc-node';\nimport { type RawData, WebSocket } from 'ws';\nimport type { STTLanguages, STTModels } from './models.js';\n\nconst API_BASE_URL_V1 = 'wss://api.deepgram.com/v1/listen';\n\nexport interface STTOptions {\n  apiKey?: string;\n  language?: STTLanguages | string;\n  detectLanguage: boolean;\n  interimResults: boolean;\n  punctuate: boolean;\n  model: STTModels;\n  smartFormat: boolean;\n  noDelay: boolean;\n  endpointing: number;\n  fillerWords: boolean;\n  sampleRate: number;\n  numChannels: number;\n  keywords: [string, number][];\n  profanityFilter: boolean;\n}\n\nconst defaultSTTOptions: STTOptions = {\n  apiKey: process.env.DEEPGRAM_API_KEY,\n  language: 'en-US',\n  detectLanguage: false,\n  interimResults: true,\n  punctuate: true,\n  model: 'nova-2-general',\n  smartFormat: true,\n  noDelay: true,\n  endpointing: 25,\n  fillerWords: false,\n  sampleRate: 16000,\n  numChannels: 1,\n  keywords: [],\n  profanityFilter: false,\n};\n\nexport class STT extends stt.STT {\n  #opts: STTOptions;\n  #logger = log();\n  label = 'deepgram.STT';\n\n  constructor(opts: Partial<STTOptions> = defaultSTTOptions) {\n    super({\n      streaming: true,\n      interimResults: opts.interimResults ?? defaultSTTOptions.interimResults,\n    });\n    if (opts.apiKey === undefined && defaultSTTOptions.apiKey === undefined) {\n      throw new Error(\n        'Deepgram API key is required, whether as an argument or as $DEEPGRAM_API_KEY',\n      );\n    }\n\n    this.#opts = { ...defaultSTTOptions, ...opts };\n\n    if (this.#opts.detectLanguage) {\n      this.#opts.language = undefined;\n    } else if (\n      this.#opts.language &&\n      !['en-US', 'en'].includes(this.#opts.language) &&\n      [\n        'nova-2-meeting',\n        'nova-2-phonecall',\n        'nova-2-finance',\n        'nova-2-conversationalai',\n        'nova-2-voicemail',\n        'nova-2-video',\n        'nova-2-medical',\n        'nova-2-drivethru',\n        'nova-2-automotive',\n      ].includes(this.#opts.model)\n    ) {\n      this.#logger.warn(\n        `${this.#opts.model} does not support language ${this.#opts.language}, falling back to nova-2-general`,\n      );\n      this.#opts.model = 'nova-2-general';\n    }\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  async _recognize(_: AudioBuffer): Promise<stt.SpeechEvent> {\n    throw new Error('Recognize is not supported on Deepgram STT');\n  }\n\n  stream(): stt.SpeechStream {\n    return new SpeechStream(this, this.#opts);\n  }\n}\n\nexport class SpeechStream extends stt.SpeechStream {\n  #opts: STTOptions;\n  #audioEnergyFilter: AudioEnergyFilter;\n  #logger = log();\n  #speaking = false;\n  label = 'deepgram.SpeechStream';\n\n  constructor(stt: STT, opts: STTOptions) {\n    super(stt);\n    this.#opts = opts;\n    this.closed = false;\n    this.#audioEnergyFilter = new AudioEnergyFilter();\n\n    this.#run();\n  }\n\n  async #run(maxRetry = 32) {\n    let retries = 0;\n    let ws: WebSocket;\n    while (!this.input.closed) {\n      const streamURL = new URL(API_BASE_URL_V1);\n      const params = {\n        model: this.#opts.model,\n        punctuate: this.#opts.punctuate,\n        smart_format: this.#opts.smartFormat,\n        no_delay: this.#opts.noDelay,\n        interim_results: this.#opts.interimResults,\n        encoding: 'linear16',\n        vad_events: true,\n        sample_rate: this.#opts.sampleRate,\n        channels: this.#opts.numChannels,\n        endpointing: this.#opts.endpointing || false,\n        filler_words: this.#opts.fillerWords,\n        keywords: this.#opts.keywords.map((x) => x.join(':')),\n        profanity_filter: this.#opts.profanityFilter,\n        language: this.#opts.language,\n      };\n      Object.entries(params).forEach(([k, v]) => {\n        if (v !== undefined) {\n          if (typeof v === 'string' || typeof v === 'number' || typeof v === 'boolean') {\n            streamURL.searchParams.append(k, encodeURIComponent(v));\n          } else {\n            v.forEach((x) => streamURL.searchParams.append('keywords', encodeURIComponent(x)));\n          }\n        }\n      });\n\n      ws = new WebSocket(streamURL, {\n        headers: { Authorization: `Token ${this.#opts.apiKey}` },\n      });\n\n      try {\n        await new Promise((resolve, reject) => {\n          ws.on('open', resolve);\n          ws.on('error', (error) => reject(error));\n          ws.on('close', (code) => reject(`WebSocket returned ${code}`));\n        });\n\n        await this.#runWS(ws);\n      } catch (e) {\n        if (retries >= maxRetry) {\n          throw new Error(`failed to connect to Deepgram after ${retries} attempts: ${e}`);\n        }\n\n        const delay = Math.min(retries * 5, 10);\n        retries++;\n\n        this.#logger.warn(\n          `failed to connect to Deepgram, retrying in ${delay} seconds: ${e} (${retries}/${maxRetry})`,\n        );\n        await new Promise((resolve) => setTimeout(resolve, delay * 1000));\n      }\n    }\n\n    this.closed = true;\n  }\n\n  async #runWS(ws: WebSocket) {\n    let closing = false;\n\n    const keepalive = setInterval(() => {\n      try {\n        ws.send(JSON.stringify({ type: 'KeepAlive' }));\n      } catch {\n        clearInterval(keepalive);\n        return;\n      }\n    }, 5000);\n\n    const sendTask = async () => {\n      const samples100Ms = Math.floor(this.#opts.sampleRate / 10);\n      const stream = new AudioByteStream(\n        this.#opts.sampleRate,\n        this.#opts.numChannels,\n        samples100Ms,\n      );\n\n      for await (const data of this.input) {\n        let frames: AudioFrame[];\n        if (data === SpeechStream.FLUSH_SENTINEL) {\n          frames = stream.flush();\n        } else if (\n          data.sampleRate === this.#opts.sampleRate ||\n          data.channels === this.#opts.numChannels\n        ) {\n          frames = stream.write(data.data.buffer);\n        } else {\n          throw new Error(`sample rate or channel count of frame does not match`);\n        }\n\n        for await (const frame of frames) {\n          if (this.#audioEnergyFilter.pushFrame(frame)) {\n            ws.send(frame.data.buffer);\n          }\n        }\n      }\n\n      closing = true;\n      ws.send(JSON.stringify({ type: 'CloseStream' }));\n    };\n\n    const listenTask = async () => {\n      new Promise<void>((_, reject) =>\n        ws.once('close', (code, reason) => {\n          if (!closing) {\n            this.#logger.error(`WebSocket closed with code ${code}: ${reason}`);\n            reject();\n          }\n        }),\n      );\n\n      while (!this.closed) {\n        try {\n          await new Promise<RawData>((resolve) => {\n            ws.once('message', (data) => resolve(data));\n          }).then((msg) => {\n            const json = JSON.parse(msg.toString());\n            switch (json['type']) {\n              case 'SpeechStarted': {\n                // This is a normal case. Deepgram's SpeechStarted events\n                // are not correlated with speech_final or utterance end.\n                // It's possible that we receive two in a row without an endpoint\n                // It's also possible we receive a transcript without a SpeechStarted event.\n                if (this.#speaking) return;\n                this.#speaking = true;\n                this.queue.put({ type: stt.SpeechEventType.START_OF_SPEECH });\n                break;\n              }\n              // see this page:\n              // https://developers.deepgram.com/docs/understand-endpointing-interim-results#using-endpointing-speech_final\n              // for more information about the different types of events\n              case 'Results': {\n                const isFinal = json['is_final'];\n                const isEndpoint = json['speech_final'];\n\n                const alternatives = liveTranscriptionToSpeechData(this.#opts.language!, json);\n\n                // If, for some reason, we didn't get a SpeechStarted event but we got\n                // a transcript with text, we should start speaking. It's rare but has\n                // been observed.\n                if (alternatives[0] && alternatives[0].text) {\n                  if (!this.#speaking) {\n                    this.#speaking = true;\n                    this.queue.put({ type: stt.SpeechEventType.START_OF_SPEECH });\n                  }\n\n                  if (isFinal) {\n                    this.queue.put({\n                      type: stt.SpeechEventType.FINAL_TRANSCRIPT,\n                      alternatives: [alternatives[0], ...alternatives.slice(1)],\n                    });\n                  } else {\n                    this.queue.put({\n                      type: stt.SpeechEventType.INTERIM_TRANSCRIPT,\n                      alternatives: [alternatives[0], ...alternatives.slice(1)],\n                    });\n                  }\n                }\n\n                // if we receive an endpoint, only end the speech if\n                // we either had a SpeechStarted event or we have a seen\n                // a non-empty transcript (deepgram doesn't have a SpeechEnded event)\n                if (isEndpoint && this.#speaking) {\n                  this.#speaking = false;\n                  this.queue.put({ type: stt.SpeechEventType.END_OF_SPEECH });\n                }\n\n                break;\n              }\n              case 'Metadata': {\n                break;\n              }\n              default: {\n                this.#logger.child({ msg: json }).warn('received unexpected message from Deepgram');\n                break;\n              }\n            }\n          });\n        } catch (error) {\n          this.#logger.child({ error }).warn('unrecoverable error, exiting');\n          break;\n        }\n      }\n    };\n\n    await Promise.all([sendTask(), listenTask()]);\n    clearInterval(keepalive);\n  }\n}\n\nconst liveTranscriptionToSpeechData = (\n  language: STTLanguages | string,\n  data: { [id: string]: any },\n): stt.SpeechData[] => {\n  const alts: any[] = data['channel']['alternatives'];\n\n  return alts.map((alt) => ({\n    language,\n    startTime: alt['words'].length ? alt['words'][0]['start'] : 0,\n    endTime: alt['words'].length ? alt['words'][alt['words'].length - 1]['end'] : 0,\n    confidence: alt['confidence'],\n    text: alt['transcript'],\n  }));\n};\n"],"mappings":"AAGA,SAA2B,iBAAiB,mBAAmB,KAAK,WAAW;AAE/E,SAAuB,iBAAiB;AAGxC,MAAM,kBAAkB;AAmBxB,MAAM,oBAAgC;AAAA,EACpC,QAAQ,QAAQ,IAAI;AAAA,EACpB,UAAU;AAAA,EACV,gBAAgB;AAAA,EAChB,gBAAgB;AAAA,EAChB,WAAW;AAAA,EACX,OAAO;AAAA,EACP,aAAa;AAAA,EACb,SAAS;AAAA,EACT,aAAa;AAAA,EACb,aAAa;AAAA,EACb,YAAY;AAAA,EACZ,aAAa;AAAA,EACb,UAAU,CAAC;AAAA,EACX,iBAAiB;AACnB;AAEO,MAAM,YAAY,IAAI,IAAI;AAAA,EAC/B;AAAA,EACA,UAAU,IAAI;AAAA,EACd,QAAQ;AAAA,EAER,YAAY,OAA4B,mBAAmB;AACzD,UAAM;AAAA,MACJ,WAAW;AAAA,MACX,gBAAgB,KAAK,kBAAkB,kBAAkB;AAAA,IAC3D,CAAC;AACD,QAAI,KAAK,WAAW,UAAa,kBAAkB,WAAW,QAAW;AACvE,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,SAAK,QAAQ,EAAE,GAAG,mBAAmB,GAAG,KAAK;AAE7C,QAAI,KAAK,MAAM,gBAAgB;AAC7B,WAAK,MAAM,WAAW;AAAA,IACxB,WACE,KAAK,MAAM,YACX,CAAC,CAAC,SAAS,IAAI,EAAE,SAAS,KAAK,MAAM,QAAQ,KAC7C;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,EAAE,SAAS,KAAK,MAAM,KAAK,GAC3B;AACA,WAAK,QAAQ;AAAA,QACX,GAAG,KAAK,MAAM,KAAK,8BAA8B,KAAK,MAAM,QAAQ;AAAA,MACtE;AACA,WAAK,MAAM,QAAQ;AAAA,IACrB;AAAA,EACF;AAAA;AAAA,EAGA,MAAM,WAAW,GAA0C;AACzD,UAAM,IAAI,MAAM,4CAA4C;AAAA,EAC9D;AAAA,EAEA,SAA2B;AACzB,WAAO,IAAI,aAAa,MAAM,KAAK,KAAK;AAAA,EAC1C;AACF;AAEO,MAAM,qBAAqB,IAAI,aAAa;AAAA,EACjD;AAAA,EACA;AAAA,EACA,UAAU,IAAI;AAAA,EACd,YAAY;AAAA,EACZ,QAAQ;AAAA,EAER,YAAYA,MAAU,MAAkB;AACtC,UAAMA,IAAG;AACT,SAAK,QAAQ;AACb,SAAK,SAAS;AACd,SAAK,qBAAqB,IAAI,kBAAkB;AAEhD,SAAK,KAAK;AAAA,EACZ;AAAA,EAEA,MAAM,KAAK,WAAW,IAAI;AACxB,QAAI,UAAU;AACd,QAAI;AACJ,WAAO,CAAC,KAAK,MAAM,QAAQ;AACzB,YAAM,YAAY,IAAI,IAAI,eAAe;AACzC,YAAM,SAAS;AAAA,QACb,OAAO,KAAK,MAAM;AAAA,QAClB,WAAW,KAAK,MAAM;AAAA,QACtB,cAAc,KAAK,MAAM;AAAA,QACzB,UAAU,KAAK,MAAM;AAAA,QACrB,iBAAiB,KAAK,MAAM;AAAA,QAC5B,UAAU;AAAA,QACV,YAAY;AAAA,QACZ,aAAa,KAAK,MAAM;AAAA,QACxB,UAAU,KAAK,MAAM;AAAA,QACrB,aAAa,KAAK,MAAM,eAAe;AAAA,QACvC,cAAc,KAAK,MAAM;AAAA,QACzB,UAAU,KAAK,MAAM,SAAS,IAAI,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC;AAAA,QACpD,kBAAkB,KAAK,MAAM;AAAA,QAC7B,UAAU,KAAK,MAAM;AAAA,MACvB;AACA,aAAO,QAAQ,MAAM,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,MAAM;AACzC,YAAI,MAAM,QAAW;AACnB,cAAI,OAAO,MAAM,YAAY,OAAO,MAAM,YAAY,OAAO,MAAM,WAAW;AAC5E,sBAAU,aAAa,OAAO,GAAG,mBAAmB,CAAC,CAAC;AAAA,UACxD,OAAO;AACL,cAAE,QAAQ,CAAC,MAAM,UAAU,aAAa,OAAO,YAAY,mBAAmB,CAAC,CAAC,CAAC;AAAA,UACnF;AAAA,QACF;AAAA,MACF,CAAC;AAED,WAAK,IAAI,UAAU,WAAW;AAAA,QAC5B,SAAS,EAAE,eAAe,SAAS,KAAK,MAAM,MAAM,GAAG;AAAA,MACzD,CAAC;AAED,UAAI;AACF,cAAM,IAAI,QAAQ,CAAC,SAAS,WAAW;AACrC,aAAG,GAAG,QAAQ,OAAO;AACrB,aAAG,GAAG,SAAS,CAAC,UAAU,OAAO,KAAK,CAAC;AACvC,aAAG,GAAG,SAAS,CAAC,SAAS,OAAO,sBAAsB,IAAI,EAAE,CAAC;AAAA,QAC/D,CAAC;AAED,cAAM,KAAK,OAAO,EAAE;AAAA,MACtB,SAAS,GAAG;AACV,YAAI,WAAW,UAAU;AACvB,gBAAM,IAAI,MAAM,uCAAuC,OAAO,cAAc,CAAC,EAAE;AAAA,QACjF;AAEA,cAAM,QAAQ,KAAK,IAAI,UAAU,GAAG,EAAE;AACtC;AAEA,aAAK,QAAQ;AAAA,UACX,8CAA8C,KAAK,aAAa,CAAC,KAAK,OAAO,IAAI,QAAQ;AAAA,QAC3F;AACA,cAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,QAAQ,GAAI,CAAC;AAAA,MAClE;AAAA,IACF;AAEA,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,MAAM,OAAO,IAAe;AAC1B,QAAI,UAAU;AAEd,UAAM,YAAY,YAAY,MAAM;AAClC,UAAI;AACF,WAAG,KAAK,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC,CAAC;AAAA,MAC/C,QAAQ;AACN,sBAAc,SAAS;AACvB;AAAA,MACF;AAAA,IACF,GAAG,GAAI;AAEP,UAAM,WAAW,YAAY;AAC3B,YAAM,eAAe,KAAK,MAAM,KAAK,MAAM,aAAa,EAAE;AAC1D,YAAM,SAAS,IAAI;AAAA,QACjB,KAAK,MAAM;AAAA,QACX,KAAK,MAAM;AAAA,QACX;AAAA,MACF;AAEA,uBAAiB,QAAQ,KAAK,OAAO;AACnC,YAAI;AACJ,YAAI,SAAS,aAAa,gBAAgB;AACxC,mBAAS,OAAO,MAAM;AAAA,QACxB,WACE,KAAK,eAAe,KAAK,MAAM,cAC/B,KAAK,aAAa,KAAK,MAAM,aAC7B;AACA,mBAAS,OAAO,MAAM,KAAK,KAAK,MAAM;AAAA,QACxC,OAAO;AACL,gBAAM,IAAI,MAAM,sDAAsD;AAAA,QACxE;AAEA,yBAAiB,SAAS,QAAQ;AAChC,cAAI,KAAK,mBAAmB,UAAU,KAAK,GAAG;AAC5C,eAAG,KAAK,MAAM,KAAK,MAAM;AAAA,UAC3B;AAAA,QACF;AAAA,MACF;AAEA,gBAAU;AACV,SAAG,KAAK,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC,CAAC;AAAA,IACjD;AAEA,UAAM,aAAa,YAAY;AAC7B,UAAI;AAAA,QAAc,CAAC,GAAG,WACpB,GAAG,KAAK,SAAS,CAAC,MAAM,WAAW;AACjC,cAAI,CAAC,SAAS;AACZ,iBAAK,QAAQ,MAAM,8BAA8B,IAAI,KAAK,MAAM,EAAE;AAClE,mBAAO;AAAA,UACT;AAAA,QACF,CAAC;AAAA,MACH;AAEA,aAAO,CAAC,KAAK,QAAQ;AACnB,YAAI;AACF,gBAAM,IAAI,QAAiB,CAAC,YAAY;AACtC,eAAG,KAAK,WAAW,CAAC,SAAS,QAAQ,IAAI,CAAC;AAAA,UAC5C,CAAC,EAAE,KAAK,CAAC,QAAQ;AACf,kBAAM,OAAO,KAAK,MAAM,IAAI,SAAS,CAAC;AACtC,oBAAQ,KAAK,MAAM,GAAG;AAAA,cACpB,KAAK,iBAAiB;AAKpB,oBAAI,KAAK,UAAW;AACpB,qBAAK,YAAY;AACjB,qBAAK,MAAM,IAAI,EAAE,MAAM,IAAI,gBAAgB,gBAAgB,CAAC;AAC5D;AAAA,cACF;AAAA;AAAA;AAAA;AAAA,cAIA,KAAK,WAAW;AACd,sBAAM,UAAU,KAAK,UAAU;AAC/B,sBAAM,aAAa,KAAK,cAAc;AAEtC,sBAAM,eAAe,8BAA8B,KAAK,MAAM,UAAW,IAAI;AAK7E,oBAAI,aAAa,CAAC,KAAK,aAAa,CAAC,EAAE,MAAM;AAC3C,sBAAI,CAAC,KAAK,WAAW;AACnB,yBAAK,YAAY;AACjB,yBAAK,MAAM,IAAI,EAAE,MAAM,IAAI,gBAAgB,gBAAgB,CAAC;AAAA,kBAC9D;AAEA,sBAAI,SAAS;AACX,yBAAK,MAAM,IAAI;AAAA,sBACb,MAAM,IAAI,gBAAgB;AAAA,sBAC1B,cAAc,CAAC,aAAa,CAAC,GAAG,GAAG,aAAa,MAAM,CAAC,CAAC;AAAA,oBAC1D,CAAC;AAAA,kBACH,OAAO;AACL,yBAAK,MAAM,IAAI;AAAA,sBACb,MAAM,IAAI,gBAAgB;AAAA,sBAC1B,cAAc,CAAC,aAAa,CAAC,GAAG,GAAG,aAAa,MAAM,CAAC,CAAC;AAAA,oBAC1D,CAAC;AAAA,kBACH;AAAA,gBACF;AAKA,oBAAI,cAAc,KAAK,WAAW;AAChC,uBAAK,YAAY;AACjB,uBAAK,MAAM,IAAI,EAAE,MAAM,IAAI,gBAAgB,cAAc,CAAC;AAAA,gBAC5D;AAEA;AAAA,cACF;AAAA,cACA,KAAK,YAAY;AACf;AAAA,cACF;AAAA,cACA,SAAS;AACP,qBAAK,QAAQ,MAAM,EAAE,KAAK,KAAK,CAAC,EAAE,KAAK,2CAA2C;AAClF;AAAA,cACF;AAAA,YACF;AAAA,UACF,CAAC;AAAA,QACH,SAAS,OAAO;AACd,eAAK,QAAQ,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,8BAA8B;AACjE;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,UAAM,QAAQ,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,CAAC;AAC5C,kBAAc,SAAS;AAAA,EACzB;AACF;AAEA,MAAM,gCAAgC,CACpC,UACA,SACqB;AACrB,QAAM,OAAc,KAAK,SAAS,EAAE,cAAc;AAElD,SAAO,KAAK,IAAI,CAAC,SAAS;AAAA,IACxB;AAAA,IACA,WAAW,IAAI,OAAO,EAAE,SAAS,IAAI,OAAO,EAAE,CAAC,EAAE,OAAO,IAAI;AAAA,IAC5D,SAAS,IAAI,OAAO,EAAE,SAAS,IAAI,OAAO,EAAE,IAAI,OAAO,EAAE,SAAS,CAAC,EAAE,KAAK,IAAI;AAAA,IAC9E,YAAY,IAAI,YAAY;AAAA,IAC5B,MAAM,IAAI,YAAY;AAAA,EACxB,EAAE;AACJ;","names":["stt"]}

package/dist/stt.test.cjs

@@ -0,0 +1,11 @@
+"use strict";
+var import_agents = require("@livekit/agents");
+var import_agents_plugin_silero = require("@livekit/agents-plugin-silero");
+var import_agents_plugins_test = require("@livekit/agents-plugins-test");
+var import_vitest = require("vitest");
+var import_stt = require("./stt.cjs");
+(0, import_vitest.describe)("Deepgram", async () => {
+  (0, import_agents.initializeLogger)({ pretty: false });
+  await (0, import_agents_plugins_test.stt)(new import_stt.STT(), await import_agents_plugin_silero.VAD.load(), { nonStreaming: false });
+});
+//# sourceMappingURL=stt.test.cjs.map

package/dist/stt.test.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/stt.test.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport { initializeLogger } from '@livekit/agents';\nimport { VAD } from '@livekit/agents-plugin-silero';\nimport { stt } from '@livekit/agents-plugins-test';\nimport { describe } from 'vitest';\nimport { STT } from './stt.js';\n\ndescribe('Deepgram', async () => {\n  initializeLogger({ pretty: false });\n  await stt(new STT(), await VAD.load(), { nonStreaming: false });\n});\n"],"mappings":";AAGA,oBAAiC;AACjC,kCAAoB;AACpB,iCAAoB;AACpB,oBAAyB;AACzB,iBAAoB;AAAA,IAEpB,wBAAS,YAAY,YAAY;AAC/B,sCAAiB,EAAE,QAAQ,MAAM,CAAC;AAClC,YAAM,gCAAI,IAAI,eAAI,GAAG,MAAM,gCAAI,KAAK,GAAG,EAAE,cAAc,MAAM,CAAC;AAChE,CAAC;","names":[]}

package/dist/stt.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=stt.test.d.ts.map

package/dist/stt.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stt.test.d.ts","sourceRoot":"","sources":["../src/stt.test.ts"],"names":[],"mappings":""}

package/dist/stt.test.js

@@ -0,0 +1,10 @@
+import { initializeLogger } from "@livekit/agents";
+import { VAD } from "@livekit/agents-plugin-silero";
+import { stt } from "@livekit/agents-plugins-test";
+import { describe } from "vitest";
+import { STT } from "./stt.js";
+describe("Deepgram", async () => {
+  initializeLogger({ pretty: false });
+  await stt(new STT(), await VAD.load(), { nonStreaming: false });
+});
+//# sourceMappingURL=stt.test.js.map

package/dist/stt.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/stt.test.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport { initializeLogger } from '@livekit/agents';\nimport { VAD } from '@livekit/agents-plugin-silero';\nimport { stt } from '@livekit/agents-plugins-test';\nimport { describe } from 'vitest';\nimport { STT } from './stt.js';\n\ndescribe('Deepgram', async () => {\n  initializeLogger({ pretty: false });\n  await stt(new STT(), await VAD.load(), { nonStreaming: false });\n});\n"],"mappings":"AAGA,SAAS,wBAAwB;AACjC,SAAS,WAAW;AACpB,SAAS,WAAW;AACpB,SAAS,gBAAgB;AACzB,SAAS,WAAW;AAEpB,SAAS,YAAY,YAAY;AAC/B,mBAAiB,EAAE,QAAQ,MAAM,CAAC;AAClC,QAAM,IAAI,IAAI,IAAI,GAAG,MAAM,IAAI,KAAK,GAAG,EAAE,cAAc,MAAM,CAAC;AAChE,CAAC;","names":[]}

package/package.json

@@ -1,33 +1,45 @@
 {
   "name": "@livekit/agents-plugin-deepgram",
-  "version": "0.4.6",
+  "version": "0.5.1",
   "description": "Deepgram plugin for LiveKit Agents for Node.js",
   "main": "dist/index.js",
+  "require": "dist/index.cjs",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
   "author": "LiveKit",
   "type": "module",
   "repository": "git@github.com:livekit/agents-js.git",
   "license": "Apache-2.0",
   "files": [
     "dist",
-    "src"
+    "src",
+    "README.md"
   ],
   "devDependencies": {
+    "@livekit/agents": "^x",
+    "@livekit/agents-plugin-silero": "^x",
+    "@livekit/agents-plugins-test": "^x",
+    "@livekit/rtc-node": "^0.12.1",
     "@microsoft/api-extractor": "^7.35.0",
-    "@livekit/rtc-node": "^0.11.1",
     "@types/ws": "^8.5.10",
-    "typescript": "^5.0.0",
-    "@livekit/agents": "^0.4.6"
+    "tsup": "^8.3.5",
+    "typescript": "^5.0.0"
   },
   "dependencies": {
     "ws": "^8.16.0"
   },
   "peerDependencies": {
-    "@livekit/rtc-node": "^0.11.1",
-    "@livekit/agents": "^0.4.6"
+    "@livekit/rtc-node": "^0.12.1",
+    "@livekit/agents": "^0.6.0x"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsup --onSuccess \"tsc --declaration --emitDeclarationOnly\"",
     "clean": "rm -rf dist",
     "clean:build": "pnpm clean && pnpm build",
     "lint": "eslint -f unix \"src/**/*.{ts,js}\"",

package/src/stt.test.ts

@@ -0,0 +1,13 @@
+// SPDX-FileCopyrightText: 2024 LiveKit, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+import { initializeLogger } from '@livekit/agents';
+import { VAD } from '@livekit/agents-plugin-silero';
+import { stt } from '@livekit/agents-plugins-test';
+import { describe } from 'vitest';
+import { STT } from './stt.js';
+
+describe('Deepgram', async () => {
+  initializeLogger({ pretty: false });
+  await stt(new STT(), await VAD.load(), { nonStreaming: false });
+});

package/src/stt.ts

@@ -45,11 +45,12 @@ const defaultSTTOptions: STTOptions = {
 export class STT extends stt.STT {
   #opts: STTOptions;
   #logger = log();
+  label = 'deepgram.STT';
 
   constructor(opts: Partial<STTOptions> = defaultSTTOptions) {
     super({
       streaming: true,
-      interimResults: opts.interimResults || defaultSTTOptions.interimResults,
+      interimResults: opts.interimResults ?? defaultSTTOptions.interimResults,
     });
     if (opts.apiKey === undefined && defaultSTTOptions.apiKey === undefined) {
       throw new Error(
@@ -84,12 +85,12 @@ export class STT extends stt.STT {
   }
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  async recognize(_: AudioBuffer): Promise<stt.SpeechEvent> {
+  async _recognize(_: AudioBuffer): Promise<stt.SpeechEvent> {
     throw new Error('Recognize is not supported on Deepgram STT');
   }
 
   stream(): stt.SpeechStream {
-    return new SpeechStream(this.#opts);
+    return new SpeechStream(this, this.#opts);
   }
 }
 
@@ -98,9 +99,10 @@ export class SpeechStream extends stt.SpeechStream {
   #audioEnergyFilter: AudioEnergyFilter;
   #logger = log();
   #speaking = false;
+  label = 'deepgram.SpeechStream';
 
-  constructor(opts: STTOptions) {
-    super();
+  constructor(stt: STT, opts: STTOptions) {
+    super(stt);
     this.#opts = opts;
     this.closed = false;
     this.#audioEnergyFilter = new AudioEnergyFilter();
@@ -261,12 +263,12 @@ export class SpeechStream extends stt.SpeechStream {
                   if (isFinal) {
                     this.queue.put({
                       type: stt.SpeechEventType.FINAL_TRANSCRIPT,
-                      alternatives: [alternatives[0], ...alternatives.splice(0)],
+                      alternatives: [alternatives[0], ...alternatives.slice(1)],
                     });
                   } else {
                     this.queue.put({
                       type: stt.SpeechEventType.INTERIM_TRANSCRIPT,
-                      alternatives: [alternatives[0], ...alternatives.splice(0)],
+                      alternatives: [alternatives[0], ...alternatives.slice(1)],
                     });
                   }
                 }