From 8910a8e96effc6b80dfe8c77fd8d0658bd5112bf Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 28 May 2026 02:40:03 +0000 Subject: [PATCH] docs: update Rime TTS for coda model and timeScaleFactor Updates documentation for pipecat PR #4511: - Changed default model from arcana to coda for RimeTTSService and RimeHttpTTSService - Added timeScaleFactor parameter to both settings tables - Clarified that repetition_penalty, temperature, and top_p are arcana-only parameters --- api-reference/server/services/tts/rime.mdx | 43 +++++++++++----------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/api-reference/server/services/tts/rime.mdx b/api-reference/server/services/tts/rime.mdx index de7ea5dd..90ea2702 100644 --- a/api-reference/server/services/tts/rime.mdx +++ b/api-reference/server/services/tts/rime.mdx @@ -73,7 +73,7 @@ Before using Rime TTS services, you need: Rime WebSocket API endpoint. - + Model ID to use for synthesis. _Deprecated in v0.0.105. Use `settings=RimeTTSService.Settings(model=...)` instead._ @@ -122,7 +122,7 @@ Before using Rime TTS services, you need: An aiohttp session for HTTP requests. - + Model ID to use for synthesis. _Deprecated in v0.0.105. Use `settings=RimeHttpTTSService.Settings(model=...)` instead._ @@ -205,22 +205,23 @@ A non-JSON WebSocket service for models like Arcana that use plain text messages Runtime-configurable settings passed via the `settings` constructor argument using `RimeTTSService.Settings(...)`. These can be updated mid-conversation with `TTSUpdateSettingsFrame`. See [Service Settings](/pipecat/fundamentals/service-settings) for details. -| Parameter | Type | Default | Description | -| -------------------------- | ----------------- | ----------- | -------------------------------------- | -| `model` | `str` | `None` | Model identifier. _(Inherited.)_ | -| `voice` | `str` | `None` | Voice identifier. _(Inherited.)_ | -| `language` | `Language \| str` | `None` | Language for synthesis. _(Inherited.)_ | -| `segment` | `str` | `NOT_GIVEN` | Segment type for synthesis. | -| `speedAlpha` | `float` | `NOT_GIVEN` | Speed alpha parameter. | -| `reduceLatency` | `bool` | `NOT_GIVEN` | Whether to reduce latency. | -| `pauseBetweenBrackets` | `bool` | `NOT_GIVEN` | Pause between brackets. | -| `phonemizeBetweenBrackets` | `bool` | `NOT_GIVEN` | Phonemize between brackets. | -| `noTextNormalization` | `bool` | `NOT_GIVEN` | Disable text normalization. | -| `saveOovs` | `bool` | `NOT_GIVEN` | Save out-of-vocabulary words. | -| `inlineSpeedAlpha` | `str` | `NOT_GIVEN` | Inline speed alpha. | -| `repetition_penalty` | `float` | `NOT_GIVEN` | Repetition penalty. | -| `temperature` | `float` | `NOT_GIVEN` | Temperature for sampling. | -| `top_p` | `float` | `NOT_GIVEN` | Top-p sampling parameter. | +| Parameter | Type | Default | Description | +| -------------------------- | ----------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `model` | `str` | `None` | Model identifier. _(Inherited.)_ | +| `voice` | `str` | `None` | Voice identifier. _(Inherited.)_ | +| `language` | `Language \| str` | `None` | Language for synthesis. _(Inherited.)_ | +| `segment` | `str` | `NOT_GIVEN` | Segment type for synthesis. | +| `speedAlpha` | `float` | `NOT_GIVEN` | Speed alpha parameter. | +| `reduceLatency` | `bool` | `NOT_GIVEN` | Whether to reduce latency. | +| `pauseBetweenBrackets` | `bool` | `NOT_GIVEN` | Pause between brackets. | +| `phonemizeBetweenBrackets` | `bool` | `NOT_GIVEN` | Phonemize between brackets. | +| `noTextNormalization` | `bool` | `NOT_GIVEN` | Disable text normalization. | +| `saveOovs` | `bool` | `NOT_GIVEN` | Save out-of-vocabulary words. | +| `inlineSpeedAlpha` | `str` | `NOT_GIVEN` | Inline speed alpha. | +| `repetition_penalty` | `float` | `NOT_GIVEN` | Token repetition penalty (arcana only, 1.0-2.0). | +| `temperature` | `float` | `NOT_GIVEN` | Sampling temperature (arcana only, 0.0-1.0). | +| `top_p` | `float` | `NOT_GIVEN` | Cumulative probability threshold (arcana only, 0.0-1.0). | +| `timeScaleFactor` | `float` | `NOT_GIVEN` | Audio playback speed factor (arcana, mistv3, and coda only). Values above 1.0 slow down the audio; values below 1.0 speed it up. | #### RimeNonJsonTTSService Settings @@ -232,9 +233,9 @@ Runtime-configurable settings passed via the `settings` constructor argument usi | `voice` | `str` | `None` | Voice identifier. _(Inherited.)_ | | `language` | `Language \| str` | `None` | Language for synthesis. _(Inherited.)_ | | `segment` | `str` | `NOT_GIVEN` | Segment type for synthesis. | -| `repetition_penalty` | `float` | `NOT_GIVEN` | Repetition penalty. | -| `temperature` | `float` | `NOT_GIVEN` | Temperature for sampling. | -| `top_p` | `float` | `NOT_GIVEN` | Top-p sampling parameter. | +| `repetition_penalty` | `float` | `NOT_GIVEN` | Token repetition penalty. | +| `temperature` | `float` | `NOT_GIVEN` | Sampling temperature. | +| `top_p` | `float` | `NOT_GIVEN` | Cumulative probability threshold. | ## Usage