@deepgram/sdk 3.5.1 → 3.7.0

package/src/DeepgramClient.ts

@@ -7,6 +7,7 @@ import {
   OnPremClient,
   SelfHostedRestClient,
   SpeakClient,
+  ModelsRestClient,
 } from "./packages";
 
 /**
@@ -33,6 +34,15 @@ export default class DeepgramClient extends AbstractClient {
     return new ManageClient(this.options);
   }
 
+  /**
+   * Returns a new instance of the ModelsRestClient, which provides access to the Deepgram API's model functionality.
+   *
+   * @returns {ModelsRestClient} A new instance of the ModelsRestClient.
+   */
+  get models(): ModelsRestClient {
+    return new ModelsRestClient(this.options);
+  }
+
   /**
    * Returns a new instance of the SelfHostedRestClient, which provides access to the Deepgram API's self-hosted functionality.
    *

package/src/lib/enums/LiveTTSEvents.ts

@@ -0,0 +1,36 @@
+/**
+ * Enumeration of events related to live text-to-speech synthesis.
+ *
+ * - `Open`: Built-in socket event for when the connection is opened.
+ * - `Close`: Built-in socket event for when the connection is closed.
+ * - `Error`: Built-in socket event for when an error occurs.
+ * - `Metadata`: Event for when metadata is received.
+ * - `Flushed`: Event for when the server has flushed the buffer.
+ * - `Warning`: Event for when a warning is received.
+ * - `Unhandled`: Catch-all event for any other message event.
+ */
+export enum LiveTTSEvents {
+  /**
+   * Built in socket events.
+   */
+  Open = "Open",
+  Close = "Close",
+  Error = "Error",
+
+  /**
+   * Message { type: string }
+   */
+  Metadata = "Metadata",
+  Flushed = "Flushed",
+  Warning = "Warning",
+
+  /**
+   * Audio data event.
+   */
+  Audio = "Audio",
+
+  /**
+   * Catch all for any other message event
+   */
+  Unhandled = "Unhandled",
+}

package/src/lib/enums/index.ts

@@ -1,2 +1,3 @@
 export * from "./LiveConnectionState";
 export * from "./LiveTranscriptionEvents";
+export * from "./LiveTTSEvents";

package/src/lib/types/GetModelsResponse.ts

@@ -0,0 +1,24 @@
+type Model = {
+  name: string;
+  canonical_name: string;
+  architecture: string;
+  languages?: string[];
+  version: string;
+  uuid: string;
+  batch?: boolean;
+  streaming?: boolean;
+  formatted_output?: boolean;
+  metadata?: {
+    accent: string;
+    color: string;
+    image: string;
+    sample: string;
+  };
+};
+
+export type GetModelResponse = Model;
+
+export type GetModelsResponse = {
+  stt: Model[];
+  tts: Model[];
+};

package/src/lib/types/GetModelsSchema.ts

@@ -0,0 +1,3 @@
+export interface GetModelsSchema extends Record<string, unknown> {
+  include_outdated?: boolean;
+}

package/src/lib/types/index.ts

@@ -8,6 +8,8 @@ export * from "./DeepgramClientOptions";
 export * from "./DeepgramResponse";
 export * from "./DeepgramSource";
 export * from "./Fetch";
+export * from "./GetModelsResponse";
+export * from "./GetModelsSchema";
 export * from "./GetProjectBalancesResponse";
 export * from "./GetProjectInvitesResponse";
 export * from "./GetProjectKeysResponse";

package/src/lib/version.ts

@@ -1 +1 @@
-export const version = "3.5.1";
+export const version = "3.7.0";

package/src/packages/ManageRestClient.ts

@@ -25,6 +25,9 @@ import type {
   UpdateProjectSchema,
   VoidResponse,
   GetTokenDetailsResponse,
+  GetModelsResponse,
+  GetModelResponse,
+  GetModelsSchema,
 } from "../lib/types";
 import { AbstractRestClient } from "./AbstractRestClient";
 
@@ -755,6 +758,85 @@ export class ManageRestClient extends AbstractRestClient {
       throw error;
     }
   }
+
+  /**
+   * Retrieves all models for a given project.
+   *
+   * @param projectId - The ID of the project.
+   * @param endpoint - (optional) The endpoint URL for retrieving models. Defaults to ":version/projects/:projectId/models".
+   * @returns A promise that resolves to a DeepgramResponse containing the GetModelsResponse.
+   * @example
+   * ```typescript
+   * import { createClient } from "@deepgram/sdk";
+   *
+   * const deepgram = createClient(DEEPGRAM_API_KEY);
+   * const { result: models, error } = deepgram.manage.getAllModels("projectId");
+   *
+   * if (error) {
+   *   console.error(error);
+   * } else {
+   *   console.log(models);
+   * }
+   * ```
+   */
+  async getAllModels(
+    projectId: string,
+    options: GetModelsSchema = {},
+    endpoint = ":version/projects/:projectId/models"
+  ): Promise<DeepgramResponse<GetModelsResponse>> {
+    try {
+      const requestUrl = this.getRequestUrl(endpoint, { projectId }, options);
+      const result: GetModelsResponse = await this.get(requestUrl).then((result) => result.json());
+
+      return { result, error: null };
+    } catch (error) {
+      if (isDeepgramError(error)) {
+        return { result: null, error };
+      }
+
+      throw error;
+    }
+  }
+
+  /**
+   * Retrieves a model from the specified project.
+   *
+   * @param projectId - The ID of the project.
+   * @param modelId - The ID of the model.
+   * @param endpoint - (optional) The endpoint URL for the request. Default value is ":version/projects/:projectId/models/:modelId".
+   * @returns A promise that resolves to a DeepgramResponse containing the GetModelResponse.
+   * @example
+   * ```typescript
+   * import { createClient } from "@deepgram/sdk";
+   *
+   * const deepgram = createClient(DEEPGRAM_API_KEY);
+   * const { result: model, error } = deepgram.models.getModel("projectId", "modelId");
+   *
+   * if (error) {
+   *   console.error(error);
+   * } else {
+   *   console.log(model);
+   * }
+   * ```
+   */
+  async getModel(
+    projectId: string,
+    modelId: string,
+    endpoint = ":version/projects/:projectId/models/:modelId"
+  ): Promise<DeepgramResponse<GetModelResponse>> {
+    try {
+      const requestUrl = this.getRequestUrl(endpoint, { projectId, modelId });
+      const result: GetModelResponse = await this.get(requestUrl).then((result) => result.json());
+
+      return { result, error: null };
+    } catch (error) {
+      if (isDeepgramError(error)) {
+        return { result: null, error };
+      }
+
+      throw error;
+    }
+  }
 }
 
 export { ManageRestClient as ManageClient };

package/src/packages/ModelsRestClient.ts

@@ -0,0 +1,93 @@
+import { isDeepgramError } from "../lib/errors";
+import {
+  DeepgramResponse,
+  GetModelResponse,
+  GetModelsResponse,
+  GetModelsSchema,
+} from "../lib/types";
+import { AbstractRestClient } from "./AbstractRestClient";
+
+/**
+ * Represents a REST client for interacting with the Deepgram API.
+ *
+ * The `ModelsRestClient` class provides methods for interacting with the Deepgram API to retrieve information about available models.
+ * @extends AbstractRestClient
+ */
+export class ModelsRestClient extends AbstractRestClient {
+  public namespace: string = "models";
+
+  /**
+   * Retrieves a list of all available models.
+   *
+   * @param endpoint - (optional) The endpoint to request.
+   * @returns A promise that resolves with the response from the Deepgram API.
+   * @example
+   * ```typescript
+   * import { createClient } from "@deepgram/sdk";
+   *
+   * const deepgram = createClient(DEEPGRAM_API_KEY);
+   * const { result: models, error } = deepgram.models.getAll();
+   *
+   * if (error) {
+   *   console.error(error);
+   * } else {
+   *   console.log(models);
+   * }
+   * ```
+   */
+  async getAll(
+    endpoint = ":version/models",
+    options: GetModelsSchema = {}
+  ): Promise<DeepgramResponse<GetModelsResponse>> {
+    try {
+      const requestUrl = this.getRequestUrl(endpoint, {}, options);
+      const result: GetModelsResponse = await this.get(requestUrl).then((result) => result.json());
+
+      return { result, error: null };
+    } catch (error) {
+      if (isDeepgramError(error)) {
+        return { result: null, error };
+      }
+
+      throw error;
+    }
+  }
+
+  /**
+   * Retrieves information about a specific model.
+   *
+   * @param modelId - The UUID of the model to retrieve.
+   * @param endpoint - (optional) The endpoint to request.
+   * @returns A promise that resolves with the response from the Deepgram API.
+   * @example
+   * ```typescript
+   * import { createClient } from "@deepgram/sdk";
+   *
+   * const deepgram = createClient(DEEPGRAM_API_KEY);
+   * const { result: model, error } = deepgram.models.getModel("modelId");
+   *
+   * if (error) {
+   *   console.error(error);
+   * } else {
+   *   console.log(model);
+   * }
+   * ```
+   */
+  async getModel(
+    modelId: string,
+    endpoint = ":version/models/:modelId"
+  ): Promise<DeepgramResponse<GetModelResponse>> {
+    try {
+      const requestUrl = this.getRequestUrl(endpoint, { modelId });
+      const result: GetModelResponse = await this.get(requestUrl).then((result) => result.json());
+
+      return { result, error: null };
+    } catch (error) {
+      if (isDeepgramError(error)) {
+        return { result: null, error };
+      }
+
+      throw error;
+    }
+  }
+}

package/src/packages/SpeakClient.ts

@@ -0,0 +1,35 @@
+import { AbstractClient } from "./AbstractClient";
+import { SpeakLiveClient } from "./SpeakLiveClient";
+import { SpeakRestClient } from "./SpeakRestClient";
+import { SpeakSchema } from "../lib/types";
+import { TextSource } from "../lib/types";
+
+/**
+ * The `SpeakClient` class extends the `AbstractClient` class and provides access to the "speak" namespace.
+ * It exposes two methods:
+ *
+ * 1. `request()`: Returns a `SpeakRestClient` instance for interacting with the rest speak API.
+ * 2. `live(ttsOptions: SpeakSchema = {}, endpoint = ":version/speak")`: Returns a `SpeakLiveClient` instance for interacting with the live speak API, with the provided TTS options and endpoint.
+ */
+export class SpeakClient extends AbstractClient {
+  public namespace: string = "speak";
+
+  /**
+   * Returns a `SpeakRestClient` instance for interacting with the rest speak API.
+   */
+  public request(source: TextSource, options?: SpeakSchema, endpoint = ":version/speak") {
+    const client = new SpeakRestClient(this.options);
+
+    return client.request(source, options, endpoint);
+  }
+
+  /**
+   * Returns a `SpeakLiveClient` instance for interacting with the live speak API, with the provided TTS options and endpoint.
+   * @param {SpeakSchema} [ttsOptions={}] - The TTS options to use for the live speak API.
+   * @param {string} [endpoint=":version/speak"] - The endpoint to use for the live speak API.
+   * @returns {SpeakLiveClient} - A `SpeakLiveClient` instance for interacting with the live speak API.
+   */
+  public live(ttsOptions: SpeakSchema = {}, endpoint: string = ":version/speak"): SpeakLiveClient {
+    return new SpeakLiveClient(this.options, ttsOptions, endpoint);
+  }
+}

package/src/packages/SpeakLiveClient.ts

@@ -0,0 +1,163 @@
+import { AbstractLiveClient } from "./AbstractLiveClient";
+import { LiveTTSEvents } from "../lib/enums";
+import type { SpeakSchema, DeepgramClientOptions } from "../lib/types";
+
+/**
+ * The `SpeakLiveClient` class extends the `AbstractLiveClient` class and provides functionality for setting up and managing a WebSocket connection for live text-to-speech synthesis.
+ *
+ * The constructor takes in `DeepgramClientOptions` and an optional `SpeakSchema` object, as well as an optional `endpoint` string. It then calls the `connect` method of the parent `AbstractLiveClient` class to establish the WebSocket connection.
+ *
+ * The `setupConnection` method is responsible for handling the various events that can occur on the WebSocket connection, such as opening, closing, and receiving messages. It sets up event handlers for these events and emits the appropriate events based on the message type.
+ *
+ * The `configure` method allows you to send additional configuration options to the connected session.
+ *
+ * The `requestClose` method requests the server to close the connection.
+ */
+export class SpeakLiveClient extends AbstractLiveClient {
+  public namespace: string = "speak";
+
+  /**
+   * Constructs a new `SpeakLiveClient` instance with the provided options.
+   *
+   * @param options - The `DeepgramClientOptions` to use for the client connection.
+   * @param speakOptions - An optional `SpeakSchema` object containing additional configuration options for the text-to-speech.
+   * @param endpoint - An optional string representing the WebSocket endpoint to connect to. Defaults to `:version/speak`.
+   */
+  constructor(
+    options: DeepgramClientOptions,
+    speakOptions: Omit<SpeakSchema, "container"> = {},
+    endpoint: string = ":version/speak"
+  ) {
+    super(options);
+
+    this.connect(speakOptions, endpoint);
+  }
+
+  /**
+   * Sets up the connection event handlers.
+   * This method is responsible for handling the various events that can occur on the WebSocket connection, such as opening, closing, and receiving data.
+   * - When the connection is opened, it emits the `LiveTTSEvents.Open` event.
+   * - When the connection is closed, it emits the `LiveTTSEvents.Close` event.
+   * - When an error occurs on the connection, it emits the `LiveTTSEvents.Error` event.
+   * - When a message is received, it parses the message and emits the appropriate event based on the message type, such as `LiveTTSEvents.Metadata`, `LiveTTSEvents.Flushed`, and `LiveTTSEvents.Warning`.
+   */
+  public setupConnection(): void {
+    if (this.conn) {
+      this.conn.onopen = () => {
+        this.emit(LiveTTSEvents.Open, this);
+      };
+
+      this.conn.onclose = (event: any) => {
+        this.emit(LiveTTSEvents.Close, event);
+      };
+
+      this.conn.onerror = (event: ErrorEvent) => {
+        this.emit(LiveTTSEvents.Error, event);
+      };
+
+      this.conn.onmessage = (event: MessageEvent) => {
+        this.handleMessage(event);
+      };
+    }
+  }
+
+  /**
+   * Handles text messages received from the WebSocket connection.
+   * @param data - The parsed JSON data.
+   */
+  protected handleTextMessage(data: any): void {
+    if (data.type === LiveTTSEvents.Metadata) {
+      this.emit(LiveTTSEvents.Metadata, data);
+    } else if (data.type === LiveTTSEvents.Flushed) {
+      this.emit(LiveTTSEvents.Flushed, data);
+    } else if (data.type === LiveTTSEvents.Warning) {
+      this.emit(LiveTTSEvents.Warning, data);
+    } else {
+      this.emit(LiveTTSEvents.Unhandled, data);
+    }
+  }
+
+  /**
+   * Handles binary messages received from the WebSocket connection.
+   * @param data - The binary data.
+   */
+  protected handleBinaryMessage(data: ArrayBuffer): void {
+    this.emit(LiveTTSEvents.Audio, data);
+  }
+
+  /**
+   * Sends a text input message to the server.
+   *
+   * @param {string} text - The text to convert to speech.
+   */
+  public sendText(text: string): void {
+    this.send(
+      JSON.stringify({
+        type: "Speak",
+        text,
+      })
+    );
+  }
+
+  /**
+   * Requests the server flush the current buffer and return generated audio.
+   */
+  public flush(): void {
+    this.send(
+      JSON.stringify({
+        type: "Flush",
+      })
+    );
+  }
+
+  /**
+   * Requests the server clear the current buffer.
+   */
+  public clear(): void {
+    this.send(
+      JSON.stringify({
+        type: "Clear",
+      })
+    );
+  }
+
+  /**
+   * Requests the server close the connection.
+   */
+  public requestClose(): void {
+    this.send(
+      JSON.stringify({
+        type: "Close",
+      })
+    );
+  }
+
+  /**
+   * Handles incoming messages from the WebSocket connection.
+   * @param event - The MessageEvent object representing the received message.
+   */
+  protected handleMessage(event: MessageEvent): void {
+    if (typeof event.data === "string") {
+      try {
+        const data = JSON.parse(event.data);
+        this.handleTextMessage(data);
+      } catch (error) {
+        this.emit(LiveTTSEvents.Error, {
+          event,
+          message: "Unable to parse `data` as JSON.",
+          error,
+        });
+      }
+    } else if (event.data instanceof ArrayBuffer) {
+      this.handleBinaryMessage(event.data);
+    } else if (Buffer.isBuffer(event.data)) {
+      this.handleBinaryMessage(event.data.buffer);
+    } else {
+      console.log("Received unknown data type", event.data);
+      this.emit(LiveTTSEvents.Error, {
+        event,
+        message: "Received unknown data type.",
+      });
+    }
+  }
+}

package/src/packages/SpeakRestClient.ts

@@ -75,5 +75,3 @@ export class SpeakRestClient extends AbstractRestClient {
     return this.result.headers;
   }
 }
-
-export { SpeakRestClient as SpeakClient };

package/src/packages/index.ts

@@ -5,6 +5,9 @@ export * from "./ListenClient";
 export * from "./ListenLiveClient";
 export * from "./ListenRestClient";
 export * from "./ManageRestClient";
+export * from "./ModelsRestClient";
 export * from "./ReadRestClient";
 export * from "./SelfHostedRestClient";
+export * from "./SpeakClient";
+export * from "./SpeakLiveClient";
 export * from "./SpeakRestClient";