pipecat-respeecher 0.1.0__tar.gz

pipecat_respeecher-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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
+
+# 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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

pipecat_respeecher-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

pipecat_respeecher-0.1.0/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2024–2025, Daily
+Copyright (c) 2025, Respeecher
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pipecat_respeecher-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: pipecat-respeecher
+Version: 0.1.0
+Summary: Respeecher real-time TTS plugin for Pipecat
+Author-email: Respeecher <nv@respeecher.com>
+Maintainer-email: Respeecher <nv@respeecher.com>
+License-Expression: BSD-2-Clause
+Project-URL: homepage, https://www.respeecher.com/real-time-tts-api
+Project-URL: documentation, https://space.respeecher.com/docs
+Project-URL: source, https://github.com/respeecher/pipecat-respeecher
+Keywords: tts,pipecat-ai,pipecat
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pipecat-ai>=0.0.99
+Requires-Dist: respeecher>=1.1.9
+Dynamic: license-file
+
+# Pipecat Respeecher Real-Time TTS Integration
+
+This is an official Respeecher integration for [Pipecat](https://pipecat.ai).
+
+[Learn more](https://www.respeecher.com/real-time-tts-api) about our real-time TTS API
+([Україномовна/Ukrainian TTS](https://www.respeecher.com/uk/real-time-tts-api)).
+
+**Maintainer: [Respeecher](https://www.respeecher.com/)**
+
+## Installation
+
+To be published.
+
+## Running the Example
+
+[`example.py`](./example.py) is a complete Pipecat pipeline with Respeecher TTS.
+(See [`example-ukrainian.py`](./example-ukrainian.py) for a Ukrainian language pipeline.)
+You can use it as a starting point for your agent,
+or you can head over to [Example Snippets](#example-snippets)
+if you already have a pipeline and just want to switch TTS.
+
+The complete pipeline example requires a
+[Deepgram](https://docs.pipecat.ai/server/services/stt/deepgram) API key for
+Speech-to-Text, either a [Google Gemini](https://docs.pipecat.ai/server/services/llm/gemini)
+API key or a [Cerebras](https://docs.pipecat.ai/server/services/llm/cerebras) API key for LLM,
+and a [Respeecher Space](https://space.respeecher.com/api-keys) API key.
+The Speech-to-Text and LLM services are just an example and can generally be swapped for any
+other [supported Pipecat service](https://docs.pipecat.ai/server/services/supported-services).
+
+1. Clone this repository.
+2. Copy `env.example` to `.env` and fill in your API keys.
+3. Assuming you have the [uv](https://docs.astral.sh/uv/getting-started/installation/)
+   Python package manager installed, run `uv run example.py`, head over to
+   http://localhost:7860, and click _Connect_.
+   (The first run of `uv run example.py` may be slow because uv installs packages
+   and Pipecat downloads local models.)
+   The agent should greet you (both in text and in speech),
+   and you can converse with it through the chat interface or with your microphone.
+   (Make sure you have granted microphone access to the web page and that the microphone button
+   is not in the muted state.)
+
+## Example Snippets
+
+### Minimal Example
+
+```python
+from pipecat_respeecher import RespeecherTTSService
+
+tts = RespeecherTTSService(
+    api_key=os.getenv("RESPEECHER_API_KEY"),
+    voice_id="samantha",
+)
+```
+
+### Overriding Sampling Parameters
+
+See the [Sampling Parameters Guide](https://space.respeecher.com/docs/api/tts/sampling-params-guide).
+
+```python
+from pipecat_respeecher import RespeecherTTSService
+
+tts = RespeecherTTSService(
+    api_key=os.getenv("RESPEECHER_API_KEY"),
+    voice_id="samantha",
+    params=RespeecherTTSService.InputParams(
+        sampling_params={
+            "min_p": 0.01,
+        },
+    ),
+)
+```
+
+### Ukrainian Language Model
+
+See [Models & Languages](https://space.respeecher.com/docs/models-and-languages).
+
+```python
+from pipecat_respeecher import RespeecherTTSService
+
+tts = RespeecherTTSService(
+    api_key=os.getenv("RESPEECHER_API_KEY"),
+    model="public/tts/ua-rt",
+    voice_id="olesia-conversation",
+)
+```

pipecat_respeecher-0.1.0/README.md

@@ -0,0 +1,85 @@
+# Pipecat Respeecher Real-Time TTS Integration
+
+This is an official Respeecher integration for [Pipecat](https://pipecat.ai).
+
+[Learn more](https://www.respeecher.com/real-time-tts-api) about our real-time TTS API
+([Україномовна/Ukrainian TTS](https://www.respeecher.com/uk/real-time-tts-api)).
+
+**Maintainer: [Respeecher](https://www.respeecher.com/)**
+
+## Installation
+
+To be published.
+
+## Running the Example
+
+[`example.py`](./example.py) is a complete Pipecat pipeline with Respeecher TTS.
+(See [`example-ukrainian.py`](./example-ukrainian.py) for a Ukrainian language pipeline.)
+You can use it as a starting point for your agent,
+or you can head over to [Example Snippets](#example-snippets)
+if you already have a pipeline and just want to switch TTS.
+
+The complete pipeline example requires a
+[Deepgram](https://docs.pipecat.ai/server/services/stt/deepgram) API key for
+Speech-to-Text, either a [Google Gemini](https://docs.pipecat.ai/server/services/llm/gemini)
+API key or a [Cerebras](https://docs.pipecat.ai/server/services/llm/cerebras) API key for LLM,
+and a [Respeecher Space](https://space.respeecher.com/api-keys) API key.
+The Speech-to-Text and LLM services are just an example and can generally be swapped for any
+other [supported Pipecat service](https://docs.pipecat.ai/server/services/supported-services).
+
+1. Clone this repository.
+2. Copy `env.example` to `.env` and fill in your API keys.
+3. Assuming you have the [uv](https://docs.astral.sh/uv/getting-started/installation/)
+   Python package manager installed, run `uv run example.py`, head over to
+   http://localhost:7860, and click _Connect_.
+   (The first run of `uv run example.py` may be slow because uv installs packages
+   and Pipecat downloads local models.)
+   The agent should greet you (both in text and in speech),
+   and you can converse with it through the chat interface or with your microphone.
+   (Make sure you have granted microphone access to the web page and that the microphone button
+   is not in the muted state.)
+
+## Example Snippets
+
+### Minimal Example
+
+```python
+from pipecat_respeecher import RespeecherTTSService
+
+tts = RespeecherTTSService(
+    api_key=os.getenv("RESPEECHER_API_KEY"),
+    voice_id="samantha",
+)
+```
+
+### Overriding Sampling Parameters
+
+See the [Sampling Parameters Guide](https://space.respeecher.com/docs/api/tts/sampling-params-guide).
+
+```python
+from pipecat_respeecher import RespeecherTTSService
+
+tts = RespeecherTTSService(
+    api_key=os.getenv("RESPEECHER_API_KEY"),
+    voice_id="samantha",
+    params=RespeecherTTSService.InputParams(
+        sampling_params={
+            "min_p": 0.01,
+        },
+    ),
+)
+```
+
+### Ukrainian Language Model
+
+See [Models & Languages](https://space.respeecher.com/docs/models-and-languages).
+
+```python
+from pipecat_respeecher import RespeecherTTSService
+
+tts = RespeecherTTSService(
+    api_key=os.getenv("RESPEECHER_API_KEY"),
+    model="public/tts/ua-rt",
+    voice_id="olesia-conversation",
+)
+```

pipecat_respeecher-0.1.0/env.example

@@ -0,0 +1,6 @@
+DEEPGRAM_API_KEY=your-api-key
+RESPEECHER_API_KEY=your-api-key
+
+# Provide either one
+GOOGLE_API_KEY=your-api-key
+# CEREBRAS_API_KEY=your-api-key

pipecat_respeecher-0.1.0/example-ukrainian.py

@@ -0,0 +1,198 @@
+#
+# Copyright (c) 2024–2025, Daily
+# Copyright (c) 2025, Respeecher
+#
+# SPDX-License-Identifier: BSD 2-Clause License
+#
+
+"""Respeecher Quickstart Example.
+
+The example runs a simple voice AI bot that you can connect to using your
+browser and speak with it. You can also deploy this bot to Pipecat Cloud.
+
+Required AI services:
+- Deepgram (Speech-to-Text)
+- Google or Cerebras (LLM)
+- Respeecher (Text-to-Speech)
+
+Run the bot using::
+
+    uv run bot.py
+"""
+
+import os
+
+from dotenv import load_dotenv
+from loguru import logger
+
+print("🚀 Starting Pipecat bot...")
+print("⏳ Loading models and imports (20 seconds, first run only)\n")
+
+logger.info("Loading Local Smart Turn Analyzer V3...")
+from pipecat.audio.turn.smart_turn.local_smart_turn_v3 import LocalSmartTurnAnalyzerV3
+
+logger.info("✅ Local Smart Turn Analyzer V3 loaded")
+logger.info("Loading Silero VAD model...")
+from pipecat.audio.vad.silero import SileroVADAnalyzer
+
+logger.info("✅ Silero VAD model loaded")
+
+from pipecat.audio.vad.vad_analyzer import VADParams
+from pipecat.frames.frames import LLMRunFrame
+
+logger.info("Loading pipeline components...")
+from pipecat.pipeline.pipeline import Pipeline
+from pipecat.pipeline.runner import PipelineRunner
+from pipecat.pipeline.task import PipelineParams, PipelineTask
+from pipecat.processors.aggregators.llm_context import LLMContext
+from pipecat.processors.aggregators.llm_response_universal import (
+    LLMContextAggregatorPair,
+    LLMUserAggregatorParams,
+)
+from pipecat.processors.frameworks.rtvi import RTVIConfig, RTVIObserver, RTVIProcessor
+from pipecat.runner.types import RunnerArguments
+from pipecat.runner.utils import create_transport
+from pipecat.transcriptions.language import Language
+from pipecat.services.deepgram.stt import DeepgramSTTService, LiveOptions
+from pipecat.services.cerebras.llm import CerebrasLLMService
+from pipecat.services.google.llm import GoogleLLMService
+from pipecat.transports.base_transport import BaseTransport, TransportParams
+from pipecat.transports.daily.transport import DailyParams
+from pipecat.turns.user_stop.turn_analyzer_user_turn_stop_strategy import (
+    TurnAnalyzerUserTurnStopStrategy,
+)
+from pipecat.turns.user_turn_strategies import UserTurnStrategies
+from pipecat_respeecher import RespeecherTTSService
+from pipecat_whisker import WhiskerObserver
+
+logger.info("✅ All components loaded successfully!")
+
+load_dotenv(override=True)
+
+
+async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
+    logger.info("Starting bot")
+
+    stt = DeepgramSTTService(
+        api_key=os.getenv("DEEPGRAM_API_KEY"),
+        live_options=LiveOptions(language=Language.UK),
+    )
+
+    tts = RespeecherTTSService(
+        api_key=os.getenv("RESPEECHER_API_KEY"),
+        voice_id="olesia-conversation",
+        model="public/tts/ua-rt",
+        # [Optional] Sampling parameters overrides.
+        # Can be changed on the fly with TTSUpdateSettingsFrame,
+        # just like the model and the voice.
+        params=RespeecherTTSService.InputParams(
+            sampling_params={
+                "min_p": 0.01,
+            },
+        ),
+    )
+
+    cerebras_api_key = os.getenv("CEREBRAS_API_KEY")
+    google_api_key = os.getenv("GOOGLE_API_KEY")
+
+    if cerebras_api_key:
+        llm = CerebrasLLMService(api_key=cerebras_api_key, model="llama3.1-8b")
+    elif google_api_key:
+        llm = GoogleLLMService(api_key=google_api_key)
+    else:
+        raise ValueError("Neither Google nor Cerebras API key is provided")
+
+    messages = [
+        {
+            "role": "system",
+            "content": "Ти дружній ШІ асистент, що розмовляє українською. Відповідай привітно та підтримуй розмову. Не використовуй емодзі та спеціальні символи у своїх відповідях. Ти жіночого роду.",
+        },
+    ]
+
+    context = LLMContext(messages)
+    context_aggregator = LLMContextAggregatorPair(
+        context,
+        user_params=LLMUserAggregatorParams(
+            user_turn_strategies=UserTurnStrategies(
+                stop=[
+                    TurnAnalyzerUserTurnStopStrategy(
+                        turn_analyzer=LocalSmartTurnAnalyzerV3()
+                    )
+                ]
+            ),
+        ),
+    )
+
+    # [Optional] Without RTVI, the chat interface in the WebRTC demo page won't work.
+    rtvi = RTVIProcessor(config=RTVIConfig(config=[]))
+
+    pipeline = Pipeline(
+        [
+            transport.input(),  # Transport user input
+            rtvi,
+            stt,
+            context_aggregator.user(),  # User responses
+            llm,  # LLM
+            tts,  # TTS
+            transport.output(),  # Transport bot output
+            context_aggregator.assistant(),  # Assistant spoken responses
+        ]
+    )
+
+    # [Optional] Whisker is a Pipecat debugger/visualizer.
+    # https://github.com/pipecat-ai/whisker
+    whisker = WhiskerObserver(pipeline)
+
+    task = PipelineTask(
+        pipeline,
+        params=PipelineParams(
+            enable_metrics=True,
+            enable_usage_metrics=True,
+        ),
+        idle_timeout_secs=runner_args.pipeline_idle_timeout_secs,
+        observers=[RTVIObserver(rtvi), whisker],
+    )
+
+    @transport.event_handler("on_client_connected")
+    async def on_client_connected(transport, client):
+        logger.info("Client connected")
+        messages.append(
+            {"role": "system", "content": "Привітайся та коротко розкажи про себе."}
+        )
+        await task.queue_frames([LLMRunFrame()])
+
+    @transport.event_handler("on_client_disconnected")
+    async def on_client_disconnected(transport, client):
+        logger.info("Client disconnected")
+        await task.cancel()
+
+    runner = PipelineRunner(handle_sigint=runner_args.handle_sigint)
+
+    await runner.run(task)
+
+
+async def bot(runner_args: RunnerArguments):
+    """Main bot entry point for the bot starter."""
+
+    transport_params = {
+        "daily": lambda: DailyParams(
+            audio_in_enabled=True,
+            audio_out_enabled=True,
+            vad_analyzer=SileroVADAnalyzer(params=VADParams(stop_secs=0.2)),
+        ),
+        "webrtc": lambda: TransportParams(
+            audio_in_enabled=True,
+            audio_out_enabled=True,
+            vad_analyzer=SileroVADAnalyzer(params=VADParams(stop_secs=0.2)),
+        ),
+    }
+
+    transport = await create_transport(runner_args, transport_params)
+
+    await run_bot(transport, runner_args)
+
+
+if __name__ == "__main__":
+    from pipecat.runner.run import main
+
+    main()