From 420eba7267755482b1855bcb2c5384c59396c4c3 Mon Sep 17 00:00:00 2001 From: Devon <86693904+Devon-White@users.noreply.github.com> Date: Mon, 2 Jun 2025 07:39:39 -0400 Subject: [PATCH] Added valid values to emotion and speed --- docs/swml/methods/ai/ai_languages.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/swml/methods/ai/ai_languages.mdx b/docs/swml/methods/ai/ai_languages.mdx index 9152c04b9..8ecd7d854 100644 --- a/docs/swml/methods/ai/ai_languages.mdx +++ b/docs/swml/methods/ai/ai_languages.mdx @@ -30,11 +30,11 @@ Use `ai.languages` to configure the spoken language of your AI Agent, as well as | `name`Required | `string` | `English` | Name of the language ("French", "English", etc). | | `code`Required | `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)Required | `string` | [Standard-tier][voices-and-languages] voice picked by SignalWire | String format: `.`.
Select engine from `gcloud`, `polly`, `elevenlabs`, or `deepgram`. Select voice from [TTS provider reference][tts-providers].
For example, `"gcloud.fr-FR-Neural2-B"`. | -| `emotion`Optional | `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.
**IMPORTANT:** Only works with `Cartesia` TTS engine. | +| `emotion`Optional | `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.
*Valid values:** `auto`
**IMPORTANT:** Only works with `Cartesia` TTS engine. | | `function_fillers`Optional | `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`Optional | `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`Optional | `string[]` | None | An array of strings to be used as fillers in the conversation. This helps the AI break silence between responses. | -| `speed`Optional | `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.
**IMPORTANT:** Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine. | +| `speed`Optional | `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.
*Valid values:** `auto`
**IMPORTANT:** Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine. | | `fillers`Optional | `string[]` | None | An array of strings to be used as fillers in the conversation and when the agent is calling a [`SWAIG function`][swaig-functions].**Deprecated**: Use `speech_fillers` and `function_fillers` instead. | | `engine`Optional | `string` | `gcloud` | The engine to use for the language. For example, `"elevenlabs"`.**Deprecated.** Set the engine with the [`voice`](#use-voice-strings) parameter. |