Skip to content

docs: update for pipecat PR #4511 #843

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
markbackman merged 1 commit into from
May 29, 2026
Merged

docs: update for pipecat PR #4511 #843

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
43 changes: 22 additions & 21 deletions api-reference/server/services/tts/rime.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Before using Rime TTS services, you need:
Rime WebSocket API endpoint.
</ParamField>

<ParamField path="model" type="str" default="arcana" deprecated>
<ParamField path="model" type="str" default="coda" deprecated>
Model ID to use for synthesis. _Deprecated in v0.0.105. Use
`settings=RimeTTSService.Settings(model=...)` instead._
</ParamField>
Expand Down Expand Up @@ -122,7 +122,7 @@ Before using Rime TTS services, you need:
An aiohttp session for HTTP requests.
</ParamField>

<ParamField path="model" type="str" default="mistv2" deprecated>
<ParamField path="model" type="str" default="coda" deprecated>
Model ID to use for synthesis. _Deprecated in v0.0.105. Use
`settings=RimeHttpTTSService.Settings(model=...)` instead._
</ParamField>
Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
Loading