> ## Documentation Index
> Fetch the complete documentation index at: https://docs.volubile.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Text-to-Speech

> Configuration of voices for your phone agents

## Agent Voice

<Note>
  Text-to-speech allows you to customize the user experience by selecting a voice that suits your linguistic needs
  and your brand identity.
</Note>

### Voice Catalog

To access the catalog of available voices, click the **Edit** button next to the voice currently configured for your agent.

<Frame>
  <img src="https://mintcdn.com/weengage/DhTJGqKM0FN88ypW/images/agents/tts/volubile-tts-voice-catolog-access.png?fit=max&auto=format&n=DhTJGqKM0FN88ypW&q=85&s=ae8573d309e8dfa0e3eb2ea859bc648b" alt="Voice catalog access interface" style={{width: 400}} width="823" height="188" data-path="images/agents/tts/volubile-tts-voice-catolog-access.png" />
</Frame>

### Voice Selection

<Frame>
  <img src="https://mintcdn.com/weengage/DhTJGqKM0FN88ypW/images/agents/tts/volubile-tts-voice-catalog.png?fit=max&auto=format&n=DhTJGqKM0FN88ypW&q=85&s=3ec559ff33c79b09ab57b3c7780286dd" alt="Volubile voice catalog" width="1920" height="1490" data-path="images/agents/tts/volubile-tts-voice-catalog.png" />
</Frame>

<Steps>
  <Step title="Select Provider">
    Choose the voice technology provider from the dropdown menu. Each provider offers distinct voice features.
  </Step>

  <Step title="Configure Languages">
    Select the languages your agent should master. These languages will determine the available voices in the next step.
  </Step>

  <Step title="Choose Voice">
    Browse through the voice options that match your linguistic criteria and select the one that best suits your needs.
  </Step>

  <Step title="Confirmation">
    Click the **Save** button to apply your selection and enable the chosen voice.
  </Step>
</Steps>

<Warning>
  A maximum of 5 languages can be selected to filter the available voices. This limitation helps optimize your agent's performance.
</Warning>

<Tip>
  Before finalizing your choice, use the play buttons to listen to a sample of each voice in the different selected languages.
</Tip>

## Languages

### Language Selection

<Frame>
  <img src="https://mintcdn.com/weengage/DhTJGqKM0FN88ypW/images/agents/tts/volubile-tts-language-selector.png?fit=max&auto=format&n=DhTJGqKM0FN88ypW&q=85&s=1675e2045a6001c0ba991cefd242beef" alt="Language selector interface" width="1872" height="459" data-path="images/agents/tts/volubile-tts-language-selector.png" />
</Frame>

Configure the languages your agent can understand and express itself in.

<Steps>
  <Step title="Add Supported Languages">
    Select all the languages your agent should master from the **Languages** dropdown menu. Each language is identified with its regional variant.
  </Step>

  <Step title="Define Primary Language">
    Select the primary language that will be used by default when the agent cannot determine the user's language.
  </Step>
</Steps>

<Warning>
  A maximum of 5 languages can be configured for each agent. This limitation helps optimize the performance and accuracy of interactions.
</Warning>

### Multilingual Operation

The agent uses automatic language detection to adapt its response to the user:

<CardGroup cols={2}>
  <Card title="Automatic Detection" icon="wand-magic-sparkles">
    The agent automatically identifies the language used by the interlocutor and responds in the same language if it is among the configured languages.
  </Card>

  <Card title="Default Language" icon="language">
    If the detected language is not supported, the agent will use the primary language defined in the configuration.
  </Card>
</CardGroup>

### Troubleshooting Common Issues

If your agent does not correctly detect the user's language:

* Ensure that the language is included in the list of supported languages.
* Make sure that the spoken phrases contain enough words to enable reliable detection.

## Speech Rate

<Frame>
  <img src="https://mintcdn.com/weengage/DhTJGqKM0FN88ypW/images/agents/tts/volubile-tts-voice-speed.png?fit=max&auto=format&n=DhTJGqKM0FN88ypW&q=85&s=7ec30ad649bf9d77349d4ff1dfe2ab6d" alt="Speech rate selector interface" width="1883" height="343" data-path="images/agents/tts/volubile-tts-voice-speed.png" />
</Frame>

Adjust your agent's speech rate by moving the slider on the scale:

<CardGroup cols={3}>
  <Card title="Slow" icon="turtle">
    Slower pace for better understanding during complex concepts or for those with hearing difficulties.
  </Card>

  <Card title="Normal" icon="user">
    Standard pace calibrated for natural conversation.
  </Card>

  <Card title="Fast" icon="rabbit">
    Accelerated pace for users to deliver information quickly.
  </Card>
</CardGroup>

<Tip>
  The ideal setting depends on your audience and context of use. Test different configurations to find the optimal rate for your use case.
</Tip>

## Phonemes

<Frame>
  <img src="https://mintcdn.com/weengage/DhTJGqKM0FN88ypW/images/agents/tts/volubile-tts-phoeneme-configuration.png?fit=max&auto=format&n=DhTJGqKM0FN88ypW&q=85&s=6c6413aa31c316b4c4d2911e17093a9e" alt="Phoneme configuration interface" width="1907" height="597" data-path="images/agents/tts/volubile-tts-phoeneme-configuration.png" />
</Frame>

This feature allows you to define a custom phonetic transcription for specific words, particularly useful for:

* Proper names
* Technical terms
* Acronyms and abbreviations
* Foreign words

It is important to note that this feature is only available for the Azure provider.

### Adding a Custom Phoneme

<Steps>
  <Step title="Access the Interface">
    From the "Phoneme Configuration" section, click the <strong>Add Phoneme</strong> button to open the configuration window.

    <Frame>
      <img src="https://mintcdn.com/weengage/DhTJGqKM0FN88ypW/images/agents/tts/volubile-tts-phoeneme-step-1.png?fit=max&auto=format&n=DhTJGqKM0FN88ypW&q=85&s=4c2ffd3e16d72e6beb1137c47e3ab9a8" alt="Phoneme addition form" width="1866" height="335" data-path="images/agents/tts/volubile-tts-phoeneme-step-1.png" />
    </Frame>
  </Step>

  <Step title="Define the Word and Its Pronunciation">
    <Frame>
      <img src="https://mintcdn.com/weengage/DhTJGqKM0FN88ypW/images/agents/tts/volubile-tts-phoeneme-step-2.png?fit=max&auto=format&n=DhTJGqKM0FN88ypW&q=85&s=c92296cb70ae38b6802387c6e8d3763f" alt="Phoneme addition form" width="1200" height="566" data-path="images/agents/tts/volubile-tts-phoeneme-step-2.png" />
    </Frame>

    Fill in the required fields:

    <ul>
      <li><strong>Word</strong>: Enter the word to customize</li>
      <li><strong>Phoneme</strong>: Enter the corresponding phonetic transcription</li>
    </ul>
  </Step>
</Steps>

### Phonetic Notation

Phonemes should be entered according to the International Phonetic Alphabet (IPA) standard.

```
"Paris" → /paʁi/
"WiFi" → /waɪfaɪ/
```

### Use Cases

<CardGroup cols={2}>
  <Card title="Brand Names" icon="trademark">
    Ensure that your agent correctly pronounces your company and product names.
  </Card>

  <Card title="Specialized Terminology" icon="flask">
    Optimize the pronunciation of technical terms specific to your industry.
  </Card>
</CardGroup>

<Warning>
  Phoneme configuration is specific to each language. The same word may require different phonetic transcriptions depending on the languages configured for your agent.
</Warning>

### Practical Recommendations

* After adding a custom phoneme, conduct a test call to check that the pronunciation meets your expectations.
* Start by configuring phonemes for the most frequently used terms by your agent.

## Voice Substitutions

When your voice agent encounters certain abbreviations, acronyms, or technical terms in text, it may sometimes pronounce them incorrectly or unnaturally. The substitution module allows you to set replacement rules to optimize the user experience.

<Frame>
  <img src="https://mintcdn.com/weengage/DhTJGqKM0FN88ypW/images/agents/tts/volubile-tts-text-substitution.png?fit=max&auto=format&n=DhTJGqKM0FN88ypW&q=85&s=5492116981edbf1d7596e5faa42fc9ce" alt="Substitution interface" width="1872" height="628" data-path="images/agents/tts/volubile-tts-text-substitution.png" />
</Frame>

### Common Use Cases

<AccordionGroup>
  <Accordion title="Measurements and Numbers">
    * **Units of Measure**: "cm" → "centimeter", "kg" → "kilogram"
    * **Mathematical Symbols**: "+" → "plus", "=" → "equals", ">" → "greater than"
  </Accordion>

  <Accordion title="People and Places">
    * **Titles and Courtesy Titles**: "Dr" → "Doctor", "Mr." → "Mister"
    * **Geographical Abbreviations**: "St" → "Saint", "Av." → "Avenue"
  </Accordion>

  <Accordion title="Specialized Terms">
    * **Acronyms**: "TVA" → "Value Added Tax", "SNCF" → "S N C F"
    * **Technical Terms**: Adapt the pronunciation of terms specific to your industry
  </Accordion>

  <Accordion title="Special Characters">
    * **Special Characters**: "€" → "euros", "@" → "at symbol", "&" → "and"
    * **Regular Expressions**: Create advanced substitution rules to manage complex cases
  </Accordion>
</AccordionGroup>

### Configuring Substitutions

To configure a new substitution:

<Steps>
  <Step title="Access the Interface">
    From the "Pronunciation Substitution" section, click the <strong>Add Substitution</strong> button to open the configuration window.
  </Step>

  <Step title="Fill Out the Form">
    <Frame>
      <img src="https://mintcdn.com/weengage/DhTJGqKM0FN88ypW/images/agents/tts/volubile-tts-text-substitution-form.png?fit=max&auto=format&n=DhTJGqKM0FN88ypW&q=85&s=cdb77c3c6af26e59c78ccf9eb5d88e3a" alt="Substitution addition form" width="1200" height="775" data-path="images/agents/tts/volubile-tts-text-substitution-form.png" />
    </Frame>

    Fill in the following fields in the form:

    | Field                                     | Description                                                                                      |
    | ----------------------------------------- | ------------------------------------------------------------------------------------------------ |
    | Pattern                                   | The textual pattern to replace (e.g., "cm", "Dr", "St")                                          |
    | Replacement                               | The replacement text that will be used for pronunciation (e.g., "centimeter", "Doctor", "Saint") |
    | Associate a different pattern by language | Option to define specific substitutions for each language supported by your agent                |
  </Step>
</Steps>

### Testing Substitutions

After configuring your substitutions, use the "Try" function to check how your agent will pronounce certain phrases containing the defined patterns.

The Volubile platform offers a testing feature right below the substitution form:

<Frame>
  <img src="https://mintcdn.com/weengage/DhTJGqKM0FN88ypW/images/agents/tts/volubile-tts-text-substitution-test-run.png?fit=max&auto=format&n=DhTJGqKM0FN88ypW&q=85&s=73d013810e1010c35f70d428a6640274" alt="Substitution testing interface" width="1200" height="570" data-path="images/agents/tts/volubile-tts-text-substitution-test-run.png" />
</Frame>

<Steps>
  <Step title="Open the Test Section">
    Expand the "Test" section located at the bottom of the form.
  </Step>

  <Step title="Enter an Example">
    Enter a sample text containing the pattern you want to test.
  </Step>

  <Step title="Check by Language">
    See how your pattern will be detected in different languages (French, English, etc.).
  </Step>
</Steps>

<Warning>
  This feature is particularly useful for validating complex regular expressions that may be difficult to test without a dedicated environment.
</Warning>

### Rules and Best Practices

* For complex acronyms, prefer spelling them out (e.g., "IBM" → "I B M") if the natural pronunciation is ambiguous.
* Test your substitutions to ensure their effectiveness.
* Limit to strictly necessary substitutions to maintain optimal performance.
* Use the "Associate a different pattern by language" option to set specific substitutions for each language when pronunciation or abbreviation differs by language (for example, "cm" could be replaced by "centimeter" in English and "centimètre" in French).
