Skip to content

Update name and code in ai.languages params table #485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Sep 25, 2025
Merged

Update name and code in ai.languages params table #485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
1e78d36
update `name` and `code` in `ai.languages` params table
hey-august Sep 5, 2025
d16fe27
Merge branch 'main' into august-0925-deepgram-asr
hey-august Sep 5, 2025
81b3309
Add note on `speech_fillers`
hey-august Sep 5, 2025
e7b7f68
fix link
hey-august Sep 5, 2025
a8c7d2b
missing title metadata in TTS index
hey-august Sep 9, 2025
34165be
Merge branch 'main' into august-0925-deepgram-asr
hey-august Sep 9, 2025
f17e96d
probably don't need an emoji
hey-august Sep 9, 2025
a28cbaf
Merge branch 'main' into august-0925-deepgram-asr
hey-august Sep 12, 2025
c25e946
Merge branch 'main' into august-0925-deepgram-asr
hey-august Sep 16, 2025
cc3dab3
Merge branch 'main' into august-0925-deepgram-asr
hey-august Sep 19, 2025
8709ffa
Merge branch 'main' into august-0925-deepgram-asr
hey-august Sep 22, 2025
f74e09a
Merge branch 'main' into august-0925-deepgram-asr
Devon-White Sep 24, 2025
6a97ef6
Merge branch 'main' into august-0925-deepgram-asr
hey-august Sep 24, 2025
2f1a99e
Merge branch 'main' into august-0925-deepgram-asr
hey-august Sep 24, 2025
125ef47
Merge branch 'main' into august-0925-deepgram-asr
hey-august Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion website/docs/main/home/calling/voice/tts/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
slug: /voice/getting-started/voice-and-languages
author: Devon White, August Lindgren-Ruby
title: Voices and Languages
x-custom:
tags:
- favorite
Expand Down Expand Up @@ -86,4 +87,4 @@ For detailed instructions for each provider, consult the voice ID references lin

## **Pricing**

See the [Voice API Pricing](https://signalwire.com/pricing/voice) page for up-to-date pricing information.
See the [Voice API Pricing](https://signalwire.com/pricing/voice) page for up-to-date pricing information.
2 changes: 1 addition & 1 deletion website/docs/main/home/calling/voice/tts/rime.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Rime TTS voices on the SignalWire Platform
slug: /voice/tts/rime
sidebar_label: Rime 🔮
sidebar_label: Rime
sidebar_position: 0
description: Learn how to use Rime's Arcana and Mist v2 TTS models with SignalWire AI Voice applications.
image: /docs/home/calling/voice/tts/preview.webp
Expand Down
25 changes: 13 additions & 12 deletions website/docs/main/swml/methods/ai/ai_languages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ tags: ['swml']
[tts-providers]: /voice/getting-started/voice-and-languages#providers
[voices-and-languages]: /voice/getting-started/voice-and-languages
[swaig-functions]: /swml/methods/ai/swaig/functions
[deepgram-codes]: https://developers.deepgram.com/docs/models-languages-overview#nova-3

# ai.languages

Expand All @@ -25,18 +26,18 @@ Use `ai.languages` to configure the spoken language of your AI Agent, as well as

## **Parameters for the `languages` object** {#languages-parameters}

| Name | Type | Default | Description |
| :---------------------------------------------------------------------------------------------- | :------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `name`<span className="required-arg">Required</span> | `string` | `English` | Name of the language ("French", "English", etc). |
| `code`<span className="required-arg">Required</span> | `string` | `en-US` | The language code for the chosen voice, specified by the selected [TTS provider][tts-providers]. For example, `fr-FR`. |
| [`voice`](#use-voice-strings)<span className="required-arg">Required</span> | `string` | [Standard-tier][voices-and-languages] voice picked by SignalWire | String format: `<engine id>.<voice id>`.<br/>Select engine from `gcloud`, `polly`, `elevenlabs`, or `deepgram`. Select voice from [TTS provider reference][tts-providers].<br/>For example, `"gcloud.fr-FR-Neural2-B"`. |
| `emotion`<span className="optional-arg">Optional</span> | `string` | None | Enables emotion for the set TTS engine. This allows the AI to express emotions when speaking. A global emotion or specific emotions for certain topics can be set within the prompt of the AI.<br />*Valid values:** `auto`<br />**IMPORTANT:** Only works with `Cartesia` TTS engine. |
| `function_fillers`<span className="optional-arg">Optional</span> | `string[]` | None | An array of strings to be used as fillers in the conversation when the agent is calling a [`SWAIG function`][swaig-functions]. The filler is played asynchronously during the function call. |
| `model`<span className="optional-arg">Optional</span> | `string` | None | The model to use for the specified TTS engine (e.g. `arcana`). Check the [TTS provider reference][tts-providers] for the available models. |
| `speech_fillers`<span className="optional-arg">Optional</span> | `string[]` | None | An array of strings to be used as fillers in the conversation. This helps the AI break silence between responses. |
| `speed`<span className="optional-arg">Optional</span> | `string` | None | The speed to use for the specified TTS engine. This allows the AI to speak at a different speed at different points in the conversation. The speed behavior can be defined in the prompt of the AI.<br />*Valid values:** `auto`<br />**IMPORTANT:** Only works with [`Cartesia`](/voice/tts/cartesia) TTS engine. |
| <span className="deprecated-arg">`fillers`</span><span className="optional-arg">Optional</span> | <span className="deprecated-arg">`string[]`</span> | <span className="deprecated-arg">None</span> | <span className="deprecated-arg">An array of strings to be used as fillers in the conversation and when the agent is calling a [`SWAIG function`][swaig-functions].</span><span className="deprecated-desc">**Deprecated**: Use `speech_fillers` and `function_fillers` instead.</span> |
| <span className="deprecated-arg">`engine`</span><span className="optional-arg">Optional</span> | <span className="deprecated-arg">`string`</span> | <span className="deprecated-arg">`gcloud`</span> | <span className="deprecated-arg">The engine to use for the language. For example, `"elevenlabs"`.</span><span className="deprecated-desc">**Deprecated.** Set the engine with the [`voice`](#use-voice-strings) parameter.</span> |
| Name | Type | Default | Description |
| :---------------------------------------------------------------------------------------------- | :------------------------------------------------- | :--------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `name`<span className="required-arg">Required</span> | `string` | `English` | Name of the language ("French", "English", etc). This value is used in the system prompt to instruct the LLM what language is being spoken. |
| `code`<span className="required-arg">Required</span> | `string` | `en-US` | Set the language code for <Tooltips tip="Automatic Speech Recognition">ASR</Tooltips> (<Tooltips tip="Speech-to-text">STT</Tooltips>) purposes. By default, SignalWire uses Deepgram's Nova-3 STT engine, so this value should match a code from Deepgram's [Nova-3 language codes table][deepgram-codes].<br/><hr/>If a different STT model was selected using the [`openai_asr_engine` parameter](/swml/methods/ai/params), you must select a code supported by that engine. |
| [`voice`](#use-voice-strings)<span className="required-arg">Required</span> | `string` | [Standard-tier][voices-and-languages] voice picked by SignalWire | String format: `<engine id>.<voice id>`.<br/>Select engine from `gcloud`, `polly`, `elevenlabs`, or `deepgram`. Select voice from [TTS provider reference][tts-providers].<br/>For example, `"gcloud.fr-FR-Neural2-B"`. |
| `emotion`<span className="optional-arg">Optional</span> | `string` | None | Enables emotion for the set TTS engine. This allows the AI to express emotions when speaking. A global emotion or specific emotions for certain topics can be set within the prompt of the AI.<br />*Valid values:** `auto`<br />**IMPORTANT:** Only works with `Cartesia` TTS engine. |
| `function_fillers`<span className="optional-arg">Optional</span> | `string[]` | None | An array of strings to be used as fillers in the conversation when the agent is calling a [`SWAIG function`][swaig-functions]. The filler is played asynchronously during the function call. |
| `model`<span className="optional-arg">Optional</span> | `string` | None | The model to use for the specified TTS engine (e.g. `arcana`). Check the [TTS provider reference][tts-providers] for the available models. |
| `speech_fillers`<span className="optional-arg">Optional</span> | `string[]` | None | An array of strings to be used as fillers in the conversation. This helps the AI break silence between responses.<hr/>Note that `speech_fillers` are used between every 'turn' taken by the LLM, including at the beginning of the call. For more targed fillers, consider using `function_fillers`. |
| `speed`<span className="optional-arg">Optional</span> | `string` | None | The speed to use for the specified TTS engine. This allows the AI to speak at a different speed at different points in the conversation. The speed behavior can be defined in the prompt of the AI.<br />*Valid values:** `auto`<br />**IMPORTANT:** Only works with [`Cartesia`](/voice/tts/cartesia) TTS engine. |
| <span className="deprecated-arg">`fillers`</span><span className="optional-arg">Optional</span> | <span className="deprecated-arg">`string[]`</span> | <span className="deprecated-arg">None</span> | <span className="deprecated-arg">An array of strings to be used as fillers in the conversation and when the agent is calling a [`SWAIG function`][swaig-functions].</span><span className="deprecated-desc">**Deprecated**: Use `speech_fillers` and `function_fillers` instead.</span> |
| <span className="deprecated-arg">`engine`</span><span className="optional-arg">Optional</span> | <span className="deprecated-arg">`string`</span> | <span className="deprecated-arg">`gcloud`</span> | <span className="deprecated-arg">The engine to use for the language. For example, `"elevenlabs"`.</span><span className="deprecated-desc">**Deprecated.** Set the engine with the [`voice`](#use-voice-strings) parameter.</span> |

### Use `voice` strings

Expand Down