livekit-plugins-clova 1.0.0__py3-none-any.whl

livekit/plugins/clova/__init__.py

@@ -0,0 +1,30 @@
+from .stt import STT
+from .version import __version__
+
+__all__ = [
+    "STT",
+    "__version__",
+]
+
+
+from livekit.agents import Plugin
+
+
+class ClovaSTTPlugin(Plugin):
+    def __init__(self):
+        super().__init__(__name__, __version__, __package__)
+
+    def download_files(self):
+        pass
+
+
+Plugin.register_plugin(ClovaSTTPlugin())
+
+# 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/clova/common.py

@@ -0,0 +1,13 @@
+import io
+
+from pydub import AudioSegment
+
+
+def resample_audio(audio_bytes, original_sample_rate, target_sample_rate):
+    resampled_audio = AudioSegment.from_raw(
+        io.BytesIO(audio_bytes),
+        sample_width=2,
+        frame_rate=original_sample_rate,
+        channels=1,
+    ).set_frame_rate(target_sample_rate)
+    return resampled_audio.raw_data

livekit/plugins/clova/constants.py

@@ -0,0 +1,2 @@
+CLOVA_INPUT_SAMPLE_RATE = 16000
+LIVEKIT_INPUT_SAMPLE_RATE = 48000

livekit/plugins/clova/log.py

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

livekit/plugins/clova/models.py

@@ -0,0 +1,15 @@
+from typing import Literal
+
+ClovaSttLanguages = Literal["ko-KR", "en-US", "enko", "ja", "zh-cn", "zh-tw"]
+
+ClovaSpeechAPIType = Literal["recognizer/object-storage", "recognizer/url", "recognizer/upload"]
+
+clova_languages_mapping = {
+    "en": "en-US",
+    "ko-KR": "ko-KR",
+    "en-US": "en-US",
+    "enko": "enko",
+    "ja": "ja",
+    "zh-cn": "zh-cn",
+    "zh-tw": "zh-tw",
+}

livekit/plugins/clova/stt.py

@@ -0,0 +1,161 @@
+# 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 __future__ import annotations
+
+import asyncio
+import io
+import json
+import os
+import time
+import wave
+
+import aiohttp
+
+from livekit.agents import (
+    APIConnectOptions,
+    APIStatusError,
+    APITimeoutError,
+    stt,
+    utils,
+)
+from livekit.agents.stt import SpeechEventType, STTCapabilities
+from livekit.agents.types import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    NotGivenOr,
+)
+from livekit.agents.utils import AudioBuffer, is_given, merge_frames
+from livekit.plugins.clova.constants import CLOVA_INPUT_SAMPLE_RATE
+
+from .common import resample_audio
+from .log import logger
+from .models import ClovaSpeechAPIType, ClovaSttLanguages, clova_languages_mapping
+
+
+class STT(stt.STT):
+    def __init__(
+        self,
+        *,
+        language: ClovaSttLanguages | str = "en-US",
+        secret: NotGivenOr[str] = NOT_GIVEN,
+        invoke_url: NotGivenOr[str] = NOT_GIVEN,
+        http_session: aiohttp.ClientSession | None = None,
+        threshold: float = 0.5,
+    ):
+        """
+        Create a new instance of Clova STT.
+
+        ``secret`` and ``invoke_url`` must be set, either using arguments or by setting the
+        ``CLOVA_STT_SECRET_KEY`` and ``CLOVA_STT_INVOKE_URL`` environmental variables, respectively.
+        """
+
+        super().__init__(capabilities=STTCapabilities(streaming=False, interim_results=True))
+        self._secret = secret if is_given(secret) else os.environ.get("CLOVA_STT_SECRET_KEY")
+        self._invoke_url = (
+            invoke_url if is_given(invoke_url) else os.environ.get("CLOVA_STT_INVOKE_URL")
+        )
+        self._language = clova_languages_mapping.get(language, language)
+        self._session = http_session
+        if self._secret is None:
+            raise ValueError(
+                "Clova STT secret key is required. It should be set with env CLOVA_STT_SECRET_KEY"
+            )
+        self.threshold = threshold
+
+    def update_options(self, *, language: NotGivenOr[str] = NOT_GIVEN) -> None:
+        if is_given(language):
+            self._language = clova_languages_mapping.get(language, language)
+
+    def _ensure_session(self) -> aiohttp.ClientSession:
+        if not self._session:
+            self._session = utils.http_context.http_session()
+        return self._session
+
+    def url_builder(self, process_method: ClovaSpeechAPIType = "recognizer/upload") -> str:
+        return f"{self._invoke_url}/{process_method}"
+
+    async def _recognize_impl(
+        self,
+        buffer: AudioBuffer,
+        *,
+        language: NotGivenOr[ClovaSttLanguages | str] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> stt.SpeechEvent:
+        try:
+            url = self.url_builder()
+            if is_given(language):
+                self._language = clova_languages_mapping.get(language, language)
+            payload = json.dumps({"language": self._language, "completion": "sync"})
+
+            buffer = merge_frames(buffer)
+            buffer_bytes = resample_audio(
+                buffer.data.tobytes(), buffer.sample_rate, CLOVA_INPUT_SAMPLE_RATE
+            )
+
+            io_buffer = io.BytesIO()
+            with wave.open(io_buffer, "wb") as wav:
+                wav.setnchannels(1)
+                wav.setsampwidth(2)  # 16-bit
+                wav.setframerate(CLOVA_INPUT_SAMPLE_RATE)
+                wav.writeframes(buffer_bytes)
+            io_buffer.seek(0)
+
+            headers = {"X-CLOVASPEECH-API-KEY": self._secret}
+            form_data = aiohttp.FormData()
+            form_data.add_field("params", payload)
+            form_data.add_field("media", io_buffer, filename="audio.wav", content_type="audio/wav")
+            start = time.time()
+            async with self._ensure_session().post(
+                url,
+                data=form_data,
+                headers=headers,
+                timeout=aiohttp.ClientTimeout(
+                    total=30,
+                    sock_connect=conn_options.timeout,
+                ),
+            ) as response:
+                response_data = await response.json()
+                end = time.time()
+                text = response_data.get("text")
+                confidence = response_data.get("confidence")
+                logger.info(f"{text} | {confidence} | total_seconds: {end - start}")
+                if not text or "error" in response_data:
+                    raise ValueError(f"Unexpected response: {response_data}")
+                if confidence < self.threshold:
+                    raise ValueError(
+                        f"Confidence: {confidence} is bellow threshold {self.threshold}. Skipping."
+                    )
+                logger.info(f"final event: {response_data}")
+                return self._transcription_to_speech_event(text=text)
+
+        except asyncio.TimeoutError as e:
+            raise APITimeoutError() from e
+        except aiohttp.ClientResponseError as e:
+            raise APIStatusError(
+                message=e.message,
+                status_code=e.status,
+                request_id=None,
+                body=None,
+            ) from e
+
+    def _transcription_to_speech_event(
+        self,
+        text: str,
+        event_type: SpeechEventType = stt.SpeechEventType.INTERIM_TRANSCRIPT,
+    ) -> stt.SpeechEvent:
+        return stt.SpeechEvent(
+            type=event_type,
+            alternatives=[stt.SpeechData(text=text, language=self._language)],
+        )

livekit/plugins/clova/version.py

@@ -0,0 +1,15 @@
+# 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.
+
+__version__ = "1.0.0"

livekit_plugins_clova-1.0.0.dist-info/METADATA

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-clova
+Version: 1.0.0
+Summary: LiveKit Agents Plugin for LINE Clova STT
+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>=1.0.0
+Requires-Dist: pydub~=0.25.1
+Description-Content-Type: text/markdown
+
+# LiveKit Plugins Clova
+
+Agent Framework plugin for speech-to-text with [Clova](https://api.ncloud-docs.com/docs/)'s API. Currently supports speech-to-text.
+
+## Installation
+
+```bash
+pip install livekit-plugins-clova
+```
+
+## Pre-requisites
+
+You need invoke url and secret key from Naver cloud platform -> Clova Speech and set as environment variables: `CLOVA_STT_INVOKE_URL` & `CLOVA_STT_SECRET_KEY`

livekit_plugins_clova-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+livekit/plugins/clova/__init__.py,sha256=WelhQwAYhVLN1OYJjlXDe1k1rSj6lJQLIYSgdiA4Xp4,508
+livekit/plugins/clova/common.py,sha256=67vNmTLX7le5nTpM4N8MFNmQuIYCXy7NKf9-OkP1JmI,359
+livekit/plugins/clova/constants.py,sha256=b6X_va-KsJWDsDdjo-nka7yae_9fVmTnTb_sQm8gQao,66
+livekit/plugins/clova/log.py,sha256=odnkyQ2umM1S3wZiHAaOrUowHZl-de1y57MXL9CD1uI,68
+livekit/plugins/clova/models.py,sha256=R71m_BcWxmdqSPIrfc49a0yuJMlcrzT8HuQZTWmCpQk,378
+livekit/plugins/clova/stt.py,sha256=cWU9t507GB6v1X1iYOO3kxtzvPM-A5YZQdRFtFRH5kI,5991
+livekit/plugins/clova/version.py,sha256=nW89L_U9N4ukT3wAO3BeTqOaa87zLUOsEFz8TkiKIP8,600
+livekit_plugins_clova-1.0.0.dist-info/METADATA,sha256=jt-CZ8AUcM02iMJrnzGo_6QI4P2zDKRFQARCbeqiOCs,1385
+livekit_plugins_clova-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+livekit_plugins_clova-1.0.0.dist-info/RECORD,,

livekit_plugins_clova-1.0.0.dist-info/WHEEL

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