Merge pull request #507 from deepgram/revert/keyterms

revert: keyterm -> keyterms

Author: naomi-lgbt

deepgram/clients/agent/v1/websocket/async_client.py

@@ -225,6 +225,9 @@ async def start(
         else:
             raise DeepgramError("Invalid options type")
 
+        if self._settings.agent.listen.keyterms is not None and self._settings.agent.listen.model is not None and not self._settings.agent.listen.model.startswith("nova-3"):
+            raise DeepgramError("Keyterms are only supported for nova-3 models")
+
         try:
             # speaker substitutes the listening thread
             if self._speaker is not None:

deepgram/clients/agent/v1/websocket/client.py

@@ -226,6 +226,9 @@ def start(
         else:
             raise DeepgramError("Invalid options type")
 
+        if self._settings.agent.listen.keyterms is not None and self._settings.agent.listen.model is not None and not self._settings.agent.listen.model.startswith("nova-3"):
+            raise DeepgramError("Keyterms are only supported for nova-3 models")
+
         try:
             # speaker substitutes the listening thread
             if self._speaker is not None:

deepgram/clients/agent/v1/websocket/options.py

@@ -26,6 +26,9 @@ class Listen(BaseResponse):
     model: Optional[str] = field(
         default=None, metadata=dataclass_config(exclude=lambda f: f is None)
     )
+    keyterms: Optional[List[str]] = field(
+        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
+    )
 
 
 @dataclass

examples/agent/simple/main.py

@@ -136,6 +136,8 @@ def on_unhandled(self, unhandled, **kwargs):
 
         # connect to websocket
         options: SettingsConfigurationOptions = SettingsConfigurationOptions()
+        options.agent.listen.model = "nova-3"
+        options.agent.listen.keyterms = ["hello", "goodbye"]
         options.agent.think.provider.type = "open_ai"
         options.agent.think.model = "gpt-4o-mini"
         options.agent.think.instructions = "You are a helpful AI assistant."