livekit-plugins-deepgram 1.0.0rc6__py3-none-any.whl → 1.0.0rc7__py3-none-any.whl

livekit/plugins/deepgram/stt.py

@@ -112,6 +112,7 @@ class STTOptions:
     energy_filter: AudioEnergyFilter | bool = False
     numerals: bool = False
     mip_opt_out: bool = False
+    tags: NotGivenOr[list[str]] = NOT_GIVEN
 
 
 class STT(stt.STT):
@@ -131,6 +132,7 @@ class STT(stt.STT):
         filler_words: bool = True,
         keywords: NotGivenOr[list[tuple[str, float]]] = NOT_GIVEN,
         keyterms: NotGivenOr[list[str]] = NOT_GIVEN,
+        tags: NotGivenOr[list[str]] = NOT_GIVEN,
         profanity_filter: bool = False,
         api_key: NotGivenOr[str] = NOT_GIVEN,
         http_session: aiohttp.ClientSession | None = None,
@@ -157,6 +159,7 @@ class STT(stt.STT):
                      `keywords` does not work with Nova-3 models. Use `keyterms` instead.
             keyterms: List of key terms to improve recognition accuracy. Defaults to None.
                      `keyterms` is supported by Nova-3 models.
+            tags: List of tags to add to the requests for usage reporting. Defaults to NOT_GIVEN.
             profanity_filter: Whether to filter profanity from the transcription. Defaults to False.
             api_key: Your Deepgram API key. If not provided, will look for DEEPGRAM_API_KEY environment variable.
             http_session: Optional aiohttp ClientSession to use for requests.
@@ -184,6 +187,7 @@ class STT(stt.STT):
             raise ValueError("Deepgram API key is required")
 
         model = _validate_model(model, language)
+        _validate_keyterms(model, language, keyterms, keywords)
 
         self._opts = STTOptions(
             language=language,
@@ -203,6 +207,7 @@ class STT(stt.STT):
             energy_filter=energy_filter,
             numerals=numerals,
             mip_opt_out=mip_opt_out,
+            tags=_validate_tags(tags) if is_given(tags) else [],
         )
         self._session = http_session
         self._streams = weakref.WeakSet[SpeechStream]()
@@ -300,6 +305,7 @@ class STT(stt.STT):
         profanity_filter: NotGivenOr[bool] = NOT_GIVEN,
         numerals: NotGivenOr[bool] = NOT_GIVEN,
         mip_opt_out: NotGivenOr[bool] = NOT_GIVEN,
+        tags: NotGivenOr[list[str]] = NOT_GIVEN,
     ):
         if is_given(language):
             self._opts.language = language
@@ -329,6 +335,8 @@ class STT(stt.STT):
             self._opts.numerals = numerals
         if is_given(mip_opt_out):
             self._opts.mip_opt_out = mip_opt_out
+        if is_given(tags):
+            self._opts.tags = _validate_tags(tags)
 
         for stream in self._streams:
             stream.update_options(
@@ -421,6 +429,7 @@ class SpeechStream(stt.SpeechStream):
         profanity_filter: NotGivenOr[bool] = NOT_GIVEN,
         numerals: NotGivenOr[bool] = NOT_GIVEN,
         mip_opt_out: NotGivenOr[bool] = NOT_GIVEN,
+        tags: NotGivenOr[list[str]] = NOT_GIVEN,
     ):
         if is_given(language):
             self._opts.language = language
@@ -450,6 +459,8 @@ class SpeechStream(stt.SpeechStream):
             self._opts.numerals = numerals
         if is_given(mip_opt_out):
             self._opts.mip_opt_out = mip_opt_out
+        if is_given(tags):
+            self._opts.tags = _validate_tags(tags)
 
         self._reconnect_event.set()
 
@@ -602,6 +613,9 @@ class SpeechStream(stt.SpeechStream):
         if self._opts.language:
             live_config["language"] = self._opts.language
 
+        if self._opts.tags:
+            live_config["tag"] = self._opts.tags
+
         ws = await asyncio.wait_for(
             self._session.ws_connect(
                 _to_deepgram_url(live_config, base_url=self._base_url, websocket=True),
@@ -749,7 +763,6 @@ def _to_deepgram_url(opts: dict, base_url: str, *, websocket: bool) -> str:
 
     elif not websocket and base_url.startswith("ws"):
         base_url = base_url.replace("ws", "http", 1)
-
     return f"{base_url}?{urlencode(opts, doseq=True)}"
 
 
@@ -776,3 +789,36 @@ def _validate_model(
         )
         return "nova-2-general"
     return model
+
+
+def _validate_tags(tags: list[str]) -> list[str]:
+    for tag in tags:
+        if len(tag) > 128:
+            raise ValueError("tag must be no more than 128 characters")
+    return tags
+
+
+def _validate_keyterms(
+    model: DeepgramModels | str,
+    language: NotGivenOr[DeepgramLanguages | str],
+    keyterms: NotGivenOr[list[str]],
+    keywords: NotGivenOr[list[tuple[str, float]]],
+) -> None:
+    """
+    Validating keyterms and keywords for model compatibility.
+    See: https://developers.deepgram.com/docs/keyterm and https://developers.deepgram.com/docs/keywords
+    """
+    if model.startswith("nova-3") and is_given(keywords):
+        raise ValueError(
+            "Keywords is only available for use with Nova-2, Nova-1, Enhanced, and "
+            "Base speech to text models. For Nova-3, use Keyterm Prompting."
+        )
+
+    if is_given(keyterms) and (
+        (model.startswith("nova-3") and language not in ("en-US", "en"))
+        or not model.startswith("nova-3")
+    ):
+        raise ValueError(
+            "Keyterm Prompting is only available for English transcription using the Nova-3 Model. "
+            "To boost recognition of keywords using another model, use the Keywords feature."
+        )

livekit/plugins/deepgram/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '1.0.0.rc6'
+__version__ = '1.0.0.rc7'

{livekit_plugins_deepgram-1.0.0rc6.dist-info → livekit_plugins_deepgram-1.0.0rc7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: livekit-plugins-deepgram
-Version: 1.0.0rc6
+Version: 1.0.0rc7
 Summary: Agent Framework plugin for services using Deepgram's API.
 Project-URL: Documentation, https://docs.livekit.io
 Project-URL: Website, https://livekit.io/
@@ -18,7 +18,7 @@ Classifier: Topic :: Multimedia :: Sound/Audio
 Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Requires-Python: >=3.9.0
-Requires-Dist: livekit-agents[codecs]>=1.0.0.rc6
+Requires-Dist: livekit-agents[codecs]>=1.0.0.rc7
 Requires-Dist: numpy>=1.26
 Description-Content-Type: text/markdown
 

{livekit_plugins_deepgram-1.0.0rc6.dist-info → livekit_plugins_deepgram-1.0.0rc7.dist-info}/RECORD

@@ -3,9 +3,9 @@ livekit/plugins/deepgram/_utils.py,sha256=0O3O77qURXjYYCenl5McE85fcBApaQvQl5zKQz
 livekit/plugins/deepgram/log.py,sha256=isjd2-ROJXiDFhRRnqRmYxv16U5H9dBV6ut2g5bU7q0,71
 livekit/plugins/deepgram/models.py,sha256=TdytPIBC5X6POp6QbfHqOIVee_7u6MQ1S7umlst6pNQ,1223
 livekit/plugins/deepgram/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-livekit/plugins/deepgram/stt.py,sha256=AnOfwX5cjD9-ox6r0uMmZa8Xp_S2tcIdN0UPbQM9On8,30625
+livekit/plugins/deepgram/stt.py,sha256=-TCeE9QIWFYZc2G5tvBbeXdF9nRAm9cAjsxC_DkrX8U,32497
 livekit/plugins/deepgram/tts.py,sha256=mIkm-jrPpDrqX_Fm3yvfSymWvaXPkzG6SAAQRojJHzg,15505
-livekit/plugins/deepgram/version.py,sha256=PDOEKN5zsYLQdbfAm5Di6G1sFYANNA0LqJR8zZzeghg,604
-livekit_plugins_deepgram-1.0.0rc6.dist-info/METADATA,sha256=HVTRa7ue2dfzHo04rwgd9lle5DBQq31I13iTIa03Ii8,1355
-livekit_plugins_deepgram-1.0.0rc6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-livekit_plugins_deepgram-1.0.0rc6.dist-info/RECORD,,
+livekit/plugins/deepgram/version.py,sha256=tiVbeZ_X3blYKeNH4fEAAE8RYOJd-aJvw5PvPOojzYc,604
+livekit_plugins_deepgram-1.0.0rc7.dist-info/METADATA,sha256=4-kf9H1z-iQ1ZcsFX32k4qKvlhTXwuLZOaR9bIFb8Sg,1355
+livekit_plugins_deepgram-1.0.0rc7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+livekit_plugins_deepgram-1.0.0rc7.dist-info/RECORD,,