Add livekit-plugins-avaz for dashboard WebSocket TTS

examples/voice_agents/avaz_agent.py

@@ -0,0 +1,79 @@
+import logging
+import os
+
+from dotenv import load_dotenv
+
+from livekit.agents import (
+    Agent,
+    AgentServer,
+    AgentSession,
+    JobContext,
+    JobProcess,
+    MetricsCollectedEvent,
+    cli,
+    inference,
+    metrics,
+    room_io,
+)
+from livekit.plugins import avaz, silero
+from livekit.plugins.turn_detector.multilingual import MultilingualModel
+
+logger = logging.getLogger("avaz-agent")
+
+load_dotenv()
+
+
+class AvazAssistant(Agent):
+    def __init__(self) -> None:
+        super().__init__(
+            instructions=(
+                "You are a helpful voice assistant powered by Avaz TTS. "
+                "Keep responses concise and conversational."
+            ),
+        )
+
+    async def on_enter(self) -> None:
+        self.session.generate_reply(
+            instructions="Greet the user briefly and mention that you are using Avaz TTS."
+        )
+
+
+server = AgentServer()
+
+
+def prewarm(proc: JobProcess) -> None:
+    proc.userdata["vad"] = silero.VAD.load()
+
+
+server.setup_fnc = prewarm
+
+
+@server.rtc_session()
+async def entrypoint(ctx: JobContext) -> None:
+    ctx.log_context_fields = {"room": ctx.room.name}
+
+    session = AgentSession(
+        stt=inference.STT("deepgram/nova-3", language="multi"),
+        llm=inference.LLM("openai/gpt-4.1-mini"),
+        tts=avaz.TTS(
+            api_key=os.environ["AVAZ_API_KEY"],
+            base_url=os.environ["AVAZ_BASE_URL"],
+            model_id=os.environ["AVAZ_AGENT_MODEL_ID"],
+        ),
+        vad=ctx.proc.userdata["vad"],
+        turn_detection=MultilingualModel(),
+    )
+
+    @session.on("metrics_collected")
+    def _on_metrics_collected(ev: MetricsCollectedEvent) -> None:
+        metrics.log_metrics(ev.metrics)
+
+    await session.start(
+        agent=AvazAssistant(),
+        room=ctx.room,
+        room_options=room_io.RoomOptions(),
+    )
+
+
+if __name__ == "__main__":
+    cli.run_app(server)

livekit-agents/pyproject.toml

@@ -68,6 +68,7 @@ anam = ["livekit-plugins-anam>=1.6.1"]
 anthropic = ["livekit-plugins-anthropic>=1.6.1"]
 assemblyai = ["livekit-plugins-assemblyai>=1.6.1"]
 asyncai = ["livekit-plugins-asyncai>=1.6.1"]
+avaz = ["livekit-plugins-avaz>=1.6.1"]
 avatario = ["livekit-plugins-avatario>=1.6.1"]
 avatartalk = ["livekit-plugins-avatartalk>=1.6.1"]
 aws = ["livekit-plugins-aws>=1.6.1"]

livekit-plugins/livekit-plugins-avaz/README.md

@@ -0,0 +1,41 @@
+# LiveKit Avaz TTS Plugin
+
+LiveKit Agents plugin for [Avaz](https://github.com/Mank-Technology) text-to-speech over the dashboard WebSocket `stream-input` protocol.
+
+## Installation
+
+```bash
+pip install "livekit-agents[avaz]~=1.6"
+```
+
+## Usage
+
+```python
+import os
+from livekit.plugins import avaz
+
+tts = avaz.TTS(
+    api_key=os.environ["AVAZ_API_KEY"],
+    base_url=os.environ["AVAZ_BASE_URL"],
+    model_id=os.environ["AVAZ_AGENT_MODEL_ID"],
+)
+```
+
+## Environment variables
+
+| Variable | Required | Description |
+|---|---|---|
+| `AVAZ_API_KEY` | yes (dashboard) | Dashboard API token (`X-API-Key` / Bearer) |
+| `AVAZ_BASE_URL` | yes (dashboard) | Dashboard API base URL (e.g. `https://your-dashboard.example.com/api`) |
+| `AVAZ_AGENT_MODEL_ID` | yes (dashboard) | Agent model UUID from your dashboard TTS catalog |
+| `AVAZ_STREAM_MODEL` | no | Upstream WebSocket model string (`avaz1`, `avaz2`, `avaz3`); default `avaz3` |
+| `TTS_WS_URI` | no | Direct WebSocket override for local TTS-Service (no auth) |
+
+## Protocol
+
+1. Connect to `{base_url}` → `wss://.../api/tts/stream-input`
+2. Send `model_settings` + `voice_settings` (WebSocket `model_id` is the upstream string)
+3. Stream `{"text": "..."}` chunks; receive base64 WAV in `{"audio": ...}`
+4. Send `{"flush": true}` to finish the turn
+
+HTTP synthesize (`POST /tts/synthesize`) uses the UUID `model_id` from the constructor; WebSocket init uses the upstream string (`stream_model`).

livekit-plugins/livekit-plugins-avaz/livekit/plugins/avaz/__init__.py

@@ -0,0 +1,40 @@
+# 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.
+
+"""Avaz TTS plugin for LiveKit Agents."""
+
+from .tts import SynthesizeStream, TTS, build_auth_headers
+from .version import __version__
+
+__all__ = ["TTS", "SynthesizeStream", "build_auth_headers", "__version__"]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class AvazPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(AvazPlugin())
+
+_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/livekit-plugins-avaz/livekit/plugins/avaz/log.py

@@ -0,0 +1,17 @@
+# 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.
+
+import logging
+
+logger = logging.getLogger("livekit.plugins.avaz")

livekit-plugins/livekit-plugins-avaz/livekit/plugins/avaz/models.py

@@ -0,0 +1,26 @@
+# 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.
+
+DEFAULT_SAMPLE_RATE = 48_000
+DEFAULT_FRAME_MS = 20
+DEFAULT_STREAM_MODEL = "avaz3"
+DEFAULT_SPEAKER_ID = 0
+DEFAULT_CFG_VALUE = 2.0
+DEFAULT_INFERENCE_TIMESTEPS = 10
+DEFAULT_CHUNK_NOTATION = "."
+DEFAULT_CONNECT_TIMEOUT_S = 10.0
+DEFAULT_TURN_TIMEOUT_S = 120.0
+DEFAULT_POST_TEXT_DRAIN_S = 0.15
+DEFAULT_RECV_IDLE_TIMEOUT_S = 0.5
+DEFAULT_FLUSH_RECV_TIMEOUT_S = 2.0