sinapsis-speech 0.1.0__tar.gz → 0.2.0__tar.gz

{sinapsis_speech-0.1.0 → sinapsis_speech-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sinapsis-speech
-Version: 0.1.0
+Version: 0.2.0
 Summary: Generate speech using various libraries.
 Author-email: SinapsisAI <dev@sinapsis-ai.com>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -666,25 +666,20 @@ License:                     GNU AFFERO GENERAL PUBLIC LICENSE
         <https://www.gnu.org/licenses/>.
         
 Project-URL: Homepage, https://sinapsis.tech
-Project-URL: Documentation, https://docs.sinapsis.tech/docs
+Project-URL: Documentation, https://docs.sinapsis.tech/docs/sinapsis-speech
 Project-URL: Tutorials, https://docs.sinapsis.tech/tutorials
 Project-URL: Repository, https://github.com/Sinapsis-AI/sinapsis-speech.git
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-License-File: LICENSE
 Requires-Dist: pip>=24.3.1
-Requires-Dist: sinapsis>=0.1.1
-Provides-Extra: elevenlabs-app
-Requires-Dist: sinapsis-elevenlabs; extra == "elevenlabs-app"
-Requires-Dist: sinapsis-speech[gradio-app]; extra == "elevenlabs-app"
-Provides-Extra: gradio-app
-Requires-Dist: gradio>=5.14.0; extra == "gradio-app"
-Requires-Dist: sinapsis-data-readers>=0.1.0; extra == "gradio-app"
+Requires-Dist: sinapsis>=0.2.2
 Provides-Extra: all
-Requires-Dist: sinapsis-elevenlabs; extra == "all"
-Requires-Dist: sinapsis-speech[gradio-app]; extra == "all"
-Requires-Dist: sinapsis-speech[elevenlabs-app]; extra == "all"
-Dynamic: license-file
+Requires-Dist: sinapsis-elevenlabs[all]; extra == "all"
+Requires-Dist: sinapsis-f5-tts[all]; extra == "all"
+Requires-Dist: sinapsis-speech[webapp]; extra == "all"
+Requires-Dist: sinapsis-zonos[all]; extra == "all"
+Provides-Extra: gradio-app
+Requires-Dist: sinapsis[webapp]>=0.2.3; extra == "gradio-app"
 
 <h1 align="center">
 <br>
@@ -702,7 +697,7 @@ Sinapsis Speech
 <p align="center">
 <a href="#installation">🐍 Installation</a> •
 <a href="#packages">📦 Packages</a> •
-<a href="#webapp">🌐 Webapp</a> •
+<a href="#webapp">🌐 Webapps</a> •
 <a href="#documentation">📙 Documentation</a> •
 <a href="#packages">🔍 License</a>
 </p>
@@ -715,47 +710,93 @@ Sinapsis Speech
 > Sinapsis projects requires Python 3.10 or higher.
 >
 
-We strongly encourage the use of <code>uv</code>, although any other package manager should work too.
-If you need to install <code>uv</code> please see the [official documentation](https://docs.astral.sh/uv/getting-started/installation/#installation-methods).
+This repo includes packages for performing speech synthesis using different tools:
 
+* <code>sinapsis-elevenlabs</code>
+* <code>sinapsis-f5-tts</code>
+* <code>sinapsis-zonos</code>
 
-1. Install using your favourite package manager.
+Install using your preferred package manager. We strongly recommend using <code>uv</code>. To install <code>uv</code>, refer to the [official documentation](https://docs.astral.sh/uv/getting-started/installation/#installation-methods).
 
-Example with <code>uv</code>:
+
+Install with <code>uv</code>:
 ```bash
-  uv pip install sinapsis-elevenlabs --extra-index-url https://pypi.sinapsis.tech
+uv pip install sinapsis-elevenlabs --extra-index-url https://pypi.sinapsis.tech
 ```
- or with raw <code>pip</code>:
+Or with raw <code>pip</code>:
 ```bash
-  pip install sinapsis-elevenlabs --extra-index-url https://pypi.sinapsis.tech
+pip install sinapsis-elevenlabs --extra-index-url https://pypi.sinapsis.tech
 ```
-**Change the name of the package for the one you want to install**.
+
+**Replace `sinapsis-elevenlabs` with the name of the package you intend to install**.
+
+> [!IMPORTANT]
+> Templates in each package may require additional dependencies. For development, we recommend installing the package all optional dependencies:
+>
+With <code>uv</code>:
+
+```bash
+uv pip install sinapsis-elevenlabs[all] --extra-index-url https://pypi.sinapsis.tech
+```
+Or with raw <code>pip</code>:
+```bash
+pip install sinapsis-elevenlabs[all] --extra-index-url https://pypi.sinapsis.tech
+```
+
+**Be sure to substitute `sinapsis-elevenlabs` with the appropriate package name**.
+
+
 
 > [!TIP]
 > You can also install all the packages within this project:
 >
 ```bash
-  uv pip install sinapsis-speech[all] --extra-index-url https://pypi.sinapsis.tech
+uv pip install sinapsis-speech[all] --extra-index-url https://pypi.sinapsis.tech
 ```
 
 
 <h2 id="packages">📦 Packages</h2>
 
-Each package can be used independently or combined to create more complex workflows. Below is an overview of the available packages:
+This repository is organized into modular packages, each designed for integration with different text-to-speech tools. These packages provide ready-to-use templates for speech synthesis. Below is an overview of the available packages:
 
 <details>
-<summary id="elevenlabs"><strong><span style="font-size: 1.4em;"> Elevenlabs </span></strong></summary>
+<summary id="elevenlabs"><strong><span style="font-size: 1.4em;"> Sinapsis ElevenLabs </span></strong></summary>
+
+This package offers a suite of templates and utilities designed for effortless integrating, configuration, and execution of **text-to-speech (TTS)** and **voice generation** functionalities powered by [ElevenLabs](https://elevenlabs.io/).
 
-This package provides a suite of templates and utilities for seamlessly integrating, configuring, and running **text-to-speech (TTS)** and **voice generation** functionalities powered by [ElevenLabs](https://elevenlabs.io/):
+- **ElevenLabsTTS**: Template for converting text into speech using ElevenLabs' voice models.
 
-- **Text-to-speech**: Template for converting text into speech using ElevenLabs' voice models.
+- **ElevenLabsVoiceGeneration**: Template for generating custom synthetic voices based on user-provided descriptions.
 
-- **Voice generation**: Template for generating custom synthetic voices based on user-provided descriptions.
+For specific instructions and further details, see the [README.md](https://github.com/Sinapsis-AI/sinapsis-speech/blob/main/packages/sinapsis_elevenlabs/README.md).
 
 </details>
-<h2 id="webapps">🌐 Webapps</h2>
-The webapps included in this project showcase the modularity of the templates, in this case
-for speech generation tasks.
+
+
+<details>
+<summary id="f5tts"><strong><span style="font-size: 1.4em;"> Sinapsis F5-TTS</span></strong></summary>
+
+This package provides a template for seamlessly integrating, configuring, and running **text-to-speech (TTS)** functionalities powered by [F5TTS](https://github.com/SWivid/F5-TTS).
+
+- **F5TTSInference**: Converts text to speech using the F5TTS model with voice cloning capabilities.
+
+For specific instructions and further details, see the [README.md](https://github.com/Sinapsis-AI/sinapsis-speech/blob/main/packages/sinapsis_f5_tts/README.md).
+
+</details>
+
+<details>
+<summary id="zonos"><strong><span style="font-size: 1.4em;"> Sinapsis Zonos</span></strong></summary>
+
+This package provides a single template for integrating, configuring, and running **text-to-speech (TTS)** and **voice cloning** functionalities powered by [Zonos](https://github.com/Zyphra/Zonos/tree/main).
+
+- **ZonosTTS**: Template for converting text to speech or performing voice cloning based on the presence of an audio sample.​
+
+For specific instructions and further details, see the [README.md](https://github.com/Sinapsis-AI/sinapsis-speech/blob/main/packages/sinapsis_zonos/README.md).
+
+</details>
+
+<h2 id="webapp">🌐 Webapps</h2>
+The webapps included in this project showcase the modularity of the templates, in this case for speech generation tasks.
 
 > [!IMPORTANT]
 > To run the app you first need to clone this repository:
@@ -768,89 +809,102 @@ cd sinapsis-speech
 > [!NOTE]
 > If you'd like to enable external app sharing in Gradio, `export GRADIO_SHARE_APP=True`
 
-> [!IMPORTANT]
-> The CosyVoice model requires at least 4GB of ram to work.
 
 > [!IMPORTANT]
-> Elevenlabs requires an api key to run any inference. Please go to the [official website](https://elevenlabs.io), create an account.
-If you already have an account, go to the [token page](https://elevenlabs.io/app/settings/api-keys) and generate a token.
+> Elevenlabs requires an API key to run any inference. To get started, visit the [official website](https://elevenlabs.io) and create an account. If you already have an account, go to the [API keys page](https://elevenlabs.io/app/settings/api-keys) to generate a token.
 
 > [!IMPORTANT]
-> set your env var using <code> export ELEVENLABS_API_KEY='your-api-key'</code>
+> Set your env var using <code> export ELEVENLABS_API_KEY='your-api-key'</code>
 
+> [!IMPORTANT]
+> F5-TTS requires a reference audio file for voice cloning. Make sure you have a reference audio file in the artifacts directory.
 
-> [!TIP]
-> The agent configuration can be updated using the AGENT_CONFIG_PATH environment var.
+> [!NOTE]
+> Agent configuration can be changed through the `AGENT_CONFIG_PATH` env var. You can check the available configurations in each package configs folder.
 
 
 <details>
-<summary id="docker"><strong><span style="font-size: 1.4em;">🐳 Build with Docker</span></strong></summary>
+<summary id="docker"><strong><span style="font-size: 1.4em;">🐳 Docker</span></strong></summary>
 
-**IMPORTANT** This docker image depends on the sinapsis-nvidia:base image. Please refer to the official [sinapsis](https://github.com/Sinapsis-ai/sinapsis?tab=readme-ov-file#docker) instructions to Build with Docker.
+**IMPORTANT**: This Docker image depends on the `sinapsis-nvidia:base` image. For detailed instructions, please refer to the [Sinapsis README](https://github.com/Sinapsis-ai/sinapsis?tab=readme-ov-file#docker).
 
-1. **Build the Docker image**:
+1. **Build the sinapsis-speech image**:
 ```bash
 docker compose -f docker/compose.yaml build
 ```
 
-
-2. **Launch the service**:
+2. **Start the app container**:
+For ElevenLabs:
 ```bash
 docker compose -f docker/compose_apps.yaml up -d sinapsis-elevenlabs
 ```
+For F5-TTS:
+```bash
+docker compose -f docker/compose_apps.yaml up -d sinapsis-f5_tts
+```
+For Zonos:
+```bash
+docker compose -f docker/compose_apps.yaml up -d sinapsis-zonos
+```
 
-
-2. **Check the logs**
+3. **Check the logs**
+For ElevenLabs:
 ```bash
 docker logs -f sinapsis-elevenlabs
 ```
-3. **The logs will display the URL to access the webapp, e.g.,:**:
+For F5-TTS:
+```bash
+docker logs -f sinapsis-f5tts
+```
+For Zonos:
+```bash
+docker logs -f sinapsis-zonos
+```
+4. **The logs will display the URL to access the webapp, e.g.,:**:
 ```bash
 Running on local URL:  http://127.0.0.1:7860
 ```
-4. To stop the app:
+**NOTE**: The url may be different, check the output of logs.
+5. **To stop the app**:
 ```bash
-docker compose -f docker/compose_apps.yaml down sinapsis-elevenlabs
+docker compose -f docker/compose_apps.yaml down
 ```
 </details>
 
 <details>
 <summary id="virtual-environment"><strong><span style="font-size: 1.4em;">💻 UV</span></strong></summary>
 
+To run the webapp using the <code>uv</code> package manager, follow these steps:
 
 1. **Sync the virtual environment**:
 
 ```bash
 uv sync --frozen
 ```
-2. Install the wheel:
+2. **Install the wheel**:
 
 ```bash
 uv pip install sinapsis-speech[all] --extra-index-url https://pypi.sinapsis.tech
 ```
 
-
-3. **Activate the virtual environment**:
-
+3. **Run the webapp**:
+For ElevenLabs:
 ```bash
-source .venv/bin/activate
+uv run webapps/elevenlabs/elevenlabs_tts_app.py
 ```
-4. **Declare PYTHONPATH**
+For F5-TTS:
 ```bash
-export PYTHONPATH=$PWD/webapps 
+uv run webapps/f5-tts/f5_tts_app.py
 ```
-**NOTE** if not located in <code>sinapsis-speech</code> folder, change $PWD for the actual path to <code>sinapsis-speech</code>
-
-5. **Launch the demo**:
-
+For Zonos:
 ```bash
-python webapps/elevenlabs/elevenlabs_tts_app.py
+uv run webapps/zonos/zonos_tts_app.py
 ```
-6. Open the displayed URL, e.g.:
+4. **The terminal will display the URL to access the webapp (e.g.)**:
 ```bash
 Running on local URL:  http://127.0.0.1:7860
 ```
-**NOTE**: The URL can be different, please make sure you check the logs.
+**NOTE**: The URL may vary; check the terminal output for the correct address.
 
 </details>
 

sinapsis_speech-0.2.0/README.md

@@ -0,0 +1,243 @@
+<h1 align="center">
+<br>
+<a href="https://sinapsis.tech/">
+  <img
+    src="https://github.com/Sinapsis-AI/brand-resources/blob/main/sinapsis_logo/4x/logo.png?raw=true"
+    alt="" width="300">
+</a><br>
+Sinapsis Speech
+<br>
+</h1>
+
+<h4 align="center"> Templates for a wide range of voice generation tasks.</h4>
+
+<p align="center">
+<a href="#installation">🐍 Installation</a> •
+<a href="#packages">📦 Packages</a> •
+<a href="#webapp">🌐 Webapps</a> •
+<a href="#documentation">📙 Documentation</a> •
+<a href="#packages">🔍 License</a>
+</p>
+
+
+<h2 id="installation">🐍 Installation</h2>
+
+
+> [!IMPORTANT]
+> Sinapsis projects requires Python 3.10 or higher.
+>
+
+This repo includes packages for performing speech synthesis using different tools:
+
+* <code>sinapsis-elevenlabs</code>
+* <code>sinapsis-f5-tts</code>
+* <code>sinapsis-zonos</code>
+
+Install using your preferred package manager. We strongly recommend using <code>uv</code>. To install <code>uv</code>, refer to the [official documentation](https://docs.astral.sh/uv/getting-started/installation/#installation-methods).
+
+
+Install with <code>uv</code>:
+```bash
+uv pip install sinapsis-elevenlabs --extra-index-url https://pypi.sinapsis.tech
+```
+Or with raw <code>pip</code>:
+```bash
+pip install sinapsis-elevenlabs --extra-index-url https://pypi.sinapsis.tech
+```
+
+**Replace `sinapsis-elevenlabs` with the name of the package you intend to install**.
+
+> [!IMPORTANT]
+> Templates in each package may require additional dependencies. For development, we recommend installing the package all optional dependencies:
+>
+With <code>uv</code>:
+
+```bash
+uv pip install sinapsis-elevenlabs[all] --extra-index-url https://pypi.sinapsis.tech
+```
+Or with raw <code>pip</code>:
+```bash
+pip install sinapsis-elevenlabs[all] --extra-index-url https://pypi.sinapsis.tech
+```
+
+**Be sure to substitute `sinapsis-elevenlabs` with the appropriate package name**.
+
+
+
+> [!TIP]
+> You can also install all the packages within this project:
+>
+```bash
+uv pip install sinapsis-speech[all] --extra-index-url https://pypi.sinapsis.tech
+```
+
+
+<h2 id="packages">📦 Packages</h2>
+
+This repository is organized into modular packages, each designed for integration with different text-to-speech tools. These packages provide ready-to-use templates for speech synthesis. Below is an overview of the available packages:
+
+<details>
+<summary id="elevenlabs"><strong><span style="font-size: 1.4em;"> Sinapsis ElevenLabs </span></strong></summary>
+
+This package offers a suite of templates and utilities designed for effortless integrating, configuration, and execution of **text-to-speech (TTS)** and **voice generation** functionalities powered by [ElevenLabs](https://elevenlabs.io/).
+
+- **ElevenLabsTTS**: Template for converting text into speech using ElevenLabs' voice models.
+
+- **ElevenLabsVoiceGeneration**: Template for generating custom synthetic voices based on user-provided descriptions.
+
+For specific instructions and further details, see the [README.md](https://github.com/Sinapsis-AI/sinapsis-speech/blob/main/packages/sinapsis_elevenlabs/README.md).
+
+</details>
+
+
+<details>
+<summary id="f5tts"><strong><span style="font-size: 1.4em;"> Sinapsis F5-TTS</span></strong></summary>
+
+This package provides a template for seamlessly integrating, configuring, and running **text-to-speech (TTS)** functionalities powered by [F5TTS](https://github.com/SWivid/F5-TTS).
+
+- **F5TTSInference**: Converts text to speech using the F5TTS model with voice cloning capabilities.
+
+For specific instructions and further details, see the [README.md](https://github.com/Sinapsis-AI/sinapsis-speech/blob/main/packages/sinapsis_f5_tts/README.md).
+
+</details>
+
+<details>
+<summary id="zonos"><strong><span style="font-size: 1.4em;"> Sinapsis Zonos</span></strong></summary>
+
+This package provides a single template for integrating, configuring, and running **text-to-speech (TTS)** and **voice cloning** functionalities powered by [Zonos](https://github.com/Zyphra/Zonos/tree/main).
+
+- **ZonosTTS**: Template for converting text to speech or performing voice cloning based on the presence of an audio sample.​
+
+For specific instructions and further details, see the [README.md](https://github.com/Sinapsis-AI/sinapsis-speech/blob/main/packages/sinapsis_zonos/README.md).
+
+</details>
+
+<h2 id="webapp">🌐 Webapps</h2>
+The webapps included in this project showcase the modularity of the templates, in this case for speech generation tasks.
+
+> [!IMPORTANT]
+> To run the app you first need to clone this repository:
+
+```bash
+git clone git@github.com:Sinapsis-ai/sinapsis-speech.git
+cd sinapsis-speech
+```
+
+> [!NOTE]
+> If you'd like to enable external app sharing in Gradio, `export GRADIO_SHARE_APP=True`
+
+
+> [!IMPORTANT]
+> Elevenlabs requires an API key to run any inference. To get started, visit the [official website](https://elevenlabs.io) and create an account. If you already have an account, go to the [API keys page](https://elevenlabs.io/app/settings/api-keys) to generate a token.
+
+> [!IMPORTANT]
+> Set your env var using <code> export ELEVENLABS_API_KEY='your-api-key'</code>
+
+> [!IMPORTANT]
+> F5-TTS requires a reference audio file for voice cloning. Make sure you have a reference audio file in the artifacts directory.
+
+> [!NOTE]
+> Agent configuration can be changed through the `AGENT_CONFIG_PATH` env var. You can check the available configurations in each package configs folder.
+
+
+<details>
+<summary id="docker"><strong><span style="font-size: 1.4em;">🐳 Docker</span></strong></summary>
+
+**IMPORTANT**: This Docker image depends on the `sinapsis-nvidia:base` image. For detailed instructions, please refer to the [Sinapsis README](https://github.com/Sinapsis-ai/sinapsis?tab=readme-ov-file#docker).
+
+1. **Build the sinapsis-speech image**:
+```bash
+docker compose -f docker/compose.yaml build
+```
+
+2. **Start the app container**:
+For ElevenLabs:
+```bash
+docker compose -f docker/compose_apps.yaml up -d sinapsis-elevenlabs
+```
+For F5-TTS:
+```bash
+docker compose -f docker/compose_apps.yaml up -d sinapsis-f5_tts
+```
+For Zonos:
+```bash
+docker compose -f docker/compose_apps.yaml up -d sinapsis-zonos
+```
+
+3. **Check the logs**
+For ElevenLabs:
+```bash
+docker logs -f sinapsis-elevenlabs
+```
+For F5-TTS:
+```bash
+docker logs -f sinapsis-f5tts
+```
+For Zonos:
+```bash
+docker logs -f sinapsis-zonos
+```
+4. **The logs will display the URL to access the webapp, e.g.,:**:
+```bash
+Running on local URL:  http://127.0.0.1:7860
+```
+**NOTE**: The url may be different, check the output of logs.
+5. **To stop the app**:
+```bash
+docker compose -f docker/compose_apps.yaml down
+```
+</details>
+
+<details>
+<summary id="virtual-environment"><strong><span style="font-size: 1.4em;">💻 UV</span></strong></summary>
+
+To run the webapp using the <code>uv</code> package manager, follow these steps:
+
+1. **Sync the virtual environment**:
+
+```bash
+uv sync --frozen
+```
+2. **Install the wheel**:
+
+```bash
+uv pip install sinapsis-speech[all] --extra-index-url https://pypi.sinapsis.tech
+```
+
+3. **Run the webapp**:
+For ElevenLabs:
+```bash
+uv run webapps/elevenlabs/elevenlabs_tts_app.py
+```
+For F5-TTS:
+```bash
+uv run webapps/f5-tts/f5_tts_app.py
+```
+For Zonos:
+```bash
+uv run webapps/zonos/zonos_tts_app.py
+```
+4. **The terminal will display the URL to access the webapp (e.g.)**:
+```bash
+Running on local URL:  http://127.0.0.1:7860
+```
+**NOTE**: The URL may vary; check the terminal output for the correct address.
+
+</details>
+
+
+
+<h2 id="documentation">📙 Documentation</h2>
+
+Documentation is available on the [sinapsis website](https://docs.sinapsis.tech/docs)
+
+Tutorials for different projects within sinapsis are available at [sinapsis tutorials page](https://docs.sinapsis.tech/tutorials)
+
+<h2 id="license">🔍 License</h2>
+
+This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the [LICENSE](LICENSE) file.
+
+For commercial use, please refer to our [official Sinapsis website](https://sinapsis.tech) for information on obtaining a commercial license.
+
+
+

{sinapsis_speech-0.1.0 → sinapsis_speech-0.2.0}/packages/sinapsis_elevenlabs/src/sinapsis_elevenlabs/helpers/env_var_keys.py

@@ -12,7 +12,7 @@ class _ElevenlabsKeys(BaseModel):
 
     ELEVENLABS_API_KEY: EnvVarEntry = EnvVarEntry(
         var_name="ELEVENLABS_API_KEY",
-        default_value=" ",
+        default_value=None,
         allowed_values=None,
         description="set api key for Elevenlabs",
     )

{sinapsis_speech-0.1.0 → sinapsis_speech-0.2.0}/packages/sinapsis_elevenlabs/src/sinapsis_elevenlabs/helpers/voice_utils.py

@@ -9,34 +9,18 @@ def create_voice_settings(settings: VoiceSettings) -> VoiceSettings | None:
     """
     Creates or updates a `VoiceSettings` object based on the provided settings.
 
-    This function attempts to create or update a `VoiceSettings` object using the provided
-    `VoiceSettings` instance. If any of the fields in the settings contain `None`,
-    the corresponding field is populated with a default value from `DEFAULT_VOICE.settings`.
-    If all fields are valid (i.e., none are `None`), the provided `settings` object is returned unchanged.
-
-    If the settings argument is `None` or if no valid settings are provided, the function
-    returns `None`.
-
     Args:
-        settings (VoiceSettings): An instance of `VoiceSettings` containing the settings to be applied.
-            This object may have fields with `None` values that should be replaced with default values.
+        settings (VoiceSettings | None): An instance of `VoiceSettings` containing the settings to be applied.
+            If `None`, the function returns the default settings.
 
     Returns:
-        VoiceSettings: A `VoiceSettings` object created or updated with the provided settings. If any field
-                       was `None`, it is updated with default values. If the settings are invalid or empty,
-                       `None` is returned.
+        VoiceSettings: The provided `VoiceSettings` object if `settings` is not `None`. Otherwise,
+            `DEFAULT_VOICE.settings` is returned.
     """
-    if settings:
-        settings_dict = settings.model_dump()
-        if any(value is None for value in settings_dict.values()):
-            for field, value in settings_dict.items():
-                if value is None:
-                    settings_dict[field] = getattr(DEFAULT_VOICE.settings, field)
+    if not settings:
+        return DEFAULT_VOICE.settings
 
-            return VoiceSettings(**settings_dict)
-        else:
-            return settings
-    return None
+    return settings
 
 
 def get_voice_id(client: ElevenLabs, voice: VoiceId | VoiceName) -> VoiceId:

{sinapsis_speech-0.1.0 → sinapsis_speech-0.2.0}/packages/sinapsis_elevenlabs/src/sinapsis_elevenlabs/templates/elevenlabs_base.py

@@ -9,6 +9,8 @@ from typing import IO, Iterator, Literal
 
 from elevenlabs import Voice, VoiceSettings, save
 from elevenlabs.client import ElevenLabs, VoiceId, VoiceName
+from elevenlabs.types import OutputFormat
+from pydantic import Field
 from sinapsis_core.data_containers.data_packet import AudioPacket, DataContainer, Packet
 from sinapsis_core.template_base.template import (
     Template,
@@ -40,25 +42,23 @@ class ElevenLabsBase(Template, abc.ABC):
         """
         Attributes for ElevenLabs Base Class.
         Args:
-            api_key (str): The API key to authenticate with ElevenLabs' API.
-            voice (str|elevenlabs.Voice): The voice to use for speech synthesis. This can be a voice ID (str),
+            api_key (str): The API used key to authenticate with ElevenLabs' API.
+            model (Literal): The model identifier to use for speech synthesis.
+            output_format (OutputFormat): The output audio format and quality. Options include:
+                ["mp3_22050_32", "mp3_44100_32", "mp3_44100_64", "mp3_44100_96", "mp3_44100_128",
+                "mp3_44100_192", "pcm_16000", "pcm_22050", "pcm_24000", "pcm_44100", "ulaw_8000"]
+            output_folder (str): The folder where generated audio files will be saved.
+            stream (bool): If True, the audio is returned as a stream; otherwise, saved to a file.
+            voice (VoiceId | VoiceName | Voice): The voice to use for speech synthesis. This can be a voice ID (str),
                 a voice name (str) or an elevenlabs voice object (Voice).
             voice_settings (VoiceSettings): A dictionary of settings that control the behavior of the voice.
                 - stability (float)
                 - similarity_boost (float)
                 - style (float)
                 - use_speaker_boost (bool)
-            model (Literal): The model identifier to use for speech synthesis.
-            output_format (Literal): The output audio format and quality. Options include:
-                ["mp3_22050_32", "mp3_44100_32", "mp3_44100_64", "mp3_44100_96", "mp3_44100_128",
-                "mp3_44100_192", "pcm_16000", "pcm_22050", "pcm_24000", "pcm_44100", "ulaw_8000"]
-            output_folder (str): The folder where generated audio files will be saved.
-            stream (bool): If True, the audio is returned as a stream; otherwise, saved to a file.
         """
 
         api_key: str | None = None
-        voice: VoiceId | VoiceName | Voice = None
-        voice_settings: VoiceSettings | None = None
         model: Literal[
             "eleven_turbo_v2_5",
             "eleven_multilingual_v2",
@@ -68,21 +68,11 @@ class ElevenLabsBase(Template, abc.ABC):
             "eleven_english_sts_v2",
             "eleven_multilingual_sts_v2",
         ] = "eleven_turbo_v2_5"
-        output_format: Literal[
-            "mp3_22050_32",
-            "mp3_44100_32",
-            "mp3_44100_64",
-            "mp3_44100_96",
-            "mp3_44100_128",
-            "mp3_44100_192",
-            "pcm_16000",
-            "pcm_22050",
-            "pcm_24000",
-            "pcm_44100",
-            "ulaw_8000",
-        ] = "mp3_44100_128"
+        output_format: OutputFormat = "mp3_44100_128"
         output_folder: str = os.path.join(SINAPSIS_CACHE_DIR, "elevenlabs", "audios")
         stream: bool = False
+        voice: VoiceId | VoiceName | Voice = None
+        voice_settings: VoiceSettings = Field(default_factory=dict)  # type: ignore[arg-type]
 
     def __init__(self, attributes: TemplateAttributeType) -> None:
         """Initializes the ElevenLabs API client with the given attributes."""