Merge pull request #396 from dvonthenen/implement-flush-feature

Implements `Finalize`

Author: davidvonthenen

deepgram/clients/live/enums.py

@@ -16,6 +16,7 @@ class LiveTranscriptionEvents(str, Enum):
     Metadata: str = "Metadata"
     UtteranceEnd: str = "UtteranceEnd"
     SpeechStarted: str = "SpeechStarted"
+    Finalize: str = "Finalize"
     Error: str = "Error"
     Unhandled: str = "Unhandled"
     Warning: str = "Warning"

deepgram/clients/live/v1/async_client.py

@@ -461,6 +461,31 @@ async def send(self, data: Union[str, bytes]) -> bool:
         self.logger.spam("AsyncLiveClient.send LEAVE")
         return False
 
+    async def finalize(self) -> bool:
+        """
+        Finalizes the Transcript connection by flushing it
+        """
+        self.logger.spam("AsyncLiveClient.finalize ENTER")
+
+        if self._exit_event.is_set():
+            self.logger.notice("finalize exiting gracefully")
+            self.logger.debug("AsyncLiveClient.finalize LEAVE")
+            return False
+
+        if self._socket is not None:
+            self.logger.notice("sending Finalize...")
+            ret = await self.send(json.dumps({"type": "Finalize"}))
+
+            if not ret:
+                self.logger.error("finalize failed")
+                self.logger.spam("AsyncLiveClient.finalize LEAVE")
+                return False
+
+        self.logger.notice("finalize succeeded")
+        self.logger.spam("AsyncLiveClient.finalize LEAVE")
+
+        return True
+
     # closes the WebSocket connection gracefully
     async def finish(self) -> bool:
         """

deepgram/clients/live/v1/client.py

@@ -462,6 +462,31 @@ def send(self, data: Union[str, bytes]) -> bool:
         self.logger.spam("LiveClient.send LEAVE")
         return False
 
+    def finalize(self) -> bool:
+        """
+        Finalizes the Transcript connection by flushing it
+        """
+        self.logger.spam("LiveClient.finalize ENTER")
+
+        if self._exit_event.is_set():
+            self.logger.notice("finalize exiting gracefully")
+            self.logger.debug("LiveClient.finalize LEAVE")
+            return False
+
+        if self._socket is not None:
+            self.logger.notice("sending Finalize...")
+            ret = self.send(json.dumps({"type": "Finalize"}))
+
+            if not ret:
+                self.logger.error("finalize failed")
+                self.logger.spam("LiveClient.finalize LEAVE")
+                return False
+
+        self.logger.notice("finalize succeeded")
+        self.logger.spam("LiveClient.finalize LEAVE")
+
+        return True
+
     # closes the WebSocket connection gracefully
     def finish(self) -> bool:
         """

deepgram/clients/live/v1/response.py

@@ -153,6 +153,9 @@ class LiveResultResponse:
     duration: float = 0
     start: float = 0
     is_final: bool = False
+    from_finalize: Optional[bool] = field(
+        default=None, metadata=config(exclude=lambda f: f is None)
+    )
     speech_final: bool = False
     channel: Channel = None
     metadata: Metadata = None