livekit-plugins-soniox 1.2.18__py3-none-any.whl

livekit/plugins/soniox/__init__.py

@@ -0,0 +1,52 @@
+# Copyright 2025 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.
+
+"""Soniox plugin for LiveKit Agents
+
+See https://docs.livekit.io/agents/integrations/stt/soniox/ for more information.
+"""
+
+from .stt import STT, ContextGeneralItem, ContextObject, ContextTranslationTerm, STTOptions
+from .version import __version__
+
+__all__ = [
+    "STT",
+    "STTOptions",
+    "ContextObject",
+    "ContextGeneralItem",
+    "ContextTranslationTerm",
+    "__version__",
+]
+
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class SonioxPlugin(Plugin):
+    def __init__(self):
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(SonioxPlugin())
+
+# 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/soniox/log.py

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

livekit/plugins/soniox/stt.py

@@ -0,0 +1,464 @@
+# Copyright 2025 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 __future__ import annotations
+
+import asyncio
+import json
+import os
+import time
+from dataclasses import asdict, dataclass
+
+import aiohttp
+
+from livekit import rtc
+from livekit.agents import (
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+    APITimeoutError,
+    stt,
+    utils,
+    vad,
+)
+from livekit.agents.stt import SpeechEventType
+from livekit.agents.types import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    NotGivenOr,
+)
+
+from .log import logger
+
+# Base URL for Soniox Speech-to-Text API.
+BASE_URL = "wss://stt-rt.soniox.com/transcribe-websocket"
+
+# WebSocket messages and tokens.
+KEEPALIVE_MESSAGE = '{"type": "keepalive"}'
+FINALIZE_MESSAGE = '{"type": "finalize"}'
+END_TOKEN = "<end>"
+FINALIZED_TOKEN = "<fin>"
+
+
+def is_end_token(token: dict) -> bool:
+    """Return True if the given token marks an end or finalized event."""
+    return token.get("text") in (END_TOKEN, FINALIZED_TOKEN)
+
+
+@dataclass
+class ContextGeneralItem:
+    key: str
+    value: str
+
+
+@dataclass
+class ContextTranslationTerm:
+    source: str
+    target: str
+
+
+@dataclass
+class ContextObject:
+    """Context object for models with context_version 2, for Soniox stt-rt-v3-preview and higher.
+
+    Learn more about context in the documentation:
+    https://soniox.com/docs/stt/concepts/context
+    """
+
+    general: list[ContextGeneralItem] | None = None
+    text: str | None = None
+    terms: list[str] | None = None
+    translation_terms: list[ContextTranslationTerm] | None = None
+
+
+@dataclass
+class STTOptions:
+    """Configuration options for Soniox Speech-to-Text service."""
+
+    model: str | None = "stt-rt-preview"
+
+    language_hints: list[str] | None = None
+    context: ContextObject | str | None = None
+
+    num_channels: int = 1
+    sample_rate: int = 16000
+
+    enable_speaker_diarization: bool = False
+    enable_language_identification: bool = True
+
+    client_reference_id: str | None = None
+
+
+class STT(stt.STT):
+    """Speech-to-Text service using Soniox Speech-to-Text API.
+
+    This service connects to Soniox Speech-to-Text API for real-time transcription
+    with support for multiple languages, custom context, speaker diarization,
+    and more.
+
+    For complete API documentation, see: https://soniox.com/docs/speech-to-text/api-reference/websocket-api
+    """
+
+    def __init__(
+        self,
+        *,
+        api_key: str | None = None,
+        base_url: str = BASE_URL,
+        http_session: aiohttp.ClientSession | None = None,
+        vad: vad.VAD | None = None,
+        params: STTOptions | None = None,
+    ):
+        """Initialize instance of Soniox Speech-to-Text API service.
+
+        Args:
+            api_key: Soniox API key, if not provided, will look for SONIOX_API_KEY env variable.
+            base_url: Base URL for Soniox Speech-to-Text API, default to BASE_URL defined in this
+                module.
+            http_session: Optional aiohttp.ClientSession to use for requests.
+            vad: If passed, enable Voice Activity Detection (VAD) for audio frames.
+            params: Additional configuration parameters, such as model, language hints, context and
+                speaker diarization.
+        """
+        super().__init__(capabilities=stt.STTCapabilities(streaming=True, interim_results=True))
+
+        self._api_key = api_key or os.getenv("SONIOX_API_KEY")
+        self._base_url = base_url
+        self._http_session = http_session
+        self._vad_stream = vad.stream() if vad else None
+        self._params = params or STTOptions()
+
+    @property
+    def model(self) -> str:
+        return "unknown"
+
+    @property
+    def provider(self) -> str:
+        return "Soniox"
+
+    async def _recognize_impl(
+        self,
+        buffer: utils.AudioBuffer,
+        *,
+        language: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions,
+    ) -> stt.SpeechEvent:
+        """Raise error since single-frame recognition is not supported
+        by Soniox Speech-to-Text API."""
+        raise NotImplementedError(
+            "Soniox Speech-to-Text API does not support single frame recognition"
+        )
+
+    def stream(
+        self,
+        *,
+        language: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> SpeechStream:
+        """Return a new LiveKit streaming speech-to-text session."""
+        return SpeechStream(
+            stt=self,
+            conn_options=conn_options,
+        )
+
+
+class SpeechStream(stt.SpeechStream):
+    def __init__(
+        self,
+        stt: STT,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> None:
+        """Set up state and queues for a WebSocket-based transcription stream."""
+        super().__init__(stt=stt, conn_options=conn_options, sample_rate=stt._params.sample_rate)
+        self._stt = stt
+        self._ws: aiohttp.ClientWebSocketResponse | None = None
+        self._reconnect_event = asyncio.Event()
+
+        self.audio_queue = asyncio.Queue()
+
+        self._last_tokens_received: float | None = None
+
+    def _ensure_session(self) -> aiohttp.ClientSession:
+        """Get or create an aiohttp ClientSession for WebSocket connections."""
+        if not self._stt._http_session:
+            self._stt._http_session = utils.http_context.http_session()
+
+        return self._stt._http_session
+
+    async def _connect_ws(self):
+        """Open a WebSocket connection to the Soniox Speech-to-Text API and send the
+        initial configuration."""
+        # If VAD was passed, disable endpoint detection, otherwise enable it.
+        enable_endpoint_detection = not self._stt._vad_stream
+
+        context = self._stt._params.context
+        if isinstance(context, ContextObject):
+            context = asdict(context)
+
+        # Create initial config object.
+        config = {
+            "api_key": self._stt._api_key,
+            "model": self._stt._params.model,
+            "audio_format": "pcm_s16le",
+            "num_channels": self._stt._params.num_channels or 1,
+            "enable_endpoint_detection": enable_endpoint_detection,
+            "sample_rate": self._stt._params.sample_rate,
+            "language_hints": self._stt._params.language_hints,
+            "context": context,
+            "enable_speaker_diarization": self._stt._params.enable_speaker_diarization,
+            "enable_language_identification": self._stt._params.enable_language_identification,
+            "client_reference_id": self._stt._params.client_reference_id,
+        }
+        # Connect to the Soniox Speech-to-Text API.
+        ws = await asyncio.wait_for(
+            self._ensure_session().ws_connect(self._stt._base_url),
+            timeout=self._conn_options.timeout,
+        )
+        # Set initial configuration message.
+        await ws.send_str(json.dumps(config))
+        logger.debug("Soniox Speech-to-Text API connection established!")
+        return ws
+
+    async def _run(self) -> None:
+        """Manage connection lifecycle, spawning tasks and handling reconnection."""
+        while True:
+            try:
+                ws = await self._connect_ws()
+                self._ws = ws
+                # Create task for audio processing, voice turn detection and message handling.
+                tasks = [
+                    asyncio.create_task(self._prepare_audio_task()),
+                    asyncio.create_task(self._handle_vad_task()),
+                    asyncio.create_task(self._send_audio_task()),
+                    asyncio.create_task(self._recv_messages_task()),
+                    asyncio.create_task(self._keepalive_task()),
+                ]
+                wait_reconnect_task = asyncio.create_task(self._reconnect_event.wait())
+                try:
+                    done, _ = await asyncio.wait(
+                        [asyncio.gather(*tasks), wait_reconnect_task],
+                        return_when=asyncio.FIRST_COMPLETED,
+                    )
+
+                    for task in done:
+                        if task != wait_reconnect_task:
+                            task.result()
+
+                    if wait_reconnect_task not in done:
+                        break
+
+                    self._reconnect_event.clear()
+                finally:
+                    await utils.aio.gracefully_cancel(*tasks, wait_reconnect_task)
+            # Handle errors.
+            except asyncio.TimeoutError as e:
+                logger.error(
+                    f"Timeout during Soniox Speech-to-Text API connection/initialization: {e}"
+                )
+                raise APITimeoutError(
+                    "Timeout connecting to or initializing Soniox Speech-to-Text API session"
+                ) from e
+
+            except aiohttp.ClientResponseError as e:
+                logger.error(
+                    "Soniox Speech-to-Text API status error during session init:"
+                    + f"{e.status} {e.message}"
+                )
+                raise APIStatusError(
+                    message=e.message, status_code=e.status, request_id=None, body=None
+                ) from e
+
+            except aiohttp.ClientError as e:
+                logger.error(f"Soniox Speech-to-Text API connection error: {e}")
+                raise APIConnectionError(f"Soniox Speech-to-Text API connection error: {e}") from e
+
+            except Exception as e:
+                logger.exception(f"Unexpected error occurred: {e}")
+                raise APIConnectionError(f"An unexpected error occurred: {e}") from e
+            # Close the WebSocket connection on finish.
+            finally:
+                if self._ws is not None:
+                    await self._ws.close()
+                    self._ws = None
+
+    async def _keepalive_task(self):
+        """Periodically send keepalive messages (while no audio is being sent)
+        to maintain the WebSocket connection."""
+        try:
+            while self._ws:
+                await self._ws.send_str(KEEPALIVE_MESSAGE)
+                await asyncio.sleep(5)
+        except Exception as e:
+            logger.error(f"Error while sending keep alive message: {e}")
+
+    async def _prepare_audio_task(self):
+        """Read audio frames, process VAD, and enqueue PCM data for sending."""
+        if not self._ws:
+            logger.error("WebSocket connection to Soniox Speech-to-Text API is not established")
+            return
+
+        async for data in self._input_ch:
+            if self._stt._vad_stream:
+                # If VAD is enabled, push the audio frame to the VAD stream.
+                if isinstance(data, self._FlushSentinel):
+                    self._stt._vad_stream.flush()
+                else:
+                    self._stt._vad_stream.push_frame(data)
+
+            if isinstance(data, rtc.AudioFrame):
+                # Get the raw bytes from the audio frame.
+                pcm_data = data.data.tobytes()
+                self.audio_queue.put_nowait(pcm_data)
+
+    async def _send_audio_task(self):
+        """Take queued audio data and transmit it over the WebSocket."""
+        if not self._ws:
+            logger.error("WebSocket connection to Soniox Speech-to-Text API is not established")
+            return
+
+        while self._ws:
+            try:
+                data = await self.audio_queue.get()
+
+                if isinstance(data, bytes):
+                    await self._ws.send_bytes(data)
+                else:
+                    await self._ws.send_str(data)
+            except asyncio.CancelledError:
+                break
+            except Exception as e:
+                logger.error(f"Error while sending audio data: {e}")
+                break
+
+    async def _handle_vad_task(self):
+        """Listen for VAD events to trigger finalize or keepalive messages."""
+        if not self._stt._vad_stream:
+            logger.debug("VAD stream is not enabled, skipping VAD task")
+            return
+
+        async for event in self._stt._vad_stream:
+            if event.type == vad.VADEventType.END_OF_SPEECH:
+                self.audio_queue.put_nowait(FINALIZE_MESSAGE)
+
+    async def _recv_messages_task(self):
+        """Receive transcription messages, handle tokens, errors, and dispatch events."""
+
+        # Transcription frame will be only sent after we get the "endpoint" event.
+        final_transcript_buffer = ""
+        # Language code sent by Soniox if language detection is enabled (e.g. "en", "de", "fr")
+        final_transcript_language: str = ""
+
+        def send_endpoint_transcript():
+            nonlocal final_transcript_buffer, final_transcript_language
+            if final_transcript_buffer:
+                event = stt.SpeechEvent(
+                    type=SpeechEventType.FINAL_TRANSCRIPT,
+                    alternatives=[
+                        stt.SpeechData(
+                            text=final_transcript_buffer, language=final_transcript_language
+                        )
+                    ],
+                )
+                self._event_ch.send_nowait(event)
+                final_transcript_buffer = ""
+                final_transcript_language = ""
+
+        # Method handles receiving messages from the Soniox Speech-to-Text API.
+        while self._ws:
+            try:
+                async for msg in self._ws:
+                    if msg.type == aiohttp.WSMsgType.TEXT:
+                        try:
+                            content = json.loads(msg.data)
+                            tokens = content["tokens"]
+
+                            if tokens:
+                                if len(tokens) == 1 and tokens[0]["text"] == FINALIZED_TOKEN:
+                                    # Ignore finalized token, prevent auto finalize cycle.
+                                    pass
+                                else:
+                                    # Got at least one token, reset the auto finalize delay.
+                                    self._last_tokens_received = time.time()
+
+                            # We will only send the final tokens after we get the "endpoint" event.
+                            non_final_transcription = ""
+                            non_final_transcription_language: str = ""
+
+                            for token in tokens:
+                                if token["is_final"]:
+                                    if is_end_token(token):
+                                        # Found an endpoint, tokens until here will be sent as
+                                        # transcript, the rest will be sent as interim tokens
+                                        # (even final tokens).
+                                        send_endpoint_transcript()
+                                    else:
+                                        final_transcript_buffer += token["text"]
+
+                                        # Soniox provides language for each token,
+                                        # LiveKit requires only a single language for the entire transcription chunk.
+                                        # Current heuristic is to take the first language we see.
+                                        if token.get("language") and not final_transcript_language:
+                                            final_transcript_language = token.get("language")
+                                else:
+                                    non_final_transcription += token["text"]
+                                    if (
+                                        token.get("language")
+                                        and not non_final_transcription_language
+                                    ):
+                                        non_final_transcription_language = token.get("language")
+
+                            if final_transcript_buffer or non_final_transcription:
+                                event = stt.SpeechEvent(
+                                    type=SpeechEventType.INTERIM_TRANSCRIPT,
+                                    alternatives=[
+                                        stt.SpeechData(
+                                            text=final_transcript_buffer + non_final_transcription,
+                                            language=final_transcript_language
+                                            if final_transcript_language
+                                            else non_final_transcription_language,
+                                        )
+                                    ],
+                                )
+                                self._event_ch.send_nowait(event)
+
+                            error_code = content.get("error_code")
+                            error_message = content.get("error_message")
+
+                            if error_code or error_message:
+                                # In case of error, still send the final transcript.
+                                send_endpoint_transcript()
+                                logger.error(f"WebSocket error: {error_code} - {error_message}")
+
+                            finished = content.get("finished")
+
+                            if finished:
+                                # When finished, still send the final transcript.
+                                send_endpoint_transcript()
+                                logger.debug("Transcription finished")
+
+                        except Exception as e:
+                            logger.exception(f"Error processing message: {e}")
+                    elif msg.type in (
+                        aiohttp.WSMsgType.CLOSED,
+                        aiohttp.WSMsgType.CLOSE,
+                        aiohttp.WSMsgType.CLOSING,
+                    ):
+                        break
+                    else:
+                        logger.warning(
+                            f"Unexpected message type from Soniox Speech-to-Text API: {msg.type}"
+                        )
+            except aiohttp.ClientError as e:
+                logger.error(f"WebSocket error while receiving: {e}")
+            except Exception as e:
+                logger.error(f"Unexpected error while receiving messages: {e}")

livekit/plugins/soniox/version.py

@@ -0,0 +1,15 @@
+# Copyright 2025 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.2.18"

livekit_plugins_soniox-1.2.18.dist-info/METADATA

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-soniox
+Version: 1.2.18
+Summary: Agent Framework plugin for services using Soniox's API.
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://livekit.io/
+Project-URL: Source, https://github.com/livekit/agents
+Author-email: Soniox <support@soniox.com>
+License-Expression: Apache-2.0
+Keywords: audio,livekit,realtime,soniox,speech-to-text,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 :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9.0
+Requires-Dist: livekit-agents>=1.2.18
+Description-Content-Type: text/markdown
+
+# Soniox plugin for LiveKit Agents
+
+Support for Soniox Speech-to-Text [Soniox](https://soniox.com/) API, using WebSocket streaming interface.
+
+See https://docs.livekit.io/agents/integrations/stt/soniox/ for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-soniox
+```
+
+## Pre-requisites
+
+The Soniox plugin requires an API key to authenticate. You can get your Soniox API key [here](https://console.soniox.com/).
+
+Set API key in your `.env` file:
+
+```
+SONIOX_API_KEY=<your_soniox_api_key>
+```
+
+## Usage
+
+Use Soniox in an `AgentSession` or as a standalone transcription service:
+
+```python
+from livekit.plugins import soniox
+
+session = AgentSession(
+    stt = soniox.STT(),
+    # ... llm, tts, etc.
+)
+```
+
+Congratulations! You are now ready to use Soniox Speech-to-Text API in your LiveKit agents.
+
+You can test Soniox Speech-to-Text API in the LiveKit's [Voice AI quickstart](https://docs.livekit.io/agents/start/voice-ai/).
+
+## More information and reference
+
+Explore integration details and find comprehensive examples in our [Soniox LiveKit integration guide](https://speechdev.soniox.com/docs/speech-to-text/integrations/livekit).

livekit_plugins_soniox-1.2.18.dist-info/RECORD

@@ -0,0 +1,8 @@
+livekit/plugins/soniox/__init__.py,sha256=xCvIeDKtCnq40LelQq4HiB4OG_dpEs_YHsSqFe6qLh0,1361
+livekit/plugins/soniox/log.py,sha256=GNs8rdX3HEj24K-AeVEglYPEXkXTYh0aV_cL0JqVI2c,69
+livekit/plugins/soniox/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+livekit/plugins/soniox/stt.py,sha256=Emv5Bvuh9c93fQREaASm_nI5VIJmLirTtZYUdqW24n0,18626
+livekit/plugins/soniox/version.py,sha256=QCgsrMAquHr76rIlEOJzzTyGVI058k0RBDT47ZF8JIA,601
+livekit_plugins_soniox-1.2.18.dist-info/METADATA,sha256=htmW7yV8bruRCnAKP1TvxexumQDKMqDYQS8s8LGM8dU,2106
+livekit_plugins_soniox-1.2.18.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+livekit_plugins_soniox-1.2.18.dist-info/RECORD,,

livekit_plugins_soniox-1.2.18.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any