Skip to content

Added valid values to emotion and speed #300

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
Devon-White merged 1 commit into from
Jun 2, 2025
Merged

Added valid values to emotion and speed #300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/swml/methods/ai/ai_languages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ Use `ai.languages` to configure the spoken language of your AI Agent, as well as
| `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 />**IMPORTANT:** Only works with `Cartesia` TTS engine. |
| `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 />**IMPORTANT:** Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine. |
| `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/getting-started/voice-and-languages#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> |

Expand Down