pipecat-tts-cache-router 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pipecat_tts_cache_router-0.1.0/.gitignore +7 -0
- pipecat_tts_cache_router-0.1.0/CHANGELOG.md +15 -0
- pipecat_tts_cache_router-0.1.0/LICENSE +201 -0
- pipecat_tts_cache_router-0.1.0/PKG-INFO +156 -0
- pipecat_tts_cache_router-0.1.0/README.md +133 -0
- pipecat_tts_cache_router-0.1.0/pipecat_tts_cache_router/__init__.py +30 -0
- pipecat_tts_cache_router-0.1.0/pipecat_tts_cache_router/py.typed +0 -0
- pipecat_tts_cache_router-0.1.0/pipecat_tts_cache_router/tts.py +859 -0
- pipecat_tts_cache_router-0.1.0/pipecat_tts_cache_router/version.py +15 -0
- pipecat_tts_cache_router-0.1.0/pyproject.toml +56 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.1.0 (2026-10-15)
|
|
4
|
+
|
|
5
|
+
The first release: `TTSCacheRouterTTSService`, a Pipecat TTS service on tts-cache-router's
|
|
6
|
+
`/v1/stream`, for Sarvam, Raya, ElevenLabs, OpenAI, Deepgram, xAI, Soniox, Smallest AI and
|
|
7
|
+
Cartesia. Tested with Pipecat v1.12.0.
|
|
8
|
+
|
|
9
|
+
- Settings in the router's own names (`model`, `voice`, `language`, `speed`, `options`), changed
|
|
10
|
+
mid-session with `TTSUpdateSettingsFrame`.
|
|
11
|
+
- The LLM's text is streamed to the router as it arrives; the router splits it into sentences.
|
|
12
|
+
- Interruptions cancel the reply at the router and keep the connection.
|
|
13
|
+
- Transcripts follow the audio, word by word for ElevenLabs and Cartesia.
|
|
14
|
+
- TTS usage metrics count only the characters the provider billed; `on_cache_stats` reports how
|
|
15
|
+
much of each reply came from the cache.
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: pipecat-tts-cache-router
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Pipecat TTS service for tts-cache-router, a caching TTS router for Sarvam, Raya, ElevenLabs, OpenAI, Deepgram, xAI, Soniox, Smallest AI and Cartesia
|
|
5
|
+
Project-URL: Homepage, https://ttscacherouter.dev
|
|
6
|
+
Project-URL: Documentation, https://docs.ttscacherouter.dev/pipecat
|
|
7
|
+
Project-URL: Source, https://github.com/talqing/tts-cache-router
|
|
8
|
+
Project-URL: Changelog, https://github.com/talqing/tts-cache-router/blob/main/plugin/pipecat-tts-cache-router/CHANGELOG.md
|
|
9
|
+
Author: Oggnai Technologies Private Limited
|
|
10
|
+
License-Expression: Apache-2.0
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Keywords: ai,audio,cache,cartesia,deepgram,elevenlabs,openai,pipecat,raya,realtime,router,sarvam,smallestai,soniox,tts,voice,xai
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Topic :: Multimedia :: Sound/Audio
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
20
|
+
Requires-Python: >=3.11
|
|
21
|
+
Requires-Dist: pipecat-ai>=1.12.0
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
|
|
24
|
+
# pipecat-tts-cache-router
|
|
25
|
+
|
|
26
|
+
[Pipecat](https://github.com/pipecat-ai/pipecat) TTS service for
|
|
27
|
+
[tts-cache-router](https://ttscacherouter.dev): Sarvam, Raya, ElevenLabs, OpenAI, Deepgram, xAI,
|
|
28
|
+
Soniox, Smallest AI and Cartesia text-to-speech, with every sentence your bot has said before served
|
|
29
|
+
from a per-account cache.
|
|
30
|
+
|
|
31
|
+
Same output whether you call the provider directly or through the router: each sentence reaches
|
|
32
|
+
the provider verbatim with your exact settings, and a cache hit replays a real provider take for
|
|
33
|
+
that exact request.
|
|
34
|
+
|
|
35
|
+
Full documentation: [docs.ttscacherouter.dev/pipecat](https://docs.ttscacherouter.dev/pipecat). For
|
|
36
|
+
LLMs and coding agents: [llms.txt](https://docs.ttscacherouter.dev/llms.txt), and this page as
|
|
37
|
+
Markdown at [pipecat.md](https://docs.ttscacherouter.dev/pipecat.md).
|
|
38
|
+
|
|
39
|
+
Tested with Pipecat v1.12.0. Maintained by Oggnai Technologies, the company that runs
|
|
40
|
+
tts-cache-router.
|
|
41
|
+
|
|
42
|
+
## Install
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
pip install pipecat-tts-cache-router
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Usage
|
|
49
|
+
|
|
50
|
+
```python
|
|
51
|
+
import os
|
|
52
|
+
|
|
53
|
+
from pipecat_tts_cache_router import TTSCacheRouterTTSService
|
|
54
|
+
|
|
55
|
+
tts = TTSCacheRouterTTSService(
|
|
56
|
+
api_key=os.environ["TTS_CACHE_ROUTER_API_KEY"],
|
|
57
|
+
settings=TTSCacheRouterTTSService.Settings(
|
|
58
|
+
model="sarvam/bulbul:v3", voice="shubh", language="hi-IN"
|
|
59
|
+
),
|
|
60
|
+
)
|
|
61
|
+
|
|
62
|
+
pipeline = Pipeline(
|
|
63
|
+
[transport.input(), stt, user_aggregator, llm, tts, transport.output(), assistant_aggregator]
|
|
64
|
+
)
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Before the first request, store your Sarvam, Raya, ElevenLabs, OpenAI, Deepgram, xAI, Soniox,
|
|
68
|
+
Smallest AI or Cartesia API key in the dashboard at
|
|
69
|
+
[ttscacherouter.dev](https://ttscacherouter.dev/dashboard/provider-keys). The router keeps it
|
|
70
|
+
encrypted and uses it only to call that provider for your requests. Your bot authenticates with
|
|
71
|
+
your router API key alone, from the same dashboard.
|
|
72
|
+
|
|
73
|
+
### `TTSCacheRouterTTSService(...)`
|
|
74
|
+
|
|
75
|
+
| Argument | Default | |
|
|
76
|
+
|---|---|---|
|
|
77
|
+
| `api_key` | required | your router API key |
|
|
78
|
+
| `settings` | required | `TTSCacheRouterTTSService.Settings(...)`, below |
|
|
79
|
+
| `base_url` | `wss://api.ttscacherouter.dev` | set to your own router when self-hosting |
|
|
80
|
+
| `sample_rate` | the pipeline's output rate | one the provider streams: 8000, 16000, 22050 or 24000 for most; see [Models and options](https://docs.ttscacherouter.dev/reference/models) |
|
|
81
|
+
|
|
82
|
+
Other keyword arguments go to Pipecat's `WebsocketTTSService`, except `text_aggregation_mode`: the
|
|
83
|
+
router splits the text into sentences itself, so the service streams the LLM's text to it as it
|
|
84
|
+
arrives.
|
|
85
|
+
|
|
86
|
+
### `TTSCacheRouterTTSService.Settings(...)`
|
|
87
|
+
|
|
88
|
+
The settings are in the router's own names, the same for every provider:
|
|
89
|
+
|
|
90
|
+
| Setting | | |
|
|
91
|
+
|---|---|---|
|
|
92
|
+
| `model` | required | `"<provider>/<model>"`: `"sarvam/bulbul:v3"`, `"raya/standard"`, `"elevenlabs/eleven_flash_v2_5"`, `"openai/gpt-4o-mini-tts"`, `"deepgram/aura-2"`, `"xai/xai-tts"`, `"soniox/tts-rt-v2"`, `"smallestai/lightning_v3.1_pro"`, `"cartesia/sonic-3"`, … |
|
|
93
|
+
| `voice` | required | the provider's voice id (`GET /v1/voices` lists them) |
|
|
94
|
+
| `language` | `None` | the provider's own language code, where it takes one (`"hi-IN"` for Sarvam, `"hi"` for Raya, `"en"` for the rest) |
|
|
95
|
+
| `speed` | `None` | the speaking rate, where the provider takes one |
|
|
96
|
+
| `options` | `{}` | the provider's other settings, e.g. `{"temperature": 0.6}` for Sarvam, `{"voice_settings": {"stability": 0.5}}` for ElevenLabs, `{"instructions": "Speak warmly."}` for OpenAI |
|
|
97
|
+
|
|
98
|
+
Every provider's models, voices, languages and options are in
|
|
99
|
+
[Models and options](https://docs.ttscacherouter.dev/reference/models). The router checks the
|
|
100
|
+
settings when the pipeline starts, so a wrong one is reported then as an `ErrorFrame`.
|
|
101
|
+
|
|
102
|
+
### Changing settings mid-session
|
|
103
|
+
|
|
104
|
+
```python
|
|
105
|
+
from pipecat.frames.frames import TTSUpdateSettingsFrame
|
|
106
|
+
|
|
107
|
+
await worker.queue_frame(
|
|
108
|
+
TTSUpdateSettingsFrame(delta=TTSCacheRouterTTSService.Settings(voice="priya"))
|
|
109
|
+
)
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Replies that start afterwards use the new settings. A `model` of another provider starts from no
|
|
113
|
+
`language`, `speed` or `options` unless the update gives them.
|
|
114
|
+
|
|
115
|
+
### Interruptions
|
|
116
|
+
|
|
117
|
+
When the user interrupts, the service tells the router to stop the reply, and the provider stops
|
|
118
|
+
the sentence it was synthesizing. The next reply starts on the same connection.
|
|
119
|
+
|
|
120
|
+
### Transcripts
|
|
121
|
+
|
|
122
|
+
The service's `TTSTextFrame`s follow the audio: each sentence's words as its audio starts, or word
|
|
123
|
+
by word with ElevenLabs and Cartesia.
|
|
124
|
+
|
|
125
|
+
### Metrics
|
|
126
|
+
|
|
127
|
+
With usage metrics on, each reply's `TTSUsageMetricsData` counts only the characters the provider
|
|
128
|
+
synthesized (and billed); sentences served from the cache count zero. Its `model` is
|
|
129
|
+
`"<provider>/<model>"`.
|
|
130
|
+
|
|
131
|
+
Once a reply is all sent, the service also calls its `on_cache_stats` handlers with a `CacheStats`:
|
|
132
|
+
the reply's `context_id`, `sentences`, `cached_sentences`, `characters` and `billed_characters`
|
|
133
|
+
(and `cached_characters`, the difference):
|
|
134
|
+
|
|
135
|
+
```python
|
|
136
|
+
@tts.event_handler("on_cache_stats")
|
|
137
|
+
async def on_cache_stats(tts, stats):
|
|
138
|
+
print(stats.cached_sentences, "of", stats.sentences, "sentences from the cache")
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Example
|
|
142
|
+
|
|
143
|
+
[`examples/pipecat_agent.py`](https://github.com/talqing/tts-cache-router/blob/main/examples/pipecat_agent.py)
|
|
144
|
+
is a complete bot: Deepgram speech-to-text, an OpenAI LLM and this service, on Pipecat's local
|
|
145
|
+
WebRTC runner. With `TTS_CACHE_ROUTER_API_KEY`, `DEEPGRAM_API_KEY` and `OPENAI_API_KEY` set:
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
cd examples
|
|
149
|
+
uv run pipecat_agent.py
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Then open http://localhost:7860/client and talk to it.
|
|
153
|
+
|
|
154
|
+
## License
|
|
155
|
+
|
|
156
|
+
Apache-2.0.
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# pipecat-tts-cache-router
|
|
2
|
+
|
|
3
|
+
[Pipecat](https://github.com/pipecat-ai/pipecat) TTS service for
|
|
4
|
+
[tts-cache-router](https://ttscacherouter.dev): Sarvam, Raya, ElevenLabs, OpenAI, Deepgram, xAI,
|
|
5
|
+
Soniox, Smallest AI and Cartesia text-to-speech, with every sentence your bot has said before served
|
|
6
|
+
from a per-account cache.
|
|
7
|
+
|
|
8
|
+
Same output whether you call the provider directly or through the router: each sentence reaches
|
|
9
|
+
the provider verbatim with your exact settings, and a cache hit replays a real provider take for
|
|
10
|
+
that exact request.
|
|
11
|
+
|
|
12
|
+
Full documentation: [docs.ttscacherouter.dev/pipecat](https://docs.ttscacherouter.dev/pipecat). For
|
|
13
|
+
LLMs and coding agents: [llms.txt](https://docs.ttscacherouter.dev/llms.txt), and this page as
|
|
14
|
+
Markdown at [pipecat.md](https://docs.ttscacherouter.dev/pipecat.md).
|
|
15
|
+
|
|
16
|
+
Tested with Pipecat v1.12.0. Maintained by Oggnai Technologies, the company that runs
|
|
17
|
+
tts-cache-router.
|
|
18
|
+
|
|
19
|
+
## Install
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
pip install pipecat-tts-cache-router
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
```python
|
|
28
|
+
import os
|
|
29
|
+
|
|
30
|
+
from pipecat_tts_cache_router import TTSCacheRouterTTSService
|
|
31
|
+
|
|
32
|
+
tts = TTSCacheRouterTTSService(
|
|
33
|
+
api_key=os.environ["TTS_CACHE_ROUTER_API_KEY"],
|
|
34
|
+
settings=TTSCacheRouterTTSService.Settings(
|
|
35
|
+
model="sarvam/bulbul:v3", voice="shubh", language="hi-IN"
|
|
36
|
+
),
|
|
37
|
+
)
|
|
38
|
+
|
|
39
|
+
pipeline = Pipeline(
|
|
40
|
+
[transport.input(), stt, user_aggregator, llm, tts, transport.output(), assistant_aggregator]
|
|
41
|
+
)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Before the first request, store your Sarvam, Raya, ElevenLabs, OpenAI, Deepgram, xAI, Soniox,
|
|
45
|
+
Smallest AI or Cartesia API key in the dashboard at
|
|
46
|
+
[ttscacherouter.dev](https://ttscacherouter.dev/dashboard/provider-keys). The router keeps it
|
|
47
|
+
encrypted and uses it only to call that provider for your requests. Your bot authenticates with
|
|
48
|
+
your router API key alone, from the same dashboard.
|
|
49
|
+
|
|
50
|
+
### `TTSCacheRouterTTSService(...)`
|
|
51
|
+
|
|
52
|
+
| Argument | Default | |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| `api_key` | required | your router API key |
|
|
55
|
+
| `settings` | required | `TTSCacheRouterTTSService.Settings(...)`, below |
|
|
56
|
+
| `base_url` | `wss://api.ttscacherouter.dev` | set to your own router when self-hosting |
|
|
57
|
+
| `sample_rate` | the pipeline's output rate | one the provider streams: 8000, 16000, 22050 or 24000 for most; see [Models and options](https://docs.ttscacherouter.dev/reference/models) |
|
|
58
|
+
|
|
59
|
+
Other keyword arguments go to Pipecat's `WebsocketTTSService`, except `text_aggregation_mode`: the
|
|
60
|
+
router splits the text into sentences itself, so the service streams the LLM's text to it as it
|
|
61
|
+
arrives.
|
|
62
|
+
|
|
63
|
+
### `TTSCacheRouterTTSService.Settings(...)`
|
|
64
|
+
|
|
65
|
+
The settings are in the router's own names, the same for every provider:
|
|
66
|
+
|
|
67
|
+
| Setting | | |
|
|
68
|
+
|---|---|---|
|
|
69
|
+
| `model` | required | `"<provider>/<model>"`: `"sarvam/bulbul:v3"`, `"raya/standard"`, `"elevenlabs/eleven_flash_v2_5"`, `"openai/gpt-4o-mini-tts"`, `"deepgram/aura-2"`, `"xai/xai-tts"`, `"soniox/tts-rt-v2"`, `"smallestai/lightning_v3.1_pro"`, `"cartesia/sonic-3"`, … |
|
|
70
|
+
| `voice` | required | the provider's voice id (`GET /v1/voices` lists them) |
|
|
71
|
+
| `language` | `None` | the provider's own language code, where it takes one (`"hi-IN"` for Sarvam, `"hi"` for Raya, `"en"` for the rest) |
|
|
72
|
+
| `speed` | `None` | the speaking rate, where the provider takes one |
|
|
73
|
+
| `options` | `{}` | the provider's other settings, e.g. `{"temperature": 0.6}` for Sarvam, `{"voice_settings": {"stability": 0.5}}` for ElevenLabs, `{"instructions": "Speak warmly."}` for OpenAI |
|
|
74
|
+
|
|
75
|
+
Every provider's models, voices, languages and options are in
|
|
76
|
+
[Models and options](https://docs.ttscacherouter.dev/reference/models). The router checks the
|
|
77
|
+
settings when the pipeline starts, so a wrong one is reported then as an `ErrorFrame`.
|
|
78
|
+
|
|
79
|
+
### Changing settings mid-session
|
|
80
|
+
|
|
81
|
+
```python
|
|
82
|
+
from pipecat.frames.frames import TTSUpdateSettingsFrame
|
|
83
|
+
|
|
84
|
+
await worker.queue_frame(
|
|
85
|
+
TTSUpdateSettingsFrame(delta=TTSCacheRouterTTSService.Settings(voice="priya"))
|
|
86
|
+
)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Replies that start afterwards use the new settings. A `model` of another provider starts from no
|
|
90
|
+
`language`, `speed` or `options` unless the update gives them.
|
|
91
|
+
|
|
92
|
+
### Interruptions
|
|
93
|
+
|
|
94
|
+
When the user interrupts, the service tells the router to stop the reply, and the provider stops
|
|
95
|
+
the sentence it was synthesizing. The next reply starts on the same connection.
|
|
96
|
+
|
|
97
|
+
### Transcripts
|
|
98
|
+
|
|
99
|
+
The service's `TTSTextFrame`s follow the audio: each sentence's words as its audio starts, or word
|
|
100
|
+
by word with ElevenLabs and Cartesia.
|
|
101
|
+
|
|
102
|
+
### Metrics
|
|
103
|
+
|
|
104
|
+
With usage metrics on, each reply's `TTSUsageMetricsData` counts only the characters the provider
|
|
105
|
+
synthesized (and billed); sentences served from the cache count zero. Its `model` is
|
|
106
|
+
`"<provider>/<model>"`.
|
|
107
|
+
|
|
108
|
+
Once a reply is all sent, the service also calls its `on_cache_stats` handlers with a `CacheStats`:
|
|
109
|
+
the reply's `context_id`, `sentences`, `cached_sentences`, `characters` and `billed_characters`
|
|
110
|
+
(and `cached_characters`, the difference):
|
|
111
|
+
|
|
112
|
+
```python
|
|
113
|
+
@tts.event_handler("on_cache_stats")
|
|
114
|
+
async def on_cache_stats(tts, stats):
|
|
115
|
+
print(stats.cached_sentences, "of", stats.sentences, "sentences from the cache")
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Example
|
|
119
|
+
|
|
120
|
+
[`examples/pipecat_agent.py`](https://github.com/talqing/tts-cache-router/blob/main/examples/pipecat_agent.py)
|
|
121
|
+
is a complete bot: Deepgram speech-to-text, an OpenAI LLM and this service, on Pipecat's local
|
|
122
|
+
WebRTC runner. With `TTS_CACHE_ROUTER_API_KEY`, `DEEPGRAM_API_KEY` and `OPENAI_API_KEY` set:
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
cd examples
|
|
126
|
+
uv run pipecat_agent.py
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Then open http://localhost:7860/client and talk to it.
|
|
130
|
+
|
|
131
|
+
## License
|
|
132
|
+
|
|
133
|
+
Apache-2.0.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Copyright 2026 Oggnai Technologies Private Limited
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
"""tts-cache-router text-to-speech for Pipecat.
|
|
16
|
+
|
|
17
|
+
Serves repeated sentences from a per-account cache and synthesizes the rest at Sarvam, Raya,
|
|
18
|
+
ElevenLabs, OpenAI, Deepgram, xAI, Soniox, Smallest AI or Cartesia with your own provider key.
|
|
19
|
+
See https://docs.ttscacherouter.dev/pipecat.
|
|
20
|
+
"""
|
|
21
|
+
|
|
22
|
+
from .tts import CacheStats, TTSCacheRouterTTSService, TTSCacheRouterTTSSettings
|
|
23
|
+
from .version import __version__
|
|
24
|
+
|
|
25
|
+
__all__ = [
|
|
26
|
+
"TTSCacheRouterTTSService",
|
|
27
|
+
"TTSCacheRouterTTSSettings",
|
|
28
|
+
"CacheStats",
|
|
29
|
+
"__version__",
|
|
30
|
+
]
|
|
File without changes
|