livekit-plugins-fal 0.2.3__py3-none-any.whl → 1.0.0__py3-none-any.whl

livekit/plugins/fal/stt.py

@@ -1,82 +1,56 @@
 from __future__ import annotations
 
-import dataclasses
 import os
 from dataclasses import dataclass
-from typing import Optional
 
 import fal_client
+
 from livekit import rtc
-from livekit.agents import (
-    APIConnectionError,
-    APIConnectOptions,
-    stt,
-)
+from livekit.agents import APIConnectionError, APIConnectOptions, stt
 from livekit.agents.stt import SpeechEventType, STTCapabilities
-from livekit.agents.utils import AudioBuffer
+from livekit.agents.types import (
+    NOT_GIVEN,
+    NotGivenOr,
+)
+from livekit.agents.utils import AudioBuffer, is_given
 
 
 @dataclass
 class _STTOptions:
-    language: str
-    task: str
-    chunk_level: str
-    version: str
+    language: str = "en"
+    task: str = "transcribe"
+    chunk_level: str = "segment"
+    version: str = "3"
 
 
 class WizperSTT(stt.STT):
     def __init__(
         self,
         *,
-        language: Optional[str] = "en",
-        task: Optional[str] = "transcribe",
-        chunk_level: Optional[str] = "segment",
-        version: Optional[str] = "3",
+        language: NotGivenOr[str] = NOT_GIVEN,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
     ):
-        super().__init__(
-            capabilities=STTCapabilities(streaming=False, interim_results=True)
-        )
-        self._api_key = os.getenv("FAL_KEY")
-        self._opts = _STTOptions(
-            language=language or "en",
-            task=task or "transcribe",
-            chunk_level=chunk_level or "segment",
-            version=version or "3",
-        )
-        self._fal_client = fal_client.AsyncClient()
-
+        super().__init__(capabilities=STTCapabilities(streaming=False, interim_results=True))
+        self._api_key = api_key if is_given(api_key) else os.getenv("FAL_KEY")
         if not self._api_key:
-            raise ValueError(
-                "FAL AI API key is required. It should be set with env FAL_KEY"
-            )
+            raise ValueError("fal AI API key is required. It should be set with env FAL_KEY")
+        self._opts = _STTOptions(language=language)
+        self._fal_client = fal_client.AsyncClient(key=self._api_key)
 
-    def update_options(self, *, language: Optional[str] = None) -> None:
-        self._opts.language = language or self._opts.language
-
-    def _sanitize_options(
-        self,
-        *,
-        language: Optional[str] = None,
-        task: Optional[str] = None,
-        chunk_level: Optional[str] = None,
-        version: Optional[str] = None,
-    ) -> _STTOptions:
-        config = dataclasses.replace(self._opts)
-        config.language = language or config.language
-        config.task = task or config.task
-        config.chunk_level = chunk_level or config.chunk_level
-        config.version = version or config.version
-        return config
+    def update_options(self, *, language: NotGivenOr[str] = NOT_GIVEN) -> None:
+        if is_given(language):
+            self._opts.language = language
 
     async def _recognize_impl(
         self,
         buffer: AudioBuffer,
         *,
-        language: str | None,
+        language: NotGivenOr[str] = NOT_GIVEN,
         conn_options: APIConnectOptions,
     ) -> stt.SpeechEvent:
         try:
-            config = self._sanitize_options(language=language)
+            if is_given(language):
+                self._opts.language = language
             data_uri = fal_client.encode(
                 rtc.combine_audio_frames(buffer).to_wav_bytes(), "audio/x-wav"
             )
@@ -84,10 +58,10 @@ class WizperSTT(stt.STT):
                 "fal-ai/wizper",
                 arguments={
                     "audio_url": data_uri,
-                    "task": config.task,
-                    "language": config.language,
-                    "chunk_level": config.chunk_level,
-                    "version": config.version,
+                    "task": self._opts.task,
+                    "language": self._opts.language,
+                    "chunk_level": self._opts.chunk_level,
+                    "version": self._opts.version,
                 },
                 timeout=conn_options.timeout,
             )
@@ -96,11 +70,9 @@ class WizperSTT(stt.STT):
         except fal_client.client.FalClientError as e:
             raise APIConnectionError() from e
 
-    def _transcription_to_speech_event(
-        self, event_type=SpeechEventType.FINAL_TRANSCRIPT, text=None
-    ) -> stt.SpeechEvent:
+    def _transcription_to_speech_event(self, text: str) -> stt.SpeechEvent:
         return stt.SpeechEvent(
-            type=event_type,
+            type=SpeechEventType.FINAL_TRANSCRIPT,
             alternatives=[stt.SpeechData(text=text, language=self._opts.language)],
         )
 

livekit/plugins/fal/version.py

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

{livekit_plugins_fal-0.2.3.dist-info → livekit_plugins_fal-1.0.0.dist-info}/METADATA

@@ -1,40 +1,30 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: livekit-plugins-fal
-Version: 0.2.3
+Version: 1.0.0
 Summary: fal plugin template for LiveKit Agents
-Home-page: https://github.com/livekit/agents
-License: Apache-2.0
 Project-URL: Documentation, https://docs.livekit.io
 Project-URL: Website, https://livekit.io/
 Project-URL: Source, https://github.com/livekit/agents
-Keywords: webrtc,realtime,audio,video,livekit
+Author: LiveKit
+License-Expression: Apache-2.0
+Keywords: audio,livekit,realtime,video,webrtc
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Topic :: Multimedia :: Sound/Audio
-Classifier: Topic :: Multimedia :: Video
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Requires-Python: >=3.9.0
+Requires-Dist: fal-client
+Requires-Dist: livekit-agents>=1.0.0
 Description-Content-Type: text/markdown
-Requires-Dist: livekit-agents>=0.12.3
-Requires-Dist: fal_client
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
-# LiveKit Plugins Fal
+# LiveKit Plugins fal
 
-This plugin provides a simple way to integrate FAL models into the LiveKit Agent Framework. currently supports Whizper model for STT
+This plugin provides a simple way to integrate fal.ai models into the LiveKit Agent Framework. currently supports Wizper model for STT.
 
 ## Installation
 
@@ -44,4 +34,4 @@ pip install livekit-plugins-fal
 
 ## Pre-requisites
 
-You'll need an API key from FAL. It can be set as an environment variable: `FAL_KEY`
+You'll need an API key from fal. It can be set as an environment variable: `FAL_KEY`

livekit_plugins_fal-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+livekit/plugins/fal/__init__.py,sha256=2yFGbnRBL846WEDry3a4CTTwWSiLSI4Otqhlo6g4Lf4,1476
+livekit/plugins/fal/log.py,sha256=E03cKaUVgXY2O7RpX33IQIaRCpFJ_nJMSkRCvCxX5fc,66
+livekit/plugins/fal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+livekit/plugins/fal/stt.py,sha256=i7kWKvftNbOZFaJzsrTz3gcO06m1dUnfQaWG8vAGSBo,2688
+livekit/plugins/fal/version.py,sha256=IXTajzAuMAW4EojJB_UdbQh6qGhB8Ud5EP6JVK2om3g,599
+livekit_plugins_fal-1.0.0.dist-info/METADATA,sha256=VKD1h-d5uha2r5u_j1I5LBJJ1-Tx4ZoHRlp0NVkfXdQ,1279
+livekit_plugins_fal-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+livekit_plugins_fal-1.0.0.dist-info/RECORD,,

{livekit_plugins_fal-0.2.3.dist-info → livekit_plugins_fal-1.0.0.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

livekit_plugins_fal-0.2.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-livekit/plugins/fal/__init__.py,sha256=2yFGbnRBL846WEDry3a4CTTwWSiLSI4Otqhlo6g4Lf4,1476
-livekit/plugins/fal/log.py,sha256=E03cKaUVgXY2O7RpX33IQIaRCpFJ_nJMSkRCvCxX5fc,66
-livekit/plugins/fal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-livekit/plugins/fal/stt.py,sha256=HGOX_E-W6MCpefQFGj_UPw8X9gvsmoVLAO65FAz6-Es,3348
-livekit/plugins/fal/version.py,sha256=hlkazOSjHhPITxXYBxVrCPGHhRf5IltBTWpXAL6jTfw,599
-livekit_plugins_fal-0.2.3.dist-info/METADATA,sha256=Gu-XJuqmc0C1MKfsWvlvZGx9wmCj8rJRRLGKPbpvNpc,1510
-livekit_plugins_fal-0.2.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-livekit_plugins_fal-0.2.3.dist-info/top_level.txt,sha256=OoDok3xUmXbZRvOrfvvXB-Juu4DX79dlq188E19YHoo,8
-livekit_plugins_fal-0.2.3.dist-info/RECORD,,

livekit_plugins_fal-0.2.3.dist-info/top_level.txt

@@ -1 +0,0 @@
-livekit