feat: support nova-3 in agent

Author: naomi-lgbt

examples/node-agent-live/index.js

@@ -27,7 +27,8 @@ const agent = async () => {
       },
       agent: {
         listen: {
-          model: "nova-2",
+          model: "nova-3",
+          keyterms: ["spacewalk"],
         },
         speak: {
           model: "aura-asteria-en",

src/lib/types/AgentLiveSchema.ts

@@ -26,6 +26,8 @@ type AudioEncoding =
   | "g729";
 
 type ListenModel =
+  | "nova-3"
+  | "nova-3-general"
   | "nova-2"
   | "nova-2-meeting"
   | "nova-2-phonecall"
@@ -152,12 +154,23 @@ interface AgentLiveSchema extends Record<string, unknown> {
     output?: AudioFormat;
   };
   agent: {
-    listen: {
-      /**
-       * @see https://developers.deepgram.com/docs/model
-       */
-      model: ListenModel;
-    };
+    listen:
+      | {
+          /**
+           * @see https://developers.deepgram.com/docs/model
+           */
+          model: Exclude<ListenModel, "nova-3" | "nova-3-general">;
+        }
+      | {
+          /**
+           * @see https://developers.deepgram.com/docs/model
+           */
+          model: Extract<ListenModel, "nova-3" | "nova-3-general">;
+          /**
+           * @see https://developers.deepgram.com/docs/keyterm
+           */
+          keyterms: string[];
+        };
     speak: {
       /**
        * @see https://developers.deepgram.com/docs/tts-models

src/packages/AgentLiveClient.ts

@@ -1,5 +1,6 @@
 import { DEFAULT_AGENT_URL } from "../lib/constants";
 import { AgentEvents } from "../lib/enums/AgentEvents";
+import { DeepgramError } from "../lib/errors.js";
 import type {
   AgentLiveSchema,
   SpeakModel,
@@ -119,6 +120,10 @@ export class AgentLiveClient extends AbstractLiveClient {
    * @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.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;