@deepgram/sdk 3.12.1 → 3.13.0-beta.2

package/src/lib/types/AgentLiveSchema.ts

@@ -1,20 +1,3 @@
-type AudioFormat =
-  | {
-      encoding: "linear16";
-      container: "wav" | "none";
-      sampleRate: 8000 | 16000 | 24000 | 32000 | 48000;
-    }
-  | {
-      encoding: "mulaw";
-      container: "wav" | "none";
-      sampleRate: 8000 | 16000;
-    }
-  | {
-      encoding: "alaw";
-      container: "wav" | "none";
-      sampleRate: 8000 | 16000;
-    };
-
 type AudioEncoding =
   | "linear16"
   | "flac"
@@ -76,119 +59,129 @@ type SpeakModel =
   | "aura-zeus-en"
   | string;
 
-interface ThinkModelFunction {
-  name: string;
-  description: string;
-  url: string;
-  headers: [
-    {
-      key: "authorization";
-      value: string;
-    }
-  ];
-  method: "POST";
-  parameters: {
-    type: string;
-    properties: Record<
-      string,
-      {
-        type: string;
-        description: string;
-      }
-    >;
-  };
-}
-
-type ThinkModel =
-  | {
-      provider: {
-        type: "open_ai";
-      };
-      model: "gpt-4o-mini";
-      instructions?: string;
-      functions?: ThinkModelFunction[];
-    }
-  | {
-      provider: {
-        type: "anthropic";
-      };
-      model: "claude-3-haiku-20240307";
-      instructions?: string;
-      functions?: ThinkModelFunction[];
-    }
-  | {
-      provider: {
-        type: "groq";
-      };
-      model: "";
-      instructions?: string;
-      functions?: ThinkModelFunction[];
-    }
-  | {
-      provider: {
-        type: "custom";
-        url: string;
-        key: string;
-      };
-      model: string;
-      instructions?: string;
-      functions?: ThinkModelFunction[];
-    };
-
 /**
  * @see https://developers.deepgram.com/reference/voicebot-api-phase-preview#settingsconfiguration
  */
 interface AgentLiveSchema extends Record<string, unknown> {
+  /**
+   * Set to true to enable experimental features.
+   * @default false
+   */
+  experimental?: boolean;
   audio: {
     input?: {
       /**
-       * @default 1
+       * @default "linear16"
        */
-      channels?: number;
       encoding: AudioEncoding;
       /**
-       * @default false
+       * @default 16000
        */
-      multichannel?: boolean;
-      sampleRate: number;
+      sample_rate: number;
     };
     /**
      * @see https://developers.deepgram.com/docs/tts-media-output-settings#audio-format-combinations
      */
-    output?: AudioFormat;
-  };
-  agent: {
-    listen: {
+    output?: {
+      encoding?: string;
+      sample_rate?: number;
+      bitrate?: number;
       /**
-       * @see https://developers.deepgram.com/docs/model
+       * @default "none"
        */
-      model: ListenModel;
-      /**
-       * @see https://developers.deepgram.com/docs/keyterm
-       */
-      keyterms?: string[];
+      container?: string;
     };
-    speak: {
+  };
+  agent: {
+    language?: {
       /**
-       * @see https://developers.deepgram.com/docs/tts-models
+       * ISO 639-1 language code for agent language.
+       * @default "en"
        */
-      model: SpeakModel;
+      type: string;
+    };
+    listen?: {
+      provider: {
+        type: "deepgram";
+        /**
+         * @see https://developers.deepgram.com/docs/model
+         */
+        model: ListenModel;
+        /**
+         * Only available for Nova 3.
+         * @see https://developers.deepgram.com/docs/keyterm
+         */
+        keyterms?: string[];
+      };
+    };
+    speak?: {
+      provider: {
+        type: "deepgram" | "eleven_labs" | "cartesia" | "open_ai" | string;
+        /**
+         * Deepgram OR OpenAI model to use.
+         */
+        model?: SpeakModel;
+        /**
+         * Eleven Labs OR Cartesia model to use.
+         */
+        model_id?: string;
+        /**
+         * Cartesia voice configuration.
+         */
+        voice?: {
+          mode: string;
+          id: string;
+        };
+        /**
+         * Optional Cartesia language.
+         */
+        language?: string;
+        /**
+         * Optional Eleven Labs voice.
+         */
+        language_code?: string;
+      };
+      endpoint?: {
+        url?: string;
+        headers?: Record<string, string>;
+      };
     };
     /**
      * @see https://developers.deepgram.com/reference/voicebot-api-phase-preview#supported-llm-providers-and-models
      */
-    think: ThinkModel;
-  };
-  context?: {
-    /**
-     * LLM message history (e.g. to restore existing conversation if websocket disconnects)
-     */
-    messages: { role: "user" | "assistant"; content: string }[];
-    /**
-     * Whether to replay the last message, if it is an assistant message.
-     */
-    replay: boolean;
+    think?: {
+      provider: {
+        type: "deepgram" | "open_ai" | "anthropic" | "x_ai" | string;
+        model: string;
+        /**
+         * 0-2 for OpenAI, 0-1 for Anthropic.
+         */
+        temperature?: number;
+      };
+      /**
+       * Optional ONLY if LLM provider is Deepgram.
+       */
+      endpoint?: {
+        url?: string;
+        headers?: Record<string, string>;
+      };
+      functions?: {
+        name?: string;
+        description?: string;
+        parameters?: Record<string, unknown>;
+        endpoint?: {
+          url?: string;
+          method?: string;
+          headers?: Record<string, string>;
+        };
+      }[];
+      prompt?: string;
+    };
   };
+  /**
+   * Optional message the agent will say at the start of the connection.
+   */
+  greeting?: string;
 }
 
 export type { AgentLiveSchema, SpeakModel };

package/src/lib/types/FunctionCallResponse.ts

@@ -5,9 +5,13 @@ export interface FunctionCallResponse {
   /**
    * This must be the ID that was received in the request.
    */
-  function_call_id: string;
+  id: string;
+  /**
+   * The name of the function being called.
+   */
+  name: string;
   /**
    * The result of the function call.
    */
-  output: string;
+  content: string;
 }

package/src/lib/version.ts

@@ -1 +1 @@
-export const version = "3.12.1";
+export const version = "3.13.0-beta.2";

package/src/packages/AgentLiveClient.ts

@@ -12,7 +12,7 @@ import { AbstractLiveClient } from "./AbstractLiveClient";
 export class AgentLiveClient extends AbstractLiveClient {
   public namespace: string = "agent";
 
-  constructor(options: DeepgramClientOptions, endpoint: string = "/agent") {
+  constructor(options: DeepgramClientOptions, endpoint: string = "/:version/agent/converse") {
     super(options);
     this.baseUrl = options.agent?.websocket?.options?.url ?? DEFAULT_AGENT_URL;
 
@@ -59,6 +59,7 @@ export class AgentLiveClient extends AbstractLiveClient {
       } catch (error) {
         this.emit(AgentEvents.Error, {
           event,
+          data: event.data,
           message: "Unable to parse `data` as JSON.",
           error,
         });
@@ -104,41 +105,27 @@ export class AgentLiveClient extends AbstractLiveClient {
    * To be called with your model configuration BEFORE sending
    * any audio data.
    * @param options - The SettingsConfiguration object.
-   * @param options.audio.input.encoding - The encoding for your inbound (user) audio.
-   * @param options.audio.input.sampleRate - The sample rate for your inbound (user) audio.
-   * @param options.audio.output.encoding - The encoding for your outbound (agent) audio.
-   * @param options.audio.output.sampleRate - The sample rate for your outbound (agent) audio.
-   * @param options.audio.output.bitrate - The bitrate for your outbound (agent) audio.
-   * @param options.audio.output.container - The container for your outbound (agent) audio.
-   * @param options.agent.listen.model - The STT model to use for processing user audio.
-   * @param options.agent.speak.model - The TTS model to use for generating agent audio.
-   * @param options.agent.think.provider.type - The LLM provider to use.
-   * @param options.agent.think.model - The LLM model to use.
-   * @param options.agent.think.instructions - The instructions to provide to the LLM.
-   * @param options.agent.think.functions - The functions to provide to the LLM.
-   * @param options.context.messages - The message history to provide to the LLM (useful if a websocket connection is lost.)
-   * @param options.context.replay - Whether to replay the last message if it was an assistant message.
    */
   public configure(options: AgentLiveSchema): void {
-    // @ts-expect-error Not every consumer of the SDK is using TypeScript, this conditional exists to catch runtime errors for JS code where there is no compile-time checking.
-    if (!options.agent.listen.model.startsWith("nova-3") && options.agent.listen.keyterm?.length) {
+    if (
+      !options.agent.listen?.provider.model.startsWith("nova-3") &&
+      options.agent.listen?.provider.keyterms?.length
+    ) {
       throw new DeepgramError("Keyterms are only supported with the Nova 3 models.");
     }
-    // Converting the property names...
-    const opts: Record<string, any> = { ...options };
-    opts.audio.input["sample_rate"] = options.audio.input?.sampleRate;
-    delete opts.audio.input.sampleRate;
-    opts.audio.output["sample_rate"] = options.audio.output?.sampleRate;
-    delete opts.audio.output.sampleRate;
-    this.send(JSON.stringify({ type: "SettingsConfiguration", ...opts }));
+    const string = JSON.stringify({
+      type: "Settings",
+      ...options,
+    });
+    this.send(string);
   }
 
   /**
    * Provide new instructions to the LLM.
    * @param instructions - The instructions to provide.
    */
-  public updateInstructions(instructions: string): void {
-    this.send(JSON.stringify({ type: "UpdateInstructions", instructions }));
+  public updatePrompt(instructions: string): void {
+    this.send(JSON.stringify({ type: "UpdatePrompt", instructions }));
   }
 
   /**
@@ -165,8 +152,6 @@ export class AgentLiveClient extends AbstractLiveClient {
   /**
    * Respond to a function call request.
    * @param response  - The response to the function call request.
-   * @param response.function_call_id - The ID that was received in the request (these MUST match).
-   * @param response.output - The result of the function call.
    */
   public functionCallResponse(response: FunctionCallResponse): void {
     this.send(JSON.stringify({ type: "FunctionCallResponse", ...response }));