livekit-plugins-fal 1.3.11__tar.gz

livekit_plugins_fal-1.3.11/.gitignore

@@ -0,0 +1,179 @@
+**/.vscode
+**/.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# trunk
+.trunk/
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+node_modules
+
+credentials.json
+pyrightconfig.json
+docs/
+
+# Database files
+*.db
+
+
+# Examples for development
+examples/dev/*

livekit_plugins_fal-1.3.11/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-fal
+Version: 1.3.11
+Summary: fal plugin template for LiveKit Agents
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://livekit.io/
+Project-URL: Source, https://github.com/livekit/agents
+Author: LiveKit
+License-Expression: Apache-2.0
+Keywords: ai,audio,livekit,realtime,video,voice,webrtc
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+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.3.11
+Description-Content-Type: text/markdown
+
+# fal plugin for LiveKit Agents
+
+Support for speech-to-text with [fal.ai](https://fal.ai/).
+
+See [https://docs.livekit.io/agents/integrations/stt/fal/](https://docs.livekit.io/agents/integrations/stt/fal/) for more information.
+
+## 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-1.3.11/README.md

@@ -0,0 +1,15 @@
+# fal plugin for LiveKit Agents
+
+Support for speech-to-text with [fal.ai](https://fal.ai/).
+
+See [https://docs.livekit.io/agents/integrations/stt/fal/](https://docs.livekit.io/agents/integrations/stt/fal/) for more information.
+
+## 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-1.3.11/livekit/plugins/fal/__init__.py

@@ -0,0 +1,45 @@
+# 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.
+
+"""Fal plugin for LiveKit Agents
+
+See https://docs.livekit.io/agents/integrations/stt/fal/ for more information.
+"""
+
+from .stt import WizperSTT, WizperSTT as STT
+from .version import __version__
+
+__all__ = ["WizperSTT", "__version__", "STT"]
+
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class FalPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(FalPlugin())
+
+# Cleanup docs of unexported modules
+_module = dir()
+NOT_IN_ALL = [m for m in _module if m not in __all__]
+
+__pdoc__ = {}
+
+for n in NOT_IN_ALL:
+    __pdoc__[n] = False

livekit_plugins_fal-1.3.11/livekit/plugins/fal/log.py

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

livekit_plugins_fal-1.3.11/livekit/plugins/fal/stt.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+
+import fal_client
+
+from livekit import rtc
+from livekit.agents import APIConnectionError, APIConnectOptions, stt
+from livekit.agents.stt import SpeechEventType, STTCapabilities
+from livekit.agents.types import (
+    NOT_GIVEN,
+    NotGivenOr,
+)
+from livekit.agents.utils import AudioBuffer, is_given
+
+
+@dataclass
+class _STTOptions:
+    language: str = "en"
+    task: str = "transcribe"
+    chunk_level: str = "segment"
+    version: str = "3"
+
+
+class WizperSTT(stt.STT):
+    def __init__(
+        self,
+        *,
+        language: NotGivenOr[str] = NOT_GIVEN,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
+    ):
+        super().__init__(
+            capabilities=STTCapabilities(
+                streaming=False, interim_results=True, aligned_transcript=False
+            )
+        )
+        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")
+        self._opts = _STTOptions(language=language if is_given(language) else "en")
+        self._fal_client = fal_client.AsyncClient(key=self._api_key)
+
+    @property
+    def model(self) -> str:
+        return "Wizper"
+
+    @property
+    def provider(self) -> str:
+        return "Fal"
+
+    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: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions,
+    ) -> stt.SpeechEvent:
+        try:
+            if is_given(language):
+                self._opts.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": self._opts.task,
+                    "language": self._opts.language,
+                    "chunk_level": self._opts.chunk_level,
+                    "version": self._opts.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, text: str) -> stt.SpeechEvent:
+        return stt.SpeechEvent(
+            type=SpeechEventType.FINAL_TRANSCRIPT,
+            alternatives=[stt.SpeechData(text=text, language=self._opts.language)],
+        )
+
+    async def aclose(self) -> None:
+        await self._fal_client._client.aclose()

livekit_plugins_fal-1.3.11/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__ = "1.3.11"

livekit_plugins_fal-1.3.11/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "livekit-plugins-fal"
+dynamic = ["version"]
+description = "fal plugin template for LiveKit Agents"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.9.0"
+authors = [{ name = "LiveKit" }]
+keywords = ["voice", "ai", "realtime", "audio", "video", "livekit", "webrtc"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Multimedia :: Video",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = ["livekit-agents>=1.3.11", "fal_client"]
+
+[project.urls]
+Documentation = "https://docs.livekit.io"
+Website = "https://livekit.io/"
+Source = "https://github.com/livekit/agents"
+
+[tool.hatch.version]
+path = "livekit/plugins/fal/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["livekit"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/livekit"]