livekit-plugins-nabrah 1.8.6__tar.gz

livekit_plugins_nabrah-1.8.6/.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_nabrah-1.8.6/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.5
+Name: livekit-plugins-nabrah
+Version: 1.8.6
+Summary: LiveKit Agents plugin for Nabrah Arabic speech-to-text
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://nabrah.ai
+Project-URL: Source, https://github.com/livekit/agents
+Author-email: LiveKit <hello@livekit.io>
+License-Expression: Apache-2.0
+Keywords: arabic,audio,livekit,livekit-agents,nabrah,realtime,speech-to-text,streaming,stt,webrtc,websocket
+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
+Requires-Dist: aiohttp
+Requires-Dist: livekit-agents>=1.8.6
+Description-Content-Type: text/markdown
+
+# Nabrah plugin for LiveKit Agents
+
+Support for [Nabrah](https://nabrah.ai/) Speech-to-Text in LiveKit Agents, with
+client-side end-of-turn detection tuned for Arabic conversation.
+
+## Installation
+
+```bash
+pip install livekit-plugins-nabrah
+```
+
+## Pre-requisites
+
+You'll need an API key from Nabrah. It can be set as an environment variable:
+`NABRAH_API_KEY`.
+
+## Usage
+
+Use Nabrah STT in an `AgentSession`:
+
+```python
+from livekit.agents import AgentSession
+from livekit.plugins import nabrah
+
+session = AgentSession(
+    stt=nabrah.STT(
+        recognition_model="eot_nabrah",
+        language="ar-SA",
+        end_of_turn_confirm_delay_seconds=0.4,
+    ),
+)
+```
+
+### Turn detection
+
+`recognition_model="eot_nabrah"` emits the end-of-turn signal the plugin uses to
+close a turn. `end_of_turn_confirm_delay_seconds` is how long it waits after that
+signal before committing. Speaking again inside the window keeps the turn open.
+`max_transcript_inactivity_seconds` optionally commits after that many seconds
+without new transcript text. It is disabled by default because it measures
+recognizer inactivity, not acoustic silence, and a provider delay could otherwise
+split continuous speech.
+
+Nabrah's unnamed model (`recognition_model=""`) is more accurate but emits no
+end-of-turn signal. When using it, configure another turn detector or explicitly
+set `max_transcript_inactivity_seconds` as a fallback heuristic.
+
+### Word boosting
+
+Bias recognition toward terms the model gets wrong:
+
+```python
+stt = nabrah.STT(
+    priority_words=["مستشفى الملك فيصل التخصصي", "رقم الهوية الوطنية"],
+    priority_words_strength=0.5,
+)
+```
+
+`0.5` is the recommended strength. Higher values make boosted terms appear in
+places they were not said, so keep the list to terms your callers actually say
+and add one only after hearing it come out wrong. Multi-word phrases are boosted
+as a unit.
+
+#### Loading terms from a file
+
+For anything beyond a handful of terms, keep them in a JSON file so they can be
+edited without touching code. Create `boosting.json` next to your agent:
+
+```json
+{
+  "boost_threshold": 0.5,
+  "words": [
+    "مستشفى الملك فيصل التخصصي",
+    "رقم الهوية الوطنية"
+  ]
+}
+```
+
+Load it at startup and pass it to the plugin:
+
+```python
+import json
+import pathlib
+
+from livekit.agents import AgentSession
+from livekit.plugins import nabrah
+
+boosting = json.loads(
+    pathlib.Path(__file__).with_name("boosting.json").read_text(encoding="utf-8")
+)
+
+session = AgentSession(
+    stt=nabrah.STT(
+        recognition_model="eot_nabrah",
+        language="ar-SA",
+        end_of_turn_confirm_delay_seconds=0.4,
+        priority_words=boosting["words"],
+        priority_words_strength=boosting["boost_threshold"],
+    ),
+)
+```
+
+Read the file with `encoding="utf-8"`. Without it, Arabic terms fail to load on
+platforms that default to a different encoding.
+
+## Full example
+
+A complete agent using Nabrah STT with word boosting loaded from a file:
+
+```python
+import json
+import pathlib
+
+from dotenv import load_dotenv
+from livekit import agents
+from livekit.agents import (
+    Agent,
+    AgentServer,
+    AgentSession,
+    JobContext,
+    TurnHandlingOptions,
+    inference,
+)
+from livekit.plugins import nabrah
+
+load_dotenv()
+
+boosting = json.loads(
+    pathlib.Path(__file__).with_name("boosting.json").read_text(encoding="utf-8")
+)
+
+server = AgentServer()
+
+
+class Assistant(Agent):
+    def __init__(self) -> None:
+        super().__init__(instructions="You are a helpful voice assistant.")
+
+
+@server.rtc_session()
+async def entrypoint(ctx: JobContext) -> None:
+    session = AgentSession(
+        stt=nabrah.STT(
+            recognition_model="eot_nabrah",
+            language="ar-SA",
+            end_of_turn_confirm_delay_seconds=0.4,
+            max_transcript_inactivity_seconds=1.5,
+            priority_words=boosting["words"],
+            priority_words_strength=boosting["boost_threshold"],
+        ),
+        llm=inference.LLM("openai/gpt-4.1-mini"),
+        tts=inference.TTS("cartesia/sonic-3"),
+        turn_handling=TurnHandlingOptions(
+            turn_detection="stt",
+            endpointing={"min_delay": 0},
+        ),
+    )
+
+    await session.start(agent=Assistant(), room=ctx.room)
+    await ctx.connect()
+
+
+if __name__ == "__main__":
+    agents.cli.run_app(server)
+```
+
+## Parameters
+
+| Parameter | Default | Description |
+| --- | --- | --- |
+| `recognition_model` | `"eot_nabrah"` | `"eot_nabrah"` emits the end-of-turn signal used for turn detection. `""` selects the default model, which is more accurate but emits no signal. |
+| `end_of_turn_confirm_delay_seconds` | `0.4` | Hold after an end-of-turn signal before committing the turn. `None` commits immediately. |
+| `max_transcript_inactivity_seconds` | `None` | Optional fallback that finalizes after no new transcript text. This does not measure acoustic silence. |
+| `priority_words` | `[]` | Terms to bias recognition toward. |
+| `priority_words_strength` | `0.5` | How strongly to bias. |
+| `api_key` | `NABRAH_API_KEY` | API key, if not set in the environment. |

livekit_plugins_nabrah-1.8.6/README.md

@@ -0,0 +1,176 @@
+# Nabrah plugin for LiveKit Agents
+
+Support for [Nabrah](https://nabrah.ai/) Speech-to-Text in LiveKit Agents, with
+client-side end-of-turn detection tuned for Arabic conversation.
+
+## Installation
+
+```bash
+pip install livekit-plugins-nabrah
+```
+
+## Pre-requisites
+
+You'll need an API key from Nabrah. It can be set as an environment variable:
+`NABRAH_API_KEY`.
+
+## Usage
+
+Use Nabrah STT in an `AgentSession`:
+
+```python
+from livekit.agents import AgentSession
+from livekit.plugins import nabrah
+
+session = AgentSession(
+    stt=nabrah.STT(
+        recognition_model="eot_nabrah",
+        language="ar-SA",
+        end_of_turn_confirm_delay_seconds=0.4,
+    ),
+)
+```
+
+### Turn detection
+
+`recognition_model="eot_nabrah"` emits the end-of-turn signal the plugin uses to
+close a turn. `end_of_turn_confirm_delay_seconds` is how long it waits after that
+signal before committing. Speaking again inside the window keeps the turn open.
+`max_transcript_inactivity_seconds` optionally commits after that many seconds
+without new transcript text. It is disabled by default because it measures
+recognizer inactivity, not acoustic silence, and a provider delay could otherwise
+split continuous speech.
+
+Nabrah's unnamed model (`recognition_model=""`) is more accurate but emits no
+end-of-turn signal. When using it, configure another turn detector or explicitly
+set `max_transcript_inactivity_seconds` as a fallback heuristic.
+
+### Word boosting
+
+Bias recognition toward terms the model gets wrong:
+
+```python
+stt = nabrah.STT(
+    priority_words=["مستشفى الملك فيصل التخصصي", "رقم الهوية الوطنية"],
+    priority_words_strength=0.5,
+)
+```
+
+`0.5` is the recommended strength. Higher values make boosted terms appear in
+places they were not said, so keep the list to terms your callers actually say
+and add one only after hearing it come out wrong. Multi-word phrases are boosted
+as a unit.
+
+#### Loading terms from a file
+
+For anything beyond a handful of terms, keep them in a JSON file so they can be
+edited without touching code. Create `boosting.json` next to your agent:
+
+```json
+{
+  "boost_threshold": 0.5,
+  "words": [
+    "مستشفى الملك فيصل التخصصي",
+    "رقم الهوية الوطنية"
+  ]
+}
+```
+
+Load it at startup and pass it to the plugin:
+
+```python
+import json
+import pathlib
+
+from livekit.agents import AgentSession
+from livekit.plugins import nabrah
+
+boosting = json.loads(
+    pathlib.Path(__file__).with_name("boosting.json").read_text(encoding="utf-8")
+)
+
+session = AgentSession(
+    stt=nabrah.STT(
+        recognition_model="eot_nabrah",
+        language="ar-SA",
+        end_of_turn_confirm_delay_seconds=0.4,
+        priority_words=boosting["words"],
+        priority_words_strength=boosting["boost_threshold"],
+    ),
+)
+```
+
+Read the file with `encoding="utf-8"`. Without it, Arabic terms fail to load on
+platforms that default to a different encoding.
+
+## Full example
+
+A complete agent using Nabrah STT with word boosting loaded from a file:
+
+```python
+import json
+import pathlib
+
+from dotenv import load_dotenv
+from livekit import agents
+from livekit.agents import (
+    Agent,
+    AgentServer,
+    AgentSession,
+    JobContext,
+    TurnHandlingOptions,
+    inference,
+)
+from livekit.plugins import nabrah
+
+load_dotenv()
+
+boosting = json.loads(
+    pathlib.Path(__file__).with_name("boosting.json").read_text(encoding="utf-8")
+)
+
+server = AgentServer()
+
+
+class Assistant(Agent):
+    def __init__(self) -> None:
+        super().__init__(instructions="You are a helpful voice assistant.")
+
+
+@server.rtc_session()
+async def entrypoint(ctx: JobContext) -> None:
+    session = AgentSession(
+        stt=nabrah.STT(
+            recognition_model="eot_nabrah",
+            language="ar-SA",
+            end_of_turn_confirm_delay_seconds=0.4,
+            max_transcript_inactivity_seconds=1.5,
+            priority_words=boosting["words"],
+            priority_words_strength=boosting["boost_threshold"],
+        ),
+        llm=inference.LLM("openai/gpt-4.1-mini"),
+        tts=inference.TTS("cartesia/sonic-3"),
+        turn_handling=TurnHandlingOptions(
+            turn_detection="stt",
+            endpointing={"min_delay": 0},
+        ),
+    )
+
+    await session.start(agent=Assistant(), room=ctx.room)
+    await ctx.connect()
+
+
+if __name__ == "__main__":
+    agents.cli.run_app(server)
+```
+
+## Parameters
+
+| Parameter | Default | Description |
+| --- | --- | --- |
+| `recognition_model` | `"eot_nabrah"` | `"eot_nabrah"` emits the end-of-turn signal used for turn detection. `""` selects the default model, which is more accurate but emits no signal. |
+| `end_of_turn_confirm_delay_seconds` | `0.4` | Hold after an end-of-turn signal before committing the turn. `None` commits immediately. |
+| `max_transcript_inactivity_seconds` | `None` | Optional fallback that finalizes after no new transcript text. This does not measure acoustic silence. |
+| `priority_words` | `[]` | Terms to bias recognition toward. |
+| `priority_words_strength` | `0.5` | How strongly to bias. |
+| `api_key` | `NABRAH_API_KEY` | API key, if not set in the environment. |

livekit_plugins_nabrah-1.8.6/livekit/plugins/nabrah/__init__.py

@@ -0,0 +1,31 @@
+# Copyright 2026 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.
+
+"""Nabrah speech-to-text plugin for LiveKit Agents."""
+
+from livekit.agents import Plugin
+
+from .log import logger
+from .stt import STT, NabrahRecognitionModel, SpeechStream
+from .version import __version__
+
+
+class NabrahPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(NabrahPlugin())
+
+__all__ = ["STT", "NabrahRecognitionModel", "SpeechStream", "__version__"]

livekit_plugins_nabrah-1.8.6/livekit/plugins/nabrah/log.py

@@ -0,0 +1,17 @@
+# Copyright 2026 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.nabrah")

livekit_plugins_nabrah-1.8.6/livekit/plugins/nabrah/stt.py

@@ -0,0 +1,654 @@
+# Copyright 2026 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.
+
+"""Nabrah STT plugin for LiveKit Agents.
+
+The backend relays recognizer output with minimal interpretation, so the plugin
+handles token stripping, EOT detection, debounce, cross-utterance accumulation,
+word conversion, and audio-position tracking.
+
+Wire contract (server -> client):
+    {"type": "ready"}
+    {"type": "error", "message": ...}
+    {"type": "transcript", "text": ..., "is_final": bool,
+     "audio_processed": float}
+
+Two facts drive the whole design:
+
+- `text` is cumulative *within one recognizer utterance* and restarts from
+  scratch after every `is_final`. `is_final` is utterance-level, not
+  turn-level  one spoken sentence routinely produces a dozen  so a final is
+  only a diff-cursor reset here, never a turn boundary.
+- `audio_processed` is cumulative seconds of audio the recognizer has actually
+  consumed. It is the authoritative audio clock; a send-side count runs ahead
+  of realtime when input arrives in bursts. The key may be absent on older
+  backends, so the local counter stays as a fallback.
+"""
+
+from __future__ import annotations
+
+import asyncio
+import json
+import math
+import os
+import time
+from typing import Any, Literal
+
+import aiohttp
+
+from livekit import rtc
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    APIConnectionError,
+    APIConnectOptions,
+    APIError,
+    APIStatusError,
+    stt,
+    utils,
+)
+from livekit.agents.language import LanguageCode
+from livekit.agents.types import NOT_GIVEN, NotGivenOr, TimedString
+from livekit.agents.utils import is_given
+
+from .log import logger
+
+DEFAULT_BASE_URL = "wss://api.nabrah.ai/api/ext/stt/ws"
+
+NabrahRecognitionModel = Literal["eot_nabrah", ""]
+
+EOT_TOKEN = "<eot>"
+EOT_PUNCTUATION = (".", "?", "!", "؟")
+_NO_SPACE_BEFORE = frozenset(".,?!:;،؛؟")
+
+_WATCHDOG_POLL_SECONDS = 0.1
+
+
+def _strip_and_detect_eot(new_text: str) -> tuple[str, bool]:
+    """Strip <eot> from a transcript diff and flag an end-of-turn candidate.
+
+    Detection runs on the raw diff so a trailing token isn't lost by its own
+    removal. The token becomes a SPACE, never ""  the recognizer doesn't
+    reliably pad it, and stripping to empty glues the neighbours together
+    ("الله" + "تعالى" -> "اللهتعالى").
+    """
+    stripped_new_text = new_text.rstrip()
+    is_candidate = stripped_new_text.endswith(EOT_TOKEN) or (
+        stripped_new_text[-1:] in EOT_PUNCTUATION
+    )
+    return new_text.replace(EOT_TOKEN, " "), is_candidate
+
+
+def _normalize_whitespace(text: str) -> str:
+    return " ".join(text.split())
+
+
+def _append_text(existing: str, new: str) -> str:
+    """Join transcript fragments without inserting spaces before punctuation."""
+    head = new.lstrip()[:1]
+    separator = "" if not existing or head in _NO_SPACE_BEFORE else " "
+    return _normalize_whitespace(existing + separator + new)
+
+
+def _word_text(w: dict[str, Any]) -> str:
+    value = w.get("word", "")
+    if not isinstance(value, str):
+        raise ValueError("nabrah word text must be a string")
+    return value.replace(EOT_TOKEN, "").strip()
+
+
+def _finite_number(value: object, *, field: str) -> float:
+    if isinstance(value, bool) or not isinstance(value, (int, float)):
+        raise ValueError(f"nabrah {field} must be a number")
+    number = float(value)
+    if not math.isfinite(number) or number < 0:
+        raise ValueError(f"nabrah {field} must be finite and non-negative")
+    return number
+
+
+def _timed_word(w: dict[str, Any], offset: float) -> TimedString:
+    """One backend word entry as a TimedString. Timestamps arrive in ms."""
+    start_time = _finite_number(w.get("start_time", 0), field="word start_time")
+    end_time = _finite_number(w.get("end_time", 0), field="word end_time")
+    if end_time < start_time:
+        raise ValueError("nabrah word end_time must not precede start_time")
+
+    confidence_value = w.get("confidence", NOT_GIVEN)
+    confidence = (
+        NOT_GIVEN
+        if confidence_value is None or not is_given(confidence_value)
+        else _finite_number(confidence_value, field="word confidence")
+    )
+    return TimedString(
+        _word_text(w),
+        start_time=start_time / 1000.0 + offset,
+        end_time=end_time / 1000.0 + offset,
+        confidence=confidence,
+    )
+
+
+class STT(stt.STT):
+    def __init__(
+        self,
+        *,
+        recognition_model: NabrahRecognitionModel | str = "eot_nabrah",
+        base_url: NotGivenOr[str] = NOT_GIVEN,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
+        language: str = "ar-SA",
+        end_of_utterance_silence_ms: int = -1,
+        disable_number_normalization: bool = False,
+        priority_words: list[str] | None = None,
+        priority_words_strength: float = 0.5,
+        max_transcript_inactivity_seconds: float | None = None,
+        end_of_turn_confirm_delay_seconds: float | None = 0.4,
+        http_session: aiohttp.ClientSession | None = None,
+    ) -> None:
+        super().__init__(
+            capabilities=stt.STTCapabilities(
+                streaming=True,
+                interim_results=True,
+                aligned_transcript=False,
+                offline_recognize=False,
+            ),
+        )
+        nabrah_api_key = api_key if is_given(api_key) else os.environ.get("NABRAH_API_KEY")
+        if not nabrah_api_key:
+            raise ValueError(
+                "Nabrah API key is required, either as argument or by setting "
+                "the NABRAH_API_KEY environment variable",
+            )
+        self._api_key = nabrah_api_key
+        self._base_url = (
+            base_url
+            if is_given(base_url)
+            else os.environ.get(
+                "NABRAH_STT_URL",
+                DEFAULT_BASE_URL,
+            )
+        )
+
+        self._recognition_model = recognition_model
+        self._language = language
+        self._end_of_utterance_silence_ms = end_of_utterance_silence_ms
+        self._disable_number_normalization = disable_number_normalization
+        self._priority_words = priority_words or []
+        self._priority_words_strength = priority_words_strength
+        self._max_transcript_inactivity_seconds = max_transcript_inactivity_seconds
+        self._end_of_turn_confirm_delay_seconds = end_of_turn_confirm_delay_seconds
+        self._session = http_session
+        self._label = "nabrah.STT (nabrah-stt-v1)"
+
+    @property
+    def model(self) -> str:
+        return "nabrah-stt-v1"
+
+    @property
+    def provider(self) -> str:
+        return "nabrah"
+
+    def _ensure_session(self) -> aiohttp.ClientSession:
+        if not self._session:
+            self._session = utils.http_context.http_session()
+        return self._session
+
+    async def _recognize_impl(
+        self,
+        buffer: utils.AudioBuffer,
+        *,
+        language: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> stt.SpeechEvent:
+        raise NotImplementedError("nabrah STT does not support single-shot recognition")
+
+    def stream(
+        self,
+        *,
+        language: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> stt.RecognizeStream:
+        lang = language if is_given(language) else self._language
+        return SpeechStream(
+            stt_instance=self,
+            conn_options=conn_options,
+            language=lang,
+            http_session=self._ensure_session(),
+        )
+
+
+class SpeechStream(stt.SpeechStream):
+    _utt_raw: str = ""
+    _utt_clean: str = ""
+    _utt_closed: bool = False
+    _utt_flushed_clean: str = ""
+    _utt_flushed_chars: int = 0
+    _input_done: bool = False
+    _turn_words: tuple[TimedString, ...] = ()
+    _utt_words: tuple[TimedString, ...] = ()
+    _utt_flushed_words: int = 0
+    _utt_raw_seen: int = 0
+
+    def __init__(
+        self,
+        *,
+        stt_instance: STT,
+        conn_options: APIConnectOptions,
+        language: str,
+        http_session: aiohttp.ClientSession,
+    ) -> None:
+        super().__init__(stt=stt_instance, conn_options=conn_options, sample_rate=16000)
+        self._stt: STT = stt_instance
+        self._language = LanguageCode(language)
+        self._session = http_session
+
+        self._is_speaking = False
+
+        self._turn_text = ""
+        self._utt_clean = ""
+        self._utt_raw = ""
+        self._utt_closed = False
+        self._utt_flushed_clean = ""
+        self._utt_flushed_chars = 0
+        self._turn_words = ()
+        self._utt_words = ()
+        self._utt_flushed_words = 0
+        self._utt_raw_seen = 0
+
+        self._segment_start_time: float = 0.0
+        self._segment_end_time: float = 0.0
+        self._request_id: str = ""
+
+        self._last_progress_at: float = 0.0
+        self._pending_eot_at: float | None = None
+
+        self._latest_audio_processed: float | None = None
+        self._audio_position: float = 0.0
+        self._reported_audio_position: float = 0.0
+        self._last_message_position: float = 0.0
+
+    def _config_frame(self) -> dict[str, Any]:
+        return {
+            "api_key": self._stt._api_key,
+            "recognition_model": self._stt._recognition_model,
+            "end_of_utterance_silence_ms": self._stt._end_of_utterance_silence_ms,
+            "disable_number_normalization": self._stt._disable_number_normalization,
+            "priority_words": self._stt._priority_words,
+            "priority_words_strength": self._stt._priority_words_strength,
+        }
+
+    async def _connect_ws(self) -> aiohttp.ClientWebSocketResponse:
+        try:
+            return await asyncio.wait_for(
+                self._session.ws_connect(self._stt._base_url),
+                self._conn_options.timeout,
+            )
+        except (
+            aiohttp.ClientConnectorError,
+            aiohttp.WSServerHandshakeError,
+            asyncio.TimeoutError,
+        ) as e:
+            raise APIConnectionError("failed to connect to nabrah STT") from e
+
+    def _stream_failure(self, message: str) -> APIConnectionError:
+        return APIConnectionError(message, retryable=self._audio_position == 0.0)
+
+    async def _run(self) -> None:
+        self._latest_audio_processed = None
+        self._audio_position = 0.0
+        self._reported_audio_position = 0.0
+        self._last_message_position = 0.0
+        self._input_done = False
+
+        ws = await self._connect_ws()
+        try:
+            try:
+                await ws.send_str(json.dumps(self._config_frame()))
+            except Exception as e:
+                raise APIConnectionError(
+                    f"nabrah STT configuration send failed ({type(e).__name__})"
+                ) from None
+
+            async def _await_ready() -> None:
+                while True:
+                    try:
+                        msg = await ws.receive()
+                    except Exception as e:
+                        raise APIConnectionError(
+                            f"nabrah STT ready handshake failed ({type(e).__name__})"
+                        ) from None
+                    if msg.type != aiohttp.WSMsgType.TEXT:
+                        raise APIConnectionError("nabrah STT closed before ready")
+                    try:
+                        payload = json.loads(msg.data)
+                    except (json.JSONDecodeError, TypeError):
+                        raise APIConnectionError(
+                            "nabrah STT sent an invalid ready response"
+                        ) from None
+                    if not isinstance(payload, dict):
+                        raise APIConnectionError("nabrah STT sent an invalid ready response")
+                    if payload.get("type") == "error":
+                        raise APIStatusError(
+                            "nabrah STT rejected the configuration",
+                            status_code=-1,
+                            retryable=False,
+                        )
+                    if payload.get("type") == "ready":
+                        return
+
+            try:
+                await asyncio.wait_for(_await_ready(), self._conn_options.timeout)
+            except asyncio.TimeoutError as e:
+                raise APIConnectionError("nabrah STT never sent ready") from e
+
+            watchdog_task = asyncio.create_task(self._eot_watchdog())
+            send_task = asyncio.create_task(self._send_task(ws))
+            recv_task = asyncio.create_task(self._recv_task(ws))
+            try:
+                await asyncio.gather(send_task, recv_task)
+            finally:
+                watchdog_task.cancel()
+                await utils.aio.gracefully_cancel(send_task, recv_task, watchdog_task)
+                if (
+                    self._current_text()
+                    or self._is_speaking
+                    or self._audio_clock() > self._reported_audio_position
+                ):
+                    self._flush_eos()
+        finally:
+            await ws.close()
+
+    async def _eot_watchdog(self) -> None:
+        inactivity_timeout = self._stt._max_transcript_inactivity_seconds
+        confirm_delay = self._stt._end_of_turn_confirm_delay_seconds
+        while True:
+            await asyncio.sleep(_WATCHDOG_POLL_SECONDS)
+            now = time.monotonic()
+            if (
+                confirm_delay is not None
+                and self._pending_eot_at is not None
+                and now - self._pending_eot_at >= confirm_delay
+            ):
+                self._flush_eos()
+                continue
+            if (
+                inactivity_timeout is not None
+                and self._current_text()
+                and now - self._last_progress_at >= inactivity_timeout
+            ):
+                self._flush_eos()
+
+    async def _send_task(self, ws: aiohttp.ClientWebSocketResponse) -> None:
+        try:
+            async for data in self._input_ch:
+                if isinstance(data, rtc.AudioFrame):
+                    audio_bytes = data.data.tobytes()
+                    if audio_bytes:
+                        self._audio_position += data.samples_per_channel / data.sample_rate
+                        await ws.send_bytes(audio_bytes)
+            self._input_done = True
+            await ws.send_str(json.dumps({"type": "eof"}))
+        except Exception as e:
+            raise self._stream_failure(f"nabrah STT send failed ({type(e).__name__})") from None
+
+    async def _recv_task(self, ws: aiohttp.ClientWebSocketResponse) -> None:
+        while True:
+            try:
+                msg = await ws.receive()
+            except Exception as e:
+                raise self._stream_failure(
+                    f"nabrah STT receive failed ({type(e).__name__})"
+                ) from None
+            if msg.type in (
+                aiohttp.WSMsgType.CLOSED,
+                aiohttp.WSMsgType.CLOSE,
+                aiohttp.WSMsgType.CLOSING,
+            ):
+                if not self._input_done:
+                    raise self._stream_failure("nabrah STT closed unexpectedly")
+                return
+            if msg.type == aiohttp.WSMsgType.ERROR:
+                raise self._stream_failure("nabrah STT WebSocket failed")
+            if msg.type != aiohttp.WSMsgType.TEXT:
+                continue
+            try:
+                self._process_message(json.loads(msg.data))
+            except APIError:
+                raise
+            except Exception:
+                # Never attach an exception or payload here: malformed messages can
+                # contain customer transcripts. Later cumulative results can recover.
+                logger.warning("nabrah STT returned malformed data")
+
+    def _emit(self, event: stt.SpeechEvent) -> None:
+        self._event_ch.send_nowait(event)
+
+    def _audio_clock(self) -> float:
+        """Audio-stream position for this connection, in seconds.
+
+        The backend's audio_processed is what the recognizer actually consumed,
+        so it cannot run ahead of realtime the way a send-side count does when
+        input arrives in bursts. Falls back to audio pushed if absent.
+        """
+        if self._latest_audio_processed is not None:
+            return self._latest_audio_processed
+        return self._audio_position
+
+    def _turn_word_list(self) -> tuple[TimedString, ...]:
+        """Every word in the turn so far: committed utterances plus the open one."""
+        return self._turn_words + self._utt_words
+
+    def _current_text(self) -> str:
+        return _append_text(self._turn_text, self._utt_clean)
+
+    def _flush_eos(self) -> None:
+        text = self._current_text()
+        end_time = self._segment_end_time or (self._audio_clock() + self.start_time_offset)
+        start_time = min(self._segment_start_time, end_time)
+
+        if text:
+            self._emit(
+                stt.SpeechEvent(
+                    type=stt.SpeechEventType.FINAL_TRANSCRIPT,
+                    request_id=self._request_id,
+                    alternatives=[
+                        stt.SpeechData(
+                            language=self._language,
+                            text=text,
+                            start_time=start_time,
+                            end_time=end_time,
+                            words=list(self._turn_word_list()) or None,
+                        )
+                    ],
+                )
+            )
+
+        audio_clock = self._audio_clock()
+        usage_duration = audio_clock - self._reported_audio_position
+        if usage_duration > 0:
+            self._emit(
+                stt.SpeechEvent(
+                    type=stt.SpeechEventType.RECOGNITION_USAGE,
+                    recognition_usage=stt.RecognitionUsage(
+                        audio_duration=usage_duration,
+                    ),
+                )
+            )
+            self._reported_audio_position = audio_clock
+
+        if self._is_speaking:
+            self._emit(
+                stt.SpeechEvent(
+                    type=stt.SpeechEventType.END_OF_SPEECH,
+                    alternatives=[
+                        stt.SpeechData(
+                            language=self._language,
+                            text="",
+                            start_time=start_time,
+                            end_time=end_time,
+                        )
+                    ],
+                )
+            )
+
+        self._utt_flushed_clean = _append_text(self._utt_flushed_clean, self._utt_clean)
+        self._utt_flushed_chars = len(self._utt_flushed_clean)
+        # index into the backend's raw `words` list, so count raw entries consumed,
+        # not the filtered survivors, or blank entries shift the cursor backwards
+        # and already-emitted words get replayed.
+        self._utt_flushed_words = self._utt_raw_seen
+
+        self._turn_text = ""
+        self._utt_clean = ""
+        self._turn_words = ()
+        self._utt_words = ()
+        self._is_speaking = False
+        self._pending_eot_at = None
+        self._segment_start_time = 0.0
+        self._segment_end_time = 0.0
+        self._request_id = ""
+
+    def _emit_preflight(self) -> None:
+        text = self._current_text()
+        if not text:
+            return
+
+        self._emit(
+            stt.SpeechEvent(
+                type=stt.SpeechEventType.PREFLIGHT_TRANSCRIPT,
+                request_id=self._request_id,
+                alternatives=[
+                    stt.SpeechData(
+                        language=self._language,
+                        text=text,
+                        start_time=self._segment_start_time,
+                        end_time=self._segment_end_time,
+                    )
+                ],
+            )
+        )
+
+    def _process_message(self, data: dict[str, Any]) -> None:
+        msg_type = data.get("type")
+
+        if msg_type == "error":
+            raise APIStatusError(
+                message="nabrah STT reported an error",
+                status_code=-1,
+                request_id=None,
+                body=None,
+                retryable=False,
+            )
+
+        if msg_type != "transcript":
+            return
+
+        text = data.get("text", "")
+        is_final = data.get("is_final", False)
+        if not isinstance(is_final, bool):
+            raise ValueError("nabrah is_final must be a boolean")
+        utt_final = is_final
+
+        previous_audio_position = self._last_message_position
+        reported = data.get("audio_processed")
+        if reported is not None:
+            reported_seconds = _finite_number(reported, field="audio_processed")
+            if (
+                self._latest_audio_processed is None
+                or reported_seconds > self._latest_audio_processed
+            ):
+                self._latest_audio_processed = reported_seconds
+        self._last_message_position = self._audio_clock()
+
+        if not text:
+            return
+
+        clean_now, _ = _strip_and_detect_eot(text)
+        clean_now = _normalize_whitespace(clean_now)
+        if self._utt_closed:
+            self._turn_text = _append_text(self._turn_text, self._utt_clean)
+            self._utt_clean = ""
+            self._utt_raw = ""
+            self._utt_flushed_clean = ""
+            self._utt_flushed_chars = 0
+            self._turn_words = self._turn_words + self._utt_words
+            self._utt_words = ()
+            self._utt_flushed_words = 0
+            self._utt_raw_seen = 0
+        self._utt_closed = False
+
+        raw_words = data.get("words") or []
+        if raw_words:
+            self._utt_words = tuple(
+                _timed_word(w, self.start_time_offset)
+                for w in raw_words[self._utt_flushed_words :]
+                if _word_text(w)
+            )
+            self._utt_raw_seen = len(raw_words)
+
+        new_text = text[len(self._utt_raw) :] if text.startswith(self._utt_raw) else text
+        _, is_eot = _strip_and_detect_eot(new_text)
+        self._utt_clean = clean_now[self._utt_flushed_chars :]
+        self._utt_raw = text
+        if utt_final:
+            self._utt_closed = True
+
+        if not new_text:
+            return
+
+        has_real_progress = bool(new_text.replace(EOT_TOKEN, "").strip())
+
+        if has_real_progress:
+            self._last_progress_at = time.monotonic()
+            self._pending_eot_at = None
+
+            turn_words = self._turn_word_list()
+
+            word_start = turn_words[0].start_time if turn_words else NOT_GIVEN
+            word_end = turn_words[-1].end_time if turn_words else NOT_GIVEN
+
+            if not self._is_speaking:
+                self._is_speaking = True
+                self._segment_start_time = (
+                    word_start
+                    if is_given(word_start)
+                    else min(previous_audio_position, self._audio_clock()) + self.start_time_offset
+                )
+                self._emit(
+                    stt.SpeechEvent(
+                        type=stt.SpeechEventType.START_OF_SPEECH,
+                        speech_start_time=(
+                            self.start_time - self.start_time_offset + self._segment_start_time
+                        ),
+                    )
+                )
+            self._segment_end_time = (
+                word_end if is_given(word_end) else self._audio_clock() + self.start_time_offset
+            )
+
+        if not self._request_id:
+            self._request_id = utils.shortuuid("nabrah-")
+
+        current = self._current_text()
+        if current:
+            self._emit(
+                stt.SpeechEvent(
+                    type=stt.SpeechEventType.INTERIM_TRANSCRIPT,
+                    alternatives=[stt.SpeechData(language=self._language, text=current)],
+                )
+            )
+
+        if is_eot:
+            if self._stt._end_of_turn_confirm_delay_seconds is None:
+                self._flush_eos()
+            elif self._pending_eot_at is None:
+                self._pending_eot_at = time.monotonic()
+                self._emit_preflight()

livekit_plugins_nabrah-1.8.6/livekit/plugins/nabrah/version.py

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

livekit_plugins_nabrah-1.8.6/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "livekit-plugins-nabrah"
+dynamic = ["version"]
+description = "LiveKit Agents plugin for Nabrah Arabic speech-to-text"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+authors = [{ name = "LiveKit", email = "hello@livekit.io" }]
+keywords = [
+    "webrtc",
+    "realtime",
+    "audio",
+    "livekit",
+    "livekit-agents",
+    "nabrah",
+    "arabic",
+    "stt",
+    "speech-to-text",
+    "streaming",
+    "websocket",
+]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = ["livekit-agents>=1.8.6", "aiohttp"]
+
+[project.urls]
+Documentation = "https://docs.livekit.io"
+Website = "https://nabrah.ai"
+Source = "https://github.com/livekit/agents"
+
+[tool.hatch.version]
+path = "livekit/plugins/nabrah/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["livekit"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/livekit"]
+
+[tool.uv]
+exclude-newer = "7 days"
+exclude-newer-package = { livekit-agents = "0 days" }