livekit-plugins-groq 0.1.1__py3-none-any.whl

livekit/plugins/groq/__init__.py

@@ -0,0 +1,30 @@
+# 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 livekit.agents import Plugin
+
+from .log import logger
+from .services import LLM, STT
+from .tts import TTS
+from .version import __version__
+
+__all__ = ["TTS", "LLM", "STT", "__version__"]
+
+
+class GroqPlugin(Plugin):
+    def __init__(self):
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(GroqPlugin())

livekit/plugins/groq/log.py

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

livekit/plugins/groq/models.py

@@ -0,0 +1,54 @@
+from typing import Literal
+
+# listing production models from https://console.groq.com/docs/models
+
+STTModels = Literal[
+    "whisper-large-v3",
+    "whisper-large-v3-turbo",
+    "distil-whisper-large-v3-en",
+]
+
+LLMModels = Literal[
+    "llama3-8b-8192",
+    "llama3-70b-8192",
+    "llama-guard-3-8b",
+    "llama-3.1-8b-instant",
+    "llama-3.3-70b-versatile",
+]
+
+TTSModels = Literal[
+    "playai-tts",
+    "playai-tts-arabic",
+]
+
+TTSVoices = Literal[
+    "Aaliyah-PlayAI",
+    "Abigail-PlayAI",
+    "Angelo-PlayAI",
+    "Arthur-PlayAI",
+    "Aurora-PlayAI",
+    "Autumn-PlayAI",
+    "Ayla-Meditation-PlayAI",
+    "Ayla-Advertising-PlayAI",
+    "Bryan-PlayAI",
+    "Chuck-PlayAI",
+    "Darrell-PlayAI",
+    "Dexter-PlayAI",
+    "Donovan-PlayAI",
+    "Eileen-PlayAI",
+    "Eleanor-PlayAI",
+    "Erasmo-PlayAI",
+    "Hudson-PlayAI",
+    "Inara-PlayAI",
+    "Luna-PlayAI",
+    "Nia-PlayAI",
+    "Phoebe-PlayAI",
+    "Ranger-PlayAI",
+    "Sophia-PlayAI",
+    "Waylon-PlayAI",
+    "William-Training-PlayAI",
+    "Nasser-PlayAI",
+    "Khalid-PlayAI",
+    "Amira-PlayAI",
+    "Ahmad-PlayAI",
+]

livekit/plugins/groq/services.py

@@ -0,0 +1,80 @@
+import os
+from typing import Literal, Union
+
+import openai
+from livekit.agents.llm import ToolChoice
+from livekit.plugins.openai import LLM as OpenAILLM
+from livekit.plugins.openai import STT as OpenAISTT
+
+from .models import LLMModels, STTModels
+
+
+class LLM(OpenAILLM):
+    def __init__(
+        self,
+        *,
+        model: str | LLMModels = "llama-3.3-70b-versatile",
+        api_key: str | None = None,
+        user: str | None = None,
+        temperature: float | None = None,
+        parallel_tool_calls: bool | None = None,
+        tool_choice: Union[ToolChoice, Literal["auto", "required", "none"]] = "auto",
+        max_tokens: int | None = None,
+        base_url: str | None = "https://api.groq.com/openai/v1",
+        client: openai.AsyncClient | None = None,
+    ):
+        """
+        Create a new instance of Groq LLM.
+
+        ``api_key`` must be set to your Groq API key, either using the argument or by setting
+        the ``GROQ_API_KEY`` environmental variable.
+        """
+        super().__init__(
+            model=model,
+            api_key=_get_api_key(api_key),
+            base_url=base_url,
+            client=client,
+            user=user,
+            temperature=temperature,
+            parallel_tool_calls=parallel_tool_calls,
+            tool_choice=tool_choice,
+            max_tokens=max_tokens,
+        )
+
+
+class STT(OpenAISTT):
+    def __init__(
+        self,
+        *,
+        model: STTModels | str = "whisper-large-v3-turbo",
+        api_key: str | None = None,
+        base_url: str | None = "https://api.groq.com/openai/v1",
+        client: openai.AsyncClient | None = None,
+        language: str = "en",
+        prompt: str | None = None,
+        detect_language: bool = False,
+    ):
+        """
+        Create a new instance of Groq STT.
+
+        ``api_key`` must be set to your Groq API key, either using the argument or by setting
+        the ``GROQ_API_KEY`` environmental variable.
+        """
+        super().__init__(
+            model=model,
+            api_key=_get_api_key(api_key),
+            base_url=base_url,
+            client=client,
+            language=language,
+            detect_language=detect_language,
+            prompt=prompt,
+        )
+
+
+def _get_api_key(key: str | None) -> str:
+    key = key or os.environ.get("GROQ_API_KEY")
+    if not key:
+        raise ValueError(
+            "GROQ_API_KEY is required, either as argument or set GROQ_API_KEY environmental variable"
+        )
+    return key

livekit/plugins/groq/tts.py

@@ -0,0 +1,212 @@
+# 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 os
+from dataclasses import dataclass
+from typing import Optional
+
+import aiohttp
+from livekit.agents import (
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+    APITimeoutError,
+    tts,
+    utils,
+)
+
+from .log import logger
+from .models import TTSModels, TTSVoices
+
+DEFAULT_BASE_URL = "https://api.groq.com/openai/v1"
+SAMPLE_RATE = 48000
+NUM_CHANNELS = 1
+
+
+@dataclass
+class _TTSOptions:
+    model: TTSModels | str
+    voice: TTSVoices | str
+    api_key: str
+    base_url: str
+
+
+class TTS(tts.TTS):
+    def __init__(
+        self,
+        *,
+        base_url: str | None = None,
+        model: TTSModels | str = "playai-tts",
+        voice: TTSVoices | str = "Eileen-PlayAI",
+        api_key: str | None = None,
+        http_session: aiohttp.ClientSession | None = None,
+    ) -> None:
+        """
+        Create a new instance of Groq TTS.
+
+        if `api_key` is not provided, it will be read from the ``GROQ_API_KEY``
+        environmental variable.
+
+        Args:
+            model (SpeechModels | str, optional): Model to use. Default is "playai-tts".
+            voice (SpeechVoices | str, optional): Voice to use. Default is "Autumn-PlayAI".
+            api_key (str | None, optional): API key to use. Default is None.
+        """
+
+        super().__init__(
+            capabilities=tts.TTSCapabilities(
+                streaming=False,
+            ),
+            sample_rate=SAMPLE_RATE,
+            num_channels=1,
+        )
+
+        self._session = http_session
+
+        if not base_url:
+            base_url = DEFAULT_BASE_URL
+
+        if not api_key:
+            api_key = os.getenv("GROQ_API_KEY")
+            if not api_key:
+                raise ValueError("GROQ_API_KEY is not set")
+
+        self._opts = _TTSOptions(
+            model=model,
+            voice=voice,
+            api_key=api_key,
+            base_url=base_url,
+        )
+
+    def _ensure_session(self) -> aiohttp.ClientSession:
+        if not self._session:
+            self._session = utils.http_context.http_session()
+
+        return self._session
+
+    def update_options(
+        self,
+        *,
+        model: TTSModels | None = None,
+        voice: TTSVoices | None = None,
+    ) -> None:
+        """
+        Update the TTS options.
+
+        Args:
+            model (SpeechModels | str, optional): Model to use. Default is None.
+            voice (SpeechVoices | str, optional): Voice to use. Default is None.
+        """
+        if model:
+            self._opts.model = model
+        if voice:
+            self._opts.voice = voice
+
+    def synthesize(
+        self,
+        text: str,
+        *,
+        conn_options: Optional[APIConnectOptions] = None,
+        segment_id: str | None = None,
+    ) -> "ChunkedStream":
+        return ChunkedStream(
+            tts=self,
+            input_text=text,
+            conn_options=conn_options,
+            opts=self._opts,
+            session=self._ensure_session(),
+            segment_id=segment_id,
+        )
+
+
+class ChunkedStream(tts.ChunkedStream):
+    def __init__(
+        self,
+        *,
+        tts: TTS,
+        input_text: str,
+        conn_options: Optional[APIConnectOptions] = None,
+        opts: _TTSOptions,
+        session: aiohttp.ClientSession,
+        segment_id: str | None = None,
+    ) -> None:
+        super().__init__(tts=tts, input_text=input_text, conn_options=conn_options)
+        self._opts = opts
+        self._session = session
+        self._segment_id = segment_id
+
+    async def _run(self) -> None:
+        request_id = utils.shortuuid()
+        headers = {
+            "Authorization": f"Bearer {self._opts.api_key}",
+            "Content-Type": "application/json",
+        }
+        payload = {
+            "model": self._opts.model,
+            "voice": self._opts.voice,
+            "input": self._input_text,
+            "response_format": "wav",
+        }
+
+        decoder = utils.codecs.AudioStreamDecoder(
+            sample_rate=SAMPLE_RATE,
+            num_channels=NUM_CHANNELS,
+        )
+
+        decode_task: Optional[asyncio.Task] = None
+        api_url = f"{self._opts.base_url}/audio/speech"
+        try:
+            async with self._session.post(
+                api_url, headers=headers, json=payload
+            ) as response:
+                if not response.content_type.startswith("audio"):
+                    content = await response.text()
+                    logger.error("Groq returned non-audio data: %s", content)
+                    return
+
+                async def _decode_loop():
+                    try:
+                        async for bytes_data, _ in response.content.iter_chunks():
+                            decoder.push(bytes_data)
+                    finally:
+                        decoder.end_input()
+
+                decode_task = asyncio.create_task(_decode_loop())
+                emitter = tts.SynthesizedAudioEmitter(
+                    event_ch=self._event_ch,
+                    request_id=request_id,
+                    segment_id=self._segment_id,
+                )
+                async for frame in decoder:
+                    emitter.push(frame)
+                emitter.flush()
+
+        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=request_id,
+                body=None,
+            ) from e
+        except Exception as e:
+            raise APIConnectionError() from e
+        finally:
+            if decode_task:
+                await utils.aio.gracefully_cancel(decode_task)
+            await decoder.aclose()

livekit/plugins/groq/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__ = "0.1.1"

livekit_plugins_groq-0.1.1.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-groq
+Version: 0.1.1
+Summary: Groq inference plugin for LiveKit
+Home-page: https://github.com/livekit/agents
+License: Apache-2.0
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://livekit.io/
+Project-URL: Source, https://github.com/livekit/agents
+Keywords: groq,llm,stt,tts,webrtc,livekit
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9.0
+Description-Content-Type: text/markdown
+Requires-Dist: livekit-agents<1.0.0,>=0.12.16
+Requires-Dist: livekit-plugins-openai<1.0.0,>=0.11.2
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# LiveKit Plugins Groq
+
+Agent Framework plugin for services from Groq. Currently supporting STT, and LLM
+
+## Installation
+
+```bash
+pip install livekit-plugins-groq
+```
+
+## Pre-requisites
+
+For credentials, you'll need a Groq Cloud account and obtain the correct credentials. Credentials can be passed directly or via GROQ_API_KEY environment variable

livekit_plugins_groq-0.1.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+livekit/plugins/groq/__init__.py,sha256=3FCdFGFsZtZnoWLJfPQPh8tzt44chzmrpXzCckIldGg,930
+livekit/plugins/groq/log.py,sha256=nCRNT6C52cMuAbBzdH15Fz933CLPZNkSZ1JPJyVdI1Y,67
+livekit/plugins/groq/models.py,sha256=TyU9m3NrdtZi7UxgiKPgNGiZIsJiJQLdtbZkQEqzDAU,1086
+livekit/plugins/groq/services.py,sha256=5vZv9E8UkrGpFyI5oFcddfks38MHpfTHm5VmIbvQEqA,2472
+livekit/plugins/groq/tts.py,sha256=ZKNox2WI3PzPGS0HFtcIHSz4oLEx4F45udtC-fL6vBE,6315
+livekit/plugins/groq/version.py,sha256=IK31lfqSqfmET1Eqg7jx5fIpK4f_5uvSS80S-StV7zA,599
+livekit_plugins_groq-0.1.1.dist-info/METADATA,sha256=T2tTOhRl5PDp5aJ2ybdgp2s5yyKaaw-ap5cUojAhkeM,1564
+livekit_plugins_groq-0.1.1.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+livekit_plugins_groq-0.1.1.dist-info/top_level.txt,sha256=OoDok3xUmXbZRvOrfvvXB-Juu4DX79dlq188E19YHoo,8
+livekit_plugins_groq-0.1.1.dist-info/RECORD,,

livekit_plugins_groq-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (77.0.3)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

livekit_plugins_groq-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+livekit