livekit-plugins-ultravox 1.2.9__tar.gz

livekit_plugins_ultravox-1.2.9/.gitignore

@@ -0,0 +1,175 @@
+**/.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

livekit_plugins_ultravox-1.2.9/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-ultravox
+Version: 1.2.9
+Summary: Agent Framework plugin for services from Ultravox
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://livekit.io/
+Project-URL: Source, https://github.com/livekit/agents
+Author-email: LiveKit <hello@livekit.io>
+License-Expression: Apache-2.0
+Keywords: audio,livekit,realtime,video,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: livekit-agents[codecs]>=1.2.9
+Description-Content-Type: text/markdown
+
+# LiveKit Ultravox Plugin
+
+LiveKit plugin for Ultravox's real-time speech-to-speech AI models, providing seamless integration with the LiveKit Agents framework.
+
+
+
+## Installation
+
+```bash
+pip install livekit-plugins-ultravox
+```
+
+## Prerequisites
+
+You'll need an API key from Ultravox. Set it as an environment variable:
+
+```bash
+export ULTRAVOX_API_KEY="your_api_key_here"
+```
+
+Optional: enable debug logs for the plugin (disabled by default):
+
+```bash
+export LK_ULTRAVOX_DEBUG=true
+```
+
+## Basic Usage
+
+### Simple Voice Assistant
+
+```python
+import asyncio
+from livekit.agents import Agent, AgentSession, JobContext, JobProcess, WorkerOptions, cli
+from livekit.plugins import silero
+from livekit.plugins.ultravox.realtime import RealtimeModel
+
+async def entrypoint(ctx: JobContext):
+    await ctx.connect()
+    
+    session: AgentSession[None] = AgentSession(
+        allow_interruptions=True,
+        vad=ctx.proc.userdata["vad"],
+        llm=RealtimeModel(
+            model_id="fixie-ai/ultravox",
+            voice="Mark",
+        ),
+    )
+    
+    await session.start(
+        agent=Agent(
+            instructions="You are a helpful voice assistant.",
+        ),
+        room=ctx.room,
+    )
+
+def prewarm(proc: JobProcess) -> None:
+    proc.userdata["vad"] = silero.VAD.load()
+
+if __name__ == "__main__":
+    cli.run_app(WorkerOptions(entrypoint_fnc=entrypoint, prewarm_fnc=prewarm))
+```
+
+### Voice Assistant with Tools
+
+```python
+from livekit.agents import function_tool, Agent, AgentSession, JobContext, JobProcess, WorkerOptions, cli
+from livekit.plugins import silero
+from livekit.plugins.ultravox.realtime import RealtimeModel
+
+@function_tool
+async def get_weather(location: str) -> str:
+    """Get weather information for a location."""
+    return f"The weather in {location} is sunny and 72°F"
+
+@function_tool
+async def book_appointment(date: str, time: str) -> str:
+    """Book an appointment."""
+    return f"Appointment booked for {date} at {time}"
+
+async def entrypoint(ctx: JobContext):
+    await ctx.connect()
+    
+    session: AgentSession[None] = AgentSession(
+        allow_interruptions=True,
+        vad=ctx.proc.userdata["vad"],
+        llm=RealtimeModel(model_id="fixie-ai/ultravox"),
+    )
+    
+    await session.start(
+        agent=Agent(
+            instructions="You are a helpful assistant with access to weather and scheduling tools.",
+            tools=[get_weather, book_appointment],
+        ),
+        room=ctx.room,
+    )
+
+def prewarm(proc: JobProcess) -> None:
+    proc.userdata["vad"] = silero.VAD.load()
+
+if __name__ == "__main__":
+    cli.run_app(WorkerOptions(entrypoint_fnc=entrypoint, prewarm_fnc=prewarm))
+```
+
+
+## Configuration Options
+
+### Ultravox API (/api/calls) Parameters
+
+```python
+RealtimeModel(
+    model_id="fixie-ai/ultravox",         # Model to use (warn + pass-through if unknown)
+    voice="Mark",                         # Voice to use (warn + pass-through if unknown)
+    api_key=None,                          # API key (defaults to env var)
+    base_url=None,                         # API base URL (defaults to Ultravox API)
+    system_prompt="You are helpful.",      # System prompt
+    input_sample_rate=16000,               # Input audio sample rate
+    output_sample_rate=24000,              # Output audio sample rate
+    client_buffer_size_ms=60,              # Audio buffer size (min 200ms used on WS)
+    http_session=None,                     # Custom HTTP session
+)
+
+Notes:
+- Unknown models/voices: the plugin logs a warning and sends them as-is; the server validates.
+- Metrics: the plugin emits a single `metrics_collected` event per generation. To log them,
+  add a listener in your app and call the helper:
+
+```python
+from livekit.agents import metrics
+
+@session.on("metrics_collected")
+def on_metrics_collected(ev):
+    metrics.log_metrics(ev.metrics)
+```
+```
+
+
+

livekit_plugins_ultravox-1.2.9/README.md

@@ -0,0 +1,137 @@
+# LiveKit Ultravox Plugin
+
+LiveKit plugin for Ultravox's real-time speech-to-speech AI models, providing seamless integration with the LiveKit Agents framework.
+
+
+
+## Installation
+
+```bash
+pip install livekit-plugins-ultravox
+```
+
+## Prerequisites
+
+You'll need an API key from Ultravox. Set it as an environment variable:
+
+```bash
+export ULTRAVOX_API_KEY="your_api_key_here"
+```
+
+Optional: enable debug logs for the plugin (disabled by default):
+
+```bash
+export LK_ULTRAVOX_DEBUG=true
+```
+
+## Basic Usage
+
+### Simple Voice Assistant
+
+```python
+import asyncio
+from livekit.agents import Agent, AgentSession, JobContext, JobProcess, WorkerOptions, cli
+from livekit.plugins import silero
+from livekit.plugins.ultravox.realtime import RealtimeModel
+
+async def entrypoint(ctx: JobContext):
+    await ctx.connect()
+    
+    session: AgentSession[None] = AgentSession(
+        allow_interruptions=True,
+        vad=ctx.proc.userdata["vad"],
+        llm=RealtimeModel(
+            model_id="fixie-ai/ultravox",
+            voice="Mark",
+        ),
+    )
+    
+    await session.start(
+        agent=Agent(
+            instructions="You are a helpful voice assistant.",
+        ),
+        room=ctx.room,
+    )
+
+def prewarm(proc: JobProcess) -> None:
+    proc.userdata["vad"] = silero.VAD.load()
+
+if __name__ == "__main__":
+    cli.run_app(WorkerOptions(entrypoint_fnc=entrypoint, prewarm_fnc=prewarm))
+```
+
+### Voice Assistant with Tools
+
+```python
+from livekit.agents import function_tool, Agent, AgentSession, JobContext, JobProcess, WorkerOptions, cli
+from livekit.plugins import silero
+from livekit.plugins.ultravox.realtime import RealtimeModel
+
+@function_tool
+async def get_weather(location: str) -> str:
+    """Get weather information for a location."""
+    return f"The weather in {location} is sunny and 72°F"
+
+@function_tool
+async def book_appointment(date: str, time: str) -> str:
+    """Book an appointment."""
+    return f"Appointment booked for {date} at {time}"
+
+async def entrypoint(ctx: JobContext):
+    await ctx.connect()
+    
+    session: AgentSession[None] = AgentSession(
+        allow_interruptions=True,
+        vad=ctx.proc.userdata["vad"],
+        llm=RealtimeModel(model_id="fixie-ai/ultravox"),
+    )
+    
+    await session.start(
+        agent=Agent(
+            instructions="You are a helpful assistant with access to weather and scheduling tools.",
+            tools=[get_weather, book_appointment],
+        ),
+        room=ctx.room,
+    )
+
+def prewarm(proc: JobProcess) -> None:
+    proc.userdata["vad"] = silero.VAD.load()
+
+if __name__ == "__main__":
+    cli.run_app(WorkerOptions(entrypoint_fnc=entrypoint, prewarm_fnc=prewarm))
+```
+
+
+## Configuration Options
+
+### Ultravox API (/api/calls) Parameters
+
+```python
+RealtimeModel(
+    model_id="fixie-ai/ultravox",         # Model to use (warn + pass-through if unknown)
+    voice="Mark",                         # Voice to use (warn + pass-through if unknown)
+    api_key=None,                          # API key (defaults to env var)
+    base_url=None,                         # API base URL (defaults to Ultravox API)
+    system_prompt="You are helpful.",      # System prompt
+    input_sample_rate=16000,               # Input audio sample rate
+    output_sample_rate=24000,              # Output audio sample rate
+    client_buffer_size_ms=60,              # Audio buffer size (min 200ms used on WS)
+    http_session=None,                     # Custom HTTP session
+)
+
+Notes:
+- Unknown models/voices: the plugin logs a warning and sends them as-is; the server validates.
+- Metrics: the plugin emits a single `metrics_collected` event per generation. To log them,
+  add a listener in your app and call the helper:
+
+```python
+from livekit.agents import metrics
+
+@session.on("metrics_collected")
+def on_metrics_collected(ev):
+    metrics.log_metrics(ev.metrics)
+```
+```
+
+
+

livekit_plugins_ultravox-1.2.9/livekit/plugins/ultravox/__init__.py

@@ -0,0 +1,56 @@
+# This file makes the 'ultravox' directory a Python package.
+# 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.
+
+"""Ultravox plugin for LiveKit Agents
+
+Support for Ultravox Realtime API
+
+"""
+
+from . import realtime, utils
+from .models import UltravoxModel, UltravoxVoice
+from .realtime.realtime_model import RealtimeModel, RealtimeSession
+from .version import __version__
+
+__all__ = [
+    "UltravoxVoice",
+    "UltravoxModel",
+    "realtime",
+    "RealtimeModel",
+    "RealtimeSession",
+    "utils",
+    "__version__",
+]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class UltravoxPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(UltravoxPlugin())
+
+# 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_ultravox-1.2.9/livekit/plugins/ultravox/log.py

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

livekit_plugins_ultravox-1.2.9/livekit/plugins/ultravox/models.py

@@ -0,0 +1,12 @@
+from typing import Literal
+
+UltravoxModel = Literal[
+    "fixie-ai/ultravox",
+    "fixie-ai/ultravox-gemma3-27b-preview",
+    "fixie-ai/ultravox-llama3.3-70b",
+    "fixie-ai/ultravox-qwen3-32b-preview",
+]
+UltravoxVoice = Literal[
+    "Mark",
+    "Jessica",
+]

livekit_plugins_ultravox-1.2.9/livekit/plugins/ultravox/realtime/__init__.py

@@ -0,0 +1,24 @@
+from .events import (
+    ClientToolInvocationEvent,
+    ClientToolResultEvent,
+    DebugEvent,
+    PingEvent,
+    PlaybackClearBufferEvent,
+    PongEvent,
+    SetOutputMediumEvent,
+    UserTextMessageEvent,
+)
+from .realtime_model import RealtimeModel, RealtimeSession
+
+__all__ = [
+    "RealtimeModel",
+    "RealtimeSession",
+    "ClientToolInvocationEvent",
+    "ClientToolResultEvent",
+    "DebugEvent",
+    "UserTextMessageEvent",
+    "PingEvent",
+    "PlaybackClearBufferEvent",
+    "PongEvent",
+    "SetOutputMediumEvent",
+]