livekit-plugins-palabra 1.7.1__tar.gz

livekit_plugins_palabra-1.7.1/.gitignore

@@ -0,0 +1,180 @@
+**/.vscode
+**/.DS_Store
+.env
+
+# 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_palabra-1.7.1/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.5
+Name: livekit-plugins-palabra
+Version: 1.7.1
+Summary: LiveKit Agents plugin for Palabra realtime STT and TTS.
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://palabra.ai/
+Project-URL: Source, https://github.com/livekit/agents
+Author-email: LiveKit <hello@livekit.io>
+License-Expression: Apache-2.0
+Keywords: ai,audio,livekit,palabra,realtime,stt,tts,voice
+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.10
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10.0
+Requires-Dist: livekit-agents>=1.7.1
+Requires-Dist: palabra-ai>=2.0.2
+Description-Content-Type: text/markdown
+
+# Palabra plugin for LiveKit Agents
+
+Support for Palabra realtime [Speech-to-Text](https://platform.palabra.ai/docs/speech-to-text/realtime-stt) and [Text-to-Speech](https://platform.palabra.ai/docs/text-to-speech/realtime-tts) APIs, using WebSocket streaming interfaces.
+
+See [STT documentation](https://docs.livekit.io/agents/models/stt/palabra/) and [TTS documentation](https://docs.livekit.io/agents/models/tts/palabra/) for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-palabra
+```
+
+## Pre-requisites
+
+The Palabra plugin requires an API key to authenticate. You can create one at [platform.palabra.ai/api-keys](https://platform.palabra.ai/api-keys).
+
+Set the API key in your `.env` file:
+
+```
+PALABRA_API_KEY=<your_palabra_api_key>
+```
+
+
+
+## Usage
+
+
+
+### Speech-to-Text (STT)
+
+Use Palabra STT in an `AgentSession` or as a standalone streaming transcription service. The spoken language is auto-detected by default:
+
+```python
+from livekit.agents import AgentSession
+from livekit.plugins import palabra
+
+session = AgentSession(
+    stt=palabra.STT(),
+    # ... llm, tts, etc.
+)
+```
+
+
+
+### Live translation
+
+Palabra STT can translate speech on the fly. With `translate_languages` set, each emitted `SpeechData` maps as: `language`/`text` = the translation; `source_languages`/`source_texts` = the original speech. Final transcripts arrive already in the target language, so a translating agent works without an LLM in the loop:
+
+```python
+stt = palabra.STT(translate_languages=["es"])
+```
+
+
+
+### Text-to-Speech (TTS)
+
+Use Palabra TTS for real-time speech synthesis:
+
+```python
+from livekit.plugins import palabra
+
+session = AgentSession(
+    tts=palabra.TTS(
+        language="en",
+        voice_id="default_low",  # or "default_high", or any Palabra voice id
+        speed=0.5,  # 0.0-1.0; 0.5 is natural conversational pace
+    ),
+    # ... stt, llm, etc.
+)
+```
+
+The TTS streams over one persistent WebSocket session: text chunks coming from the LLM are tokenized into sentences and synthesized as they arrive, and an interruption cancels the in-flight synthesis server-side.
+
+## More information and reference
+
+- [Palabra realtime STT API](https://platform.palabra.ai/docs/speech-to-text/realtime-stt)
+- [Palabra realtime TTS API](https://platform.palabra.ai/docs/text-to-speech/realtime-tts)
+- [Palabra platform](https://platform.palabra.ai) — API keys and usage
+- [palabra-ai Python SDK](https://pypi.org/project/palabra-ai/) — the transport this plugin builds on
+

livekit_plugins_palabra-1.7.1/README.md

@@ -0,0 +1,80 @@
+# Palabra plugin for LiveKit Agents
+
+Support for Palabra realtime [Speech-to-Text](https://platform.palabra.ai/docs/speech-to-text/realtime-stt) and [Text-to-Speech](https://platform.palabra.ai/docs/text-to-speech/realtime-tts) APIs, using WebSocket streaming interfaces.
+
+See [STT documentation](https://docs.livekit.io/agents/models/stt/palabra/) and [TTS documentation](https://docs.livekit.io/agents/models/tts/palabra/) for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-palabra
+```
+
+## Pre-requisites
+
+The Palabra plugin requires an API key to authenticate. You can create one at [platform.palabra.ai/api-keys](https://platform.palabra.ai/api-keys).
+
+Set the API key in your `.env` file:
+
+```
+PALABRA_API_KEY=<your_palabra_api_key>
+```
+
+
+
+## Usage
+
+
+
+### Speech-to-Text (STT)
+
+Use Palabra STT in an `AgentSession` or as a standalone streaming transcription service. The spoken language is auto-detected by default:
+
+```python
+from livekit.agents import AgentSession
+from livekit.plugins import palabra
+
+session = AgentSession(
+    stt=palabra.STT(),
+    # ... llm, tts, etc.
+)
+```
+
+
+
+### Live translation
+
+Palabra STT can translate speech on the fly. With `translate_languages` set, each emitted `SpeechData` maps as: `language`/`text` = the translation; `source_languages`/`source_texts` = the original speech. Final transcripts arrive already in the target language, so a translating agent works without an LLM in the loop:
+
+```python
+stt = palabra.STT(translate_languages=["es"])
+```
+
+
+
+### Text-to-Speech (TTS)
+
+Use Palabra TTS for real-time speech synthesis:
+
+```python
+from livekit.plugins import palabra
+
+session = AgentSession(
+    tts=palabra.TTS(
+        language="en",
+        voice_id="default_low",  # or "default_high", or any Palabra voice id
+        speed=0.5,  # 0.0-1.0; 0.5 is natural conversational pace
+    ),
+    # ... stt, llm, etc.
+)
+```
+
+The TTS streams over one persistent WebSocket session: text chunks coming from the LLM are tokenized into sentences and synthesized as they arrive, and an interruption cancels the in-flight synthesis server-side.
+
+## More information and reference
+
+- [Palabra realtime STT API](https://platform.palabra.ai/docs/speech-to-text/realtime-stt)
+- [Palabra realtime TTS API](https://platform.palabra.ai/docs/text-to-speech/realtime-tts)
+- [Palabra platform](https://platform.palabra.ai) — API keys and usage
+- [palabra-ai Python SDK](https://pypi.org/project/palabra-ai/) — the transport this plugin builds on
+

livekit_plugins_palabra-1.7.1/livekit/plugins/palabra/__init__.py

@@ -0,0 +1,68 @@
+# 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.
+
+"""Palabra plugin for LiveKit Agents: realtime STT and TTS on the ``palabra-ai`` SDK.
+
+Importing this package registers the plugin via ``Plugin.register_plugin``.
+Docs: https://docs.livekit.io/agents/models/stt/ and .../tts/.
+"""
+
+from .models import (
+    DEFAULT_DEACCENT_STRENGTH,
+    DEFAULT_LANGUAGE,
+    DEFAULT_MODEL,
+    DEFAULT_SAMPLE_RATE,
+    DEFAULT_VOICE_ID,
+    TTSLanguages,
+    TTSModels,
+)
+from .stt import STT, SpeechStream
+from .tts import TTS, SynthesizeStream
+from .version import __version__
+
+__all__ = [
+    "STT",
+    "SpeechStream",
+    "TTS",
+    "SynthesizeStream",
+    "TTSModels",
+    "TTSLanguages",
+    "DEFAULT_LANGUAGE",
+    "DEFAULT_VOICE_ID",
+    "DEFAULT_MODEL",
+    "DEFAULT_DEACCENT_STRENGTH",
+    "DEFAULT_SAMPLE_RATE",
+    "__version__",
+]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class PalabraPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(PalabraPlugin())
+
+# Hide non-exported names from the generated pdoc output.
+_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_palabra-1.7.1/livekit/plugins/palabra/log.py

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

livekit_plugins_palabra-1.7.1/livekit/plugins/palabra/models.py

@@ -0,0 +1,27 @@
+# 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 typing import Literal
+
+TTSModels = Literal["auto"]
+"""Palabra synthesis model. ``"auto"`` lets the server choose the model."""
+
+TTSLanguages = Literal["en", "en-us", "en-gb", "de", "es", "fr", "it", "nl", "pt", "ru"]
+"""Languages documented for the realtime-TTS WebSocket endpoint."""
+
+DEFAULT_MODEL = "auto"
+DEFAULT_LANGUAGE = "en"
+DEFAULT_VOICE_ID = "default_low"
+DEFAULT_DEACCENT_STRENGTH = 1.0
+DEFAULT_SAMPLE_RATE = 24000