Skip to main content
Use the ADK to configure voice features for your agents.
Note: To use voice in watsonx Orchestrate Developer Edition, enable the voice feature by adding the --with-voice flag to the orchestrate server start command. For more information, see Installing watsonx Orchestrate Developer Edition: watsonx Orchestrate server.

Creating voice configurations

To create a voice configuration, first create a YAML file that defines your voice settings. This file includes the voice name, speech-to-text and text-to-speech provider settings, the primary language, and optional configurations for advanced settings.

Supported Providers

Speech-to-Text (STT) Providers:
  • watson_stt: IBM Watson Speech to Text - Docs
  • deepgram_stt: Deepgram Speech to Text - Docs
  • google_stt: Google Speech-to-Text (v1) - Docs
  • elevenlabs_stt: ElevenLabs Speech to Text - Docs
Text-to-Speech (TTS) Providers:
  • watson_tts: IBM Watson Text to Speech - Docs
  • deepgram_tts: Deepgram Text to Speech - Docs
  • elevenlabs_tts: ElevenLabs Text to Speech - Docs
  • google_tts: Google Text-to-Speech - Docs
Note: Please refer to the official documentations of each providers for more information on models and parameters.

Configuration Examples

Watson STT/TTS Configuration

Basic Example:
YAML
Advanced Example:
YAML
Watson STT Configuration Parameters: Watson TTS Configuration Parameters:

Deepgram STT/TTS Configuration

Basic Example:
YAML
Advanced Example (nova-3 with keyterm):
YAML
Deepgram STT Configuration Parameters: Deepgram TTS Configuration Parameters: Available Deepgram models: Deepgram provides two generations of text-to-speech (TTS) models. Both work with the deepgram_tts provider.
  • Aura 2 (for example, aura-2-thalia-en) is the existing model.
  • Flux TTS (for example, flux-afsana-bn) is a newer model.
Set the model parameter to the model name listed in the tables. The model name follows the pattern flux-<voice>-<language>. Speech to text (Flux): Text to speech (Flux TTS):

ElevenLabs STT/TTS Configuration

Basic Example:
YAML
Advanced Example:
YAML
ElevenLabs STT Configuration Parameters: ElevenLabs TTS Configuration Parameters:

Google STT/TTS Configuration

Basic Example:
YAML
Advanced Example:
YAML
Google STT Configuration Parameters: Google TTS Configuration Parameters:

Advanced Voice Settings

Voice configurations support advanced features for enhanced call handling:

Voice Activity Detection (VAD)

Automatically detect when the user is speaking:
YAML

DTMF Input (Dual-Tone Multi-Frequency)

Enable keypad input during voice calls:
YAML

User Idle Handler

Handle situations when the user stops responding:
YAML
User Idle Handler Configuration Parameters:

Agent Idle Handler

Provide feedback when the agent is processing:
YAML
Agent Idle Handler Configuration Parameters:

Complete Advanced Example

YAML

Importing voice configurations

After creating your YAML file, import it using the following command:
BASH
Note: The import command creates a new voice configuration or updates an existing one based on the name. If a voice configuration with the same name exists, the command updates it using the new configuration.

Listing voice configurations

To list all available voice configurations:
BASH

Getting voice configuration details

To retrieve details of a specific voice configuration:
BASH

Exporting voice configurations

To export a voice configuration to a YAML file:
BASH

Removing voice configurations

To remove a voice configuration by name or ID:
BASH
Note: If both --id and --name are provided, the ID takes precedence.
Important: When you remove a voice configuration, agents using this configuration will no longer have voice capabilities. Make sure you want to remove the configuration before you proceed.