Skip to content

Commit 2144a8e

Browse files
committed
add eleven labs doc
1 parent e0a8a30 commit 2144a8e

File tree

1 file changed

+66
-0
lines changed
  • i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend

1 file changed

+66
-0
lines changed

i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/tts.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,3 +304,69 @@ minimax_tts:
304304
pronunciation_dict: ''
305305
```
306306
The `voice_id` parameter can be configured to different voice tones. You can check the [voice ID query section in the official documentation](https://platform.minimaxi.com/document/get_voice) for a complete list of supported voices. The `pronunciation_dict` supports custom pronunciation rules - for example, you can define rules to pronounce "牛肉" as "neuro" using the format shown in the example.
307+
308+
## ElevenLabs TTS (Online, API Key Required)
309+
> Available since version `v1.2.1`
310+
311+
ElevenLabs provides high-quality, natural-sounding text-to-speech with support for multiple languages and voice cloning capabilities.
312+
313+
### Features
314+
- **High-Quality Audio**: Industry-leading speech synthesis quality
315+
- **Multi-language Support**: Supports English, Chinese, Japanese, Korean, and many other languages
316+
- **Voice Cloning**: Upload audio samples to clone voices
317+
- **Rich Voice Library**: Multiple preset voices and community voices available
318+
- **Real-time Generation**: Low-latency speech synthesis
319+
320+
### Configuration Steps
321+
1. **Register and Get API Key**
322+
- Visit [ElevenLabs](https://elevenlabs.io/) to register an account
323+
- Get your API key from the ElevenLabs dashboard
324+
325+
2. **Choose a Voice**
326+
- Browse available voices in the ElevenLabs dashboard
327+
- Copy the Voice ID of your preferred voice
328+
- You can also upload audio samples for voice cloning
329+
330+
3. **Configure `conf.yaml`**
331+
In the `elevenlabs_tts` section of your configuration file, enter parameters as follows:
332+
333+
```yaml
334+
elevenlabs_tts:
335+
api_key: 'your_elevenlabs_api_key' # Required: Your ElevenLabs API key
336+
voice_id: 'JBFqnCBsd6RMkjVDRZzb' # Required: ElevenLabs Voice ID
337+
model_id: 'eleven_multilingual_v2' # Model ID (default: eleven_multilingual_v2)
338+
output_format: 'mp3_44100_128' # Output audio format (default: mp3_44100_128)
339+
stability: 0.5 # Voice stability (0.0 to 1.0, default: 0.5)
340+
similarity_boost: 0.5 # Voice similarity boost (0.0 to 1.0, default: 0.5)
341+
style: 0.0 # Voice style exaggeration (0.0 to 1.0, default: 0.0)
342+
use_speaker_boost: true # Enable speaker boost for better quality (default: true)
343+
```
344+
345+
### Parameter Descriptions
346+
- **api_key** (required): Your ElevenLabs API key
347+
- **voice_id** (required): Unique identifier for the voice, found in your ElevenLabs dashboard
348+
- **model_id**: TTS model to use. Available options:
349+
- `eleven_multilingual_v2` (default) - Supports multiple languages
350+
- `eleven_monolingual_v1` - English only
351+
- `eleven_turbo_v2` - Faster generation
352+
- **output_format**: Audio output format. Common options:
353+
- `mp3_44100_128` (default) - MP3, 44.1kHz, 128kbps
354+
- `mp3_44100_192` - MP3, 44.1kHz, 192kbps
355+
- `pcm_16000` - PCM, 16kHz
356+
- `pcm_22050` - PCM, 22.05kHz
357+
- `pcm_24000` - PCM, 24kHz
358+
- `pcm_44100` - PCM, 44.1kHz
359+
- **stability**: Controls voice consistency (0.0 = more variable, 1.0 = more consistent)
360+
- **similarity_boost**: Enhances similarity to the original voice (0.0 to 1.0)
361+
- **style**: Controls style exaggeration (0.0 = neutral, 1.0 = more expressive)
362+
- **use_speaker_boost**: Enables speaker boost for improved audio quality
363+
364+
### Usage Tips
365+
- **Voice Selection**: Try preset voices first, then consider voice cloning for custom voices
366+
- **Parameter Tuning**: Adjust `stability` and `similarity_boost` for optimal results
367+
- **Cost Management**: ElevenLabs charges based on usage, test first before heavy usage
368+
- **Network Requirements**: Stable internet connection required for service availability
369+
370+
:::tip
371+
ElevenLabs offers free trial credits, so you can test the quality before purchasing a paid plan.
372+
:::

0 commit comments

Comments
 (0)