Merge pull request #290 from dvonthenen/live-client-custom-options

Implement Custom Options for Live Clients

Author: davidvonthenen

Diff for: deepgram/clients/live/v1/async_client.py

@@ -45,10 +45,17 @@ def __init__(self, config: DeepgramClientOptions):
         self._event_handlers = {event: [] for event in LiveTranscriptionEvents}
         self.websocket_url = convert_to_websocket_url(self.config.url, self.endpoint)
 
-    async def start(self, options: LiveOptions = None, addons: dict = None, **kwargs):
+    async def start(
+        self,
+        options: LiveOptions = None,
+        addons: dict = None,
+        members: dict = None,
+        **kwargs,
+    ):
         self.logger.debug("AsyncLiveClient.start ENTER")
         self.logger.info("kwargs: %s", options)
         self.logger.info("addons: %s", addons)
+        self.logger.info("members: %s", members)
         self.logger.info("options: %s", kwargs)
 
         if options is not None and not options.check():
@@ -57,8 +64,13 @@ async def start(self, options: LiveOptions = None, addons: dict = None, **kwargs
             raise DeepgramError("Fatal transcription options error")
 
         self.options = options
-        if addons is not None:
-            self.__dict__.update(addons)
+        self.addons = addons
+
+        # add "members" as members of the class
+        if members is not None:
+            self.__dict__.update(members)
+
+        # add "kwargs" as members of the class
         if kwargs is not None:
             self.kwargs = kwargs
         else:
@@ -68,7 +80,14 @@ async def start(self, options: LiveOptions = None, addons: dict = None, **kwargs
             self.logger.info("LiveOptions switching class -> json")
             self.options = self.options.to_dict()
 
-        url_with_params = append_query_params(self.websocket_url, self.options)
+        combined_options = dict(self.options)
+        if addons is not None:
+            self.logger.info("merging addons to options")
+            combined_options.update(addons)
+            self.logger.info("new options: %s", combined_options)
+        self.logger.debug("combined_options: %s", combined_options)
+
+        url_with_params = append_query_params(self.websocket_url, combined_options)
         try:
             self._socket = await _socket_connect(url_with_params, self.config.headers)
             asyncio.create_task(self._start())

Diff for: deepgram/clients/live/v1/client.py

@@ -50,13 +50,20 @@ def __init__(self, config: DeepgramClientOptions):
         self._event_handlers = {event: [] for event in LiveTranscriptionEvents}
         self.websocket_url = convert_to_websocket_url(self.config.url, self.endpoint)
 
-    def start(self, options: LiveOptions = None, addons: dict = None, **kwargs):
+    def start(
+        self,
+        options: LiveOptions = None,
+        addons: dict = None,
+        members: dict = None,
+        **kwargs,
+    ):
         """
         Starts the WebSocket connection for live transcription.
         """
         self.logger.debug("LiveClient.start ENTER")
         self.logger.info("kwargs: %s", options)
-        self.logger.info("addon: %s", addons)
+        self.logger.info("addons: %s", addons)
+        self.logger.info("members: %s", members)
         self.logger.info("options: %s", kwargs)
 
         if options is not None and not options.check():
@@ -65,8 +72,13 @@ def start(self, options: LiveOptions = None, addons: dict = None, **kwargs):
             raise DeepgramError("Fatal transcription options error")
 
         self.options = options
-        if addons is not None:
-            self.__dict__.update(addons)
+        self.addons = addons
+
+        # add "members" as members of the class
+        if members is not None:
+            self.__dict__.update(members)
+
+        # set kwargs as members of the class
         if kwargs is not None:
             self.kwargs = kwargs
         else:
@@ -81,7 +93,14 @@ def start(self, options: LiveOptions = None, addons: dict = None, **kwargs):
             self.logger.debug("LiveClient.start LEAVE")
             raise DeepgramWebsocketError("Websocket already started")
 
-        url_with_params = append_query_params(self.websocket_url, self.options)
+        combined_options = dict(self.options)
+        if addons is not None:
+            self.logger.info("merging addons to options")
+            combined_options.update(addons)
+            self.logger.info("new options: %s", combined_options)
+        self.logger.debug("combined_options: %s", combined_options)
+
+        url_with_params = append_query_params(self.websocket_url, combined_options)
         self._socket = connect(url_with_params, additional_headers=self.config.headers)
 
         self.exit = False

Diff for: examples/advanced/streaming/microphone-inheritance/main.py

@@ -89,7 +89,12 @@ def main():
             utterance_end_ms="1000",
             vad_events=True,
         )
-        liveClient.start(options, addons=dict(myattr="hello"), test="hello")
+        liveClient.start(
+            options,
+            members=dict(myattr="hello", mytest="goodbye"),
+            addons=dict(smart_format=True),
+            test="hello",
+        )
 
         # Open a microphone stream
         microphone = Microphone(liveClient.send)

Diff for: examples/streaming/async_http/main.py

@@ -13,11 +13,6 @@
 
 API_KEY = os.getenv("DG_API_KEY")
 
-options = LiveOptions(
-    model="nova-2",
-    language="en-US",
-)
-
 # URL for the realtime streaming audio you would like to transcribe
 URL = "http://stream.live.vc.bbcmedia.co.uk/bbc_world_service"
 
@@ -54,6 +49,11 @@ async def on_error(self, error, **kwargs):
         dg_connection.on(LiveTranscriptionEvents.Error, on_error)
 
         # connect to websocket
+        options = LiveOptions(
+            model="nova-2",
+            language="en-US",
+        )
+
         await dg_connection.start(options)
 
         # Send streaming audio from the URL to Deepgram

Diff for: examples/streaming/microphone/main.py

@@ -66,7 +66,7 @@ def on_error(self, error, **kwargs):
             utterance_end_ms="1000",
             vad_events=True,
         )
-        dg_connection.start(options, addons=dict(myattr="hello"), test="hello")
+        dg_connection.start(options)
 
         # Open a microphone stream on the default input device
         microphone = Microphone(dg_connection.send)