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

livekit/plugins/fal/__init__.py

@@ -0,0 +1,46 @@
+# Copyright 2023 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Copyright 2023 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from .stt import WizperSTT
+from .version import __version__
+
+__all__ = ["WizperSTT", "__version__"]
+
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class FalPlugin(Plugin):
+    def __init__(self):
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(FalPlugin())

livekit/plugins/fal/log.py

@@ -0,0 +1,3 @@
+import logging
+
+logger = logging.getLogger("livekit.plugins.fal")

livekit/plugins/fal/stt.py

@@ -0,0 +1,108 @@
+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.stt import SpeechEventType, STTCapabilities
+from livekit.agents.utils import AudioBuffer
+
+
+@dataclass
+class _STTOptions:
+    language: str
+    task: str
+    chunk_level: str
+    version: str
+
+
+class WizperSTT(stt.STT):
+    def __init__(
+        self,
+        *,
+        language: Optional[str] = "en",
+        task: Optional[str] = "transcribe",
+        chunk_level: Optional[str] = "segment",
+        version: Optional[str] = "3",
+    ):
+        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()
+
+        if not self._api_key:
+            raise ValueError(
+                "FAL AI API key is required. It should be set with env FAL_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
+
+    async def _recognize_impl(
+        self,
+        buffer: AudioBuffer,
+        *,
+        language: str | None,
+        conn_options: APIConnectOptions,
+    ) -> stt.SpeechEvent:
+        try:
+            config = self._sanitize_options(language=language)
+            data_uri = fal_client.encode(
+                rtc.combine_audio_frames(buffer).to_wav_bytes(), "audio/x-wav"
+            )
+            response = await self._fal_client.run(
+                "fal-ai/wizper",
+                arguments={
+                    "audio_url": data_uri,
+                    "task": config.task,
+                    "language": config.language,
+                    "chunk_level": config.chunk_level,
+                    "version": config.version,
+                },
+                timeout=conn_options.timeout,
+            )
+            text = response.get("text", "")
+            return self._transcription_to_speech_event(text=text)
+        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:
+        return stt.SpeechEvent(
+            type=event_type,
+            alternatives=[stt.SpeechData(text=text, language=self._opts.language)],
+        )
+
+    async def aclose(self) -> None:
+        await self._fal_client._client.aclose()

livekit/plugins/fal/version.py

@@ -0,0 +1,15 @@
+# Copyright 2023 LiveKit, Inc.
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__version__ = "0.2.3"

livekit_plugins_fal-0.2.3.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.2
+Name: livekit-plugins-fal
+Version: 0.2.3
+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
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9.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
+
+This plugin provides a simple way to integrate FAL models into the LiveKit Agent Framework. currently supports Whizper model for STT
+
+## Installation
+
+```bash
+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`

livekit_plugins_fal-0.2.3.dist-info/RECORD

@@ -0,0 +1,9 @@
+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/WHEEL

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

livekit_plugins_fal-0.2.3.dist-info/top_level.txt

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