livekit-plugins-voho 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.
@@ -0,0 +1,6 @@
1
+ __pycache__/
2
+ *.egg-info/
3
+ dist/
4
+ build/
5
+ .pytest_cache/
6
+ .venv/
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,152 @@
1
+ Metadata-Version: 2.5
2
+ Name: livekit-plugins-voho
3
+ Version: 0.1.0
4
+ Summary: Saudi Arabic voice for LiveKit Agents: Najdi and Hijazi accents, Arabic-English code-switching, streaming speech-to-text and text-to-speech.
5
+ Project-URL: Documentation, https://docs.voho.ai/livekit
6
+ Project-URL: Website, https://voho.ai
7
+ Project-URL: Source, https://github.com/yar-malik/livekit-plugins-voho
8
+ Project-URL: Issues, https://github.com/yar-malik/livekit-plugins-voho/issues
9
+ Author-email: Voho <hello@voho.ai>
10
+ License-Expression: Apache-2.0
11
+ License-File: LICENSE
12
+ Keywords: arabic,arabic stt,arabic tts,gulf arabic,hijazi,ksa,livekit,livekit-agents,najdi,saudi accent,saudi arabic,speech-to-text,text-to-speech,voice-agent
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Natural Language :: Arabic
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3 :: Only
18
+ Classifier: Topic :: Multimedia :: Sound/Audio
19
+ Classifier: Topic :: Multimedia :: Video
20
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
21
+ Requires-Python: >=3.9
22
+ Requires-Dist: aiohttp>=3.9
23
+ Requires-Dist: livekit-agents>=1.0
24
+ Provides-Extra: dev
25
+ Requires-Dist: numpy; extra == 'dev'
26
+ Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
27
+ Requires-Dist: pytest>=8; extra == 'dev'
28
+ Description-Content-Type: text/markdown
29
+
30
+ # livekit-plugins-voho
31
+
32
+ **Saudi Arabic voice for LiveKit Agents.** Speech-to-text and text-to-speech that sound like the Kingdom answers the phone: Najdi for Riyadh, Hijazi for Jeddah and Makkah, plus Omani, Gulf, Egyptian and Modern Standard Arabic. It also handles English mixed into the same sentence, because that is how Saudi callers actually talk.
33
+
34
+ ```bash
35
+ pip install livekit-plugins-voho
36
+ ```
37
+
38
+ ```python
39
+ from livekit.agents import AgentSession
40
+ from livekit.plugins import voho
41
+
42
+ session = AgentSession(
43
+ stt=voho.STT(language="ar-SA"), # Saudi Arabic, with English mixed in
44
+ tts=voho.TTS(voice="layla"), # a Najdi voice from Riyadh
45
+ llm=..., # any LiveKit LLM plugin
46
+ vad=..., # e.g. silero
47
+ )
48
+ ```
49
+
50
+ Get a key at [app.voho.ai](https://app.voho.ai), then `export VOHO_API_KEY=voho_sk_live_...`.
51
+
52
+ ---
53
+
54
+ ## Why a Saudi-specific plugin
55
+
56
+ Most "Arabic" voices are Modern Standard Arabic: the register of the news, not of a phone call. A Riyadh caller hears it as a recording. A Jeddah caller hears a Najdi agent as out of town, the way a London voice sounds in Glasgow. The dialect is not a detail. It is whether the caller stays on the line.
57
+
58
+ Voho is built around that:
59
+
60
+ - **Saudi dialects as separate voices.** Pick Najdi or Hijazi by name, and switch mid-call when a Jeddah caller rings a Riyadh line.
61
+ - **Arabic and English in one sentence.** "أبغى أغيّر الـ delivery address" is transcribed as said, rather than turned into nonsense at the switch.
62
+ - **Streaming both ways.** Text is spoken while the LLM is still writing the sentence, and transcripts arrive while the caller is still talking, so LiveKit's turn-taking and barge-in work as designed.
63
+ - **Telephone-ready.** Put a LiveKit SIP trunk in front of it and it answers a Saudi 9200, 800 or geographic number.
64
+ - **Saudi hosting for enterprise.** The same plugin points at an in-Kingdom or on-premise Voho deployment with one `base_url` change.
65
+
66
+ ## Voices
67
+
68
+ The dialect is the voice.
69
+
70
+ | Voice | Dialect | Where it sounds local | Good for |
71
+ | --- | --- | --- | --- |
72
+ | `layla` | Najdi, female | Riyadh, Qassim, the centre | Reception, appointments (default) |
73
+ | `nouf` | Najdi, female | Riyadh | Collections, compliance, escalations |
74
+ | `faisal` | Najdi, male | Riyadh | Banking, government, long policy text |
75
+ | `omar` | Najdi, male | Riyadh | Outbound confirmations, offers |
76
+ | `salma` | Hijazi, female | Jeddah, Makkah, Madinah | Everyday customer service |
77
+ | `rawan` | Hijazi, female | Jeddah | Retail, delivery |
78
+ | `hisham` | Hijazi, male | Jeddah | Banking, insurance |
79
+ | `tariq` | Hijazi, male | Jeddah | Bookings, follow-ups |
80
+ | `maryam` | Omani, female | Muscat, the interior | Energy, logistics, marine |
81
+ | `salim` | Omani, male | Muscat | Fleet, retail |
82
+ | `reem` | Gulf, female | UAE | Light, conversational |
83
+ | `maha` | Egyptian, female | Egypt | Reassuring, unhurried |
84
+ | `khalid`, `yousef` | Modern Standard | Region-neutral | Announcements, IVR |
85
+ | `clementine`, `astra`, `marlow`, `vespera` | English | | Expat and international lines |
86
+
87
+ ```python
88
+ tts.update_options(voice="salma") # a Jeddah caller on a Riyadh line
89
+ stt.update_options(language="en-US") # an English-only stretch
90
+ ```
91
+
92
+ **The voice sets the sound. The words set the dialect.** Tell your LLM which dialect to write in, or a Najdi voice will be reading Fusha. A Najdi agent says الحين, وش, زين and أبشر; a Hijazi one says دحين, إيش, إيوه and never says أبشر. [`examples/agent.py`](examples/agent.py) has a Najdi instruction that works.
93
+
94
+ ## A Saudi customer-service agent in one file
95
+
96
+ [`examples/agent.py`](examples/agent.py) is a complete agent for a Riyadh retailer: it speaks Najdi, follows the caller into English and back, stops when interrupted, and looks up an order with a tool mid-call.
97
+
98
+ ```bash
99
+ pip install "livekit-agents[openai,silero]" livekit-plugins-voho
100
+ export VOHO_API_KEY=... OPENAI_API_KEY=...
101
+ python examples/agent.py console
102
+ ```
103
+
104
+ To answer a phone number, create a LiveKit SIP inbound trunk and dispatch rule. The [LiveKit guide](https://docs.voho.ai/livekit) walks through it.
105
+
106
+ ## What the plugin calls
107
+
108
+ | Method | Voho API | |
109
+ | --- | --- | --- |
110
+ | `TTS.synthesize()` | `POST /v1/speech/stream` | Whole sentence in, chunked PCM out |
111
+ | `TTS.stream()` | `WS /v1/speech/ws` | Tokens in as the LLM writes, audio out as it is produced |
112
+ | `STT.recognize()` | `POST /v1/transcribe` | One utterance |
113
+ | `STT.stream()` | `WS /v1/transcribe/ws` | Interim and final transcripts while the caller speaks |
114
+
115
+ Audio is 16-bit mono PCM: 24 kHz from the TTS, 16 kHz into the STT. LiveKit resamples for the room.
116
+
117
+ ## Pricing
118
+
119
+ | | |
120
+ | --- | --- |
121
+ | Text-to-speech (`sada-1`, streaming) | 5¢ per 1,000 characters |
122
+ | Text-to-speech (`nabra-1`) | 2¢ per 1,000 characters |
123
+ | Speech-to-text | 3¢ per started minute |
124
+
125
+ Prepaid, per key. `GET /v1/usage` returns what a key used this month, in the units it was billed in.
126
+
127
+ ## Data and hosting
128
+
129
+ - Audio is not stored. Billing keeps character and minute counts, nothing else.
130
+ - The public API runs in London.
131
+ - In-Kingdom and on-premise deployments are available for enterprise contracts, with the same API and plugin. See [docs.voho.ai/on-prem/residency](https://docs.voho.ai/on-prem/residency).
132
+
133
+ ## Errors
134
+
135
+ Voho error codes appear in the exception message (`unauthorized`, `insufficient_credit`, `unknown_voice`, `text_too_long`), so the log says what to fix. Client errors are not retried. Server errors and rate limits are, using LiveKit's `APIConnectOptions`.
136
+
137
+ ## Development
138
+
139
+ ```bash
140
+ pip install -e ".[dev]"
141
+ pytest # against a local mock of the API, no key needed
142
+ VOHO_API_KEY=... pytest -m live # real synthesis, and a speak-then-transcribe round trip in Arabic
143
+ ```
144
+
145
+ ## Links
146
+
147
+ - LiveKit guide: [docs.voho.ai/livekit](https://docs.voho.ai/livekit)
148
+ - API reference: [docs.voho.ai](https://docs.voho.ai)
149
+ - Hear the voices: [voho.ai/demos](https://voho.ai/demos)
150
+ - Contact: support@voho.ai
151
+
152
+ Apache-2.0
@@ -0,0 +1,123 @@
1
+ # livekit-plugins-voho
2
+
3
+ **Saudi Arabic voice for LiveKit Agents.** Speech-to-text and text-to-speech that sound like the Kingdom answers the phone: Najdi for Riyadh, Hijazi for Jeddah and Makkah, plus Omani, Gulf, Egyptian and Modern Standard Arabic. It also handles English mixed into the same sentence, because that is how Saudi callers actually talk.
4
+
5
+ ```bash
6
+ pip install livekit-plugins-voho
7
+ ```
8
+
9
+ ```python
10
+ from livekit.agents import AgentSession
11
+ from livekit.plugins import voho
12
+
13
+ session = AgentSession(
14
+ stt=voho.STT(language="ar-SA"), # Saudi Arabic, with English mixed in
15
+ tts=voho.TTS(voice="layla"), # a Najdi voice from Riyadh
16
+ llm=..., # any LiveKit LLM plugin
17
+ vad=..., # e.g. silero
18
+ )
19
+ ```
20
+
21
+ Get a key at [app.voho.ai](https://app.voho.ai), then `export VOHO_API_KEY=voho_sk_live_...`.
22
+
23
+ ---
24
+
25
+ ## Why a Saudi-specific plugin
26
+
27
+ Most "Arabic" voices are Modern Standard Arabic: the register of the news, not of a phone call. A Riyadh caller hears it as a recording. A Jeddah caller hears a Najdi agent as out of town, the way a London voice sounds in Glasgow. The dialect is not a detail. It is whether the caller stays on the line.
28
+
29
+ Voho is built around that:
30
+
31
+ - **Saudi dialects as separate voices.** Pick Najdi or Hijazi by name, and switch mid-call when a Jeddah caller rings a Riyadh line.
32
+ - **Arabic and English in one sentence.** "أبغى أغيّر الـ delivery address" is transcribed as said, rather than turned into nonsense at the switch.
33
+ - **Streaming both ways.** Text is spoken while the LLM is still writing the sentence, and transcripts arrive while the caller is still talking, so LiveKit's turn-taking and barge-in work as designed.
34
+ - **Telephone-ready.** Put a LiveKit SIP trunk in front of it and it answers a Saudi 9200, 800 or geographic number.
35
+ - **Saudi hosting for enterprise.** The same plugin points at an in-Kingdom or on-premise Voho deployment with one `base_url` change.
36
+
37
+ ## Voices
38
+
39
+ The dialect is the voice.
40
+
41
+ | Voice | Dialect | Where it sounds local | Good for |
42
+ | --- | --- | --- | --- |
43
+ | `layla` | Najdi, female | Riyadh, Qassim, the centre | Reception, appointments (default) |
44
+ | `nouf` | Najdi, female | Riyadh | Collections, compliance, escalations |
45
+ | `faisal` | Najdi, male | Riyadh | Banking, government, long policy text |
46
+ | `omar` | Najdi, male | Riyadh | Outbound confirmations, offers |
47
+ | `salma` | Hijazi, female | Jeddah, Makkah, Madinah | Everyday customer service |
48
+ | `rawan` | Hijazi, female | Jeddah | Retail, delivery |
49
+ | `hisham` | Hijazi, male | Jeddah | Banking, insurance |
50
+ | `tariq` | Hijazi, male | Jeddah | Bookings, follow-ups |
51
+ | `maryam` | Omani, female | Muscat, the interior | Energy, logistics, marine |
52
+ | `salim` | Omani, male | Muscat | Fleet, retail |
53
+ | `reem` | Gulf, female | UAE | Light, conversational |
54
+ | `maha` | Egyptian, female | Egypt | Reassuring, unhurried |
55
+ | `khalid`, `yousef` | Modern Standard | Region-neutral | Announcements, IVR |
56
+ | `clementine`, `astra`, `marlow`, `vespera` | English | | Expat and international lines |
57
+
58
+ ```python
59
+ tts.update_options(voice="salma") # a Jeddah caller on a Riyadh line
60
+ stt.update_options(language="en-US") # an English-only stretch
61
+ ```
62
+
63
+ **The voice sets the sound. The words set the dialect.** Tell your LLM which dialect to write in, or a Najdi voice will be reading Fusha. A Najdi agent says الحين, وش, زين and أبشر; a Hijazi one says دحين, إيش, إيوه and never says أبشر. [`examples/agent.py`](examples/agent.py) has a Najdi instruction that works.
64
+
65
+ ## A Saudi customer-service agent in one file
66
+
67
+ [`examples/agent.py`](examples/agent.py) is a complete agent for a Riyadh retailer: it speaks Najdi, follows the caller into English and back, stops when interrupted, and looks up an order with a tool mid-call.
68
+
69
+ ```bash
70
+ pip install "livekit-agents[openai,silero]" livekit-plugins-voho
71
+ export VOHO_API_KEY=... OPENAI_API_KEY=...
72
+ python examples/agent.py console
73
+ ```
74
+
75
+ To answer a phone number, create a LiveKit SIP inbound trunk and dispatch rule. The [LiveKit guide](https://docs.voho.ai/livekit) walks through it.
76
+
77
+ ## What the plugin calls
78
+
79
+ | Method | Voho API | |
80
+ | --- | --- | --- |
81
+ | `TTS.synthesize()` | `POST /v1/speech/stream` | Whole sentence in, chunked PCM out |
82
+ | `TTS.stream()` | `WS /v1/speech/ws` | Tokens in as the LLM writes, audio out as it is produced |
83
+ | `STT.recognize()` | `POST /v1/transcribe` | One utterance |
84
+ | `STT.stream()` | `WS /v1/transcribe/ws` | Interim and final transcripts while the caller speaks |
85
+
86
+ Audio is 16-bit mono PCM: 24 kHz from the TTS, 16 kHz into the STT. LiveKit resamples for the room.
87
+
88
+ ## Pricing
89
+
90
+ | | |
91
+ | --- | --- |
92
+ | Text-to-speech (`sada-1`, streaming) | 5¢ per 1,000 characters |
93
+ | Text-to-speech (`nabra-1`) | 2¢ per 1,000 characters |
94
+ | Speech-to-text | 3¢ per started minute |
95
+
96
+ Prepaid, per key. `GET /v1/usage` returns what a key used this month, in the units it was billed in.
97
+
98
+ ## Data and hosting
99
+
100
+ - Audio is not stored. Billing keeps character and minute counts, nothing else.
101
+ - The public API runs in London.
102
+ - In-Kingdom and on-premise deployments are available for enterprise contracts, with the same API and plugin. See [docs.voho.ai/on-prem/residency](https://docs.voho.ai/on-prem/residency).
103
+
104
+ ## Errors
105
+
106
+ Voho error codes appear in the exception message (`unauthorized`, `insufficient_credit`, `unknown_voice`, `text_too_long`), so the log says what to fix. Client errors are not retried. Server errors and rate limits are, using LiveKit's `APIConnectOptions`.
107
+
108
+ ## Development
109
+
110
+ ```bash
111
+ pip install -e ".[dev]"
112
+ pytest # against a local mock of the API, no key needed
113
+ VOHO_API_KEY=... pytest -m live # real synthesis, and a speak-then-transcribe round trip in Arabic
114
+ ```
115
+
116
+ ## Links
117
+
118
+ - LiveKit guide: [docs.voho.ai/livekit](https://docs.voho.ai/livekit)
119
+ - API reference: [docs.voho.ai](https://docs.voho.ai)
120
+ - Hear the voices: [voho.ai/demos](https://voho.ai/demos)
121
+ - Contact: support@voho.ai
122
+
123
+ Apache-2.0
@@ -0,0 +1,71 @@
1
+ """A Saudi customer-service agent on LiveKit, speaking through Voho.
2
+
3
+ export VOHO_API_KEY=voho_sk_live_...
4
+ export OPENAI_API_KEY=... # or any LiveKit LLM plugin
5
+ export LIVEKIT_URL=... LIVEKIT_API_KEY=... LIVEKIT_API_SECRET=...
6
+ pip install "livekit-agents[openai,silero]" livekit-plugins-voho
7
+ python examples/agent.py console # talk to it from the terminal
8
+ python examples/agent.py dev # join a LiveKit room
9
+
10
+ What it demonstrates, because these are the things a buyer asks to hear:
11
+ Najdi rather than textbook Arabic; the caller switching to English and back;
12
+ being interrupted and stopping; and a tool call mid-sentence that the caller
13
+ hears the result of. Point a SIP trunk at the room and it answers a phone —
14
+ see docs.voho.ai/livekit for the trunk and dispatch rule.
15
+ """
16
+
17
+ import logging
18
+
19
+ from livekit.agents import Agent, AgentSession, JobContext, WorkerOptions, cli, function_tool
20
+ from livekit.plugins import openai, silero, voho
21
+
22
+ logger = logging.getLogger("voho-example")
23
+
24
+ INSTRUCTIONS = """You answer the customer line for Sanam Stores, a Riyadh retailer.
25
+
26
+ You speak Saudi Arabic in the Najdi dialect: الحين for now, إي for yes, وش for what, زين for good, أبشر when agreeing to do something, يعطيك العافية to close. If the caller switches to English, switch with them and switch back when they do.
27
+
28
+ Short sentences, two at a time. One question per turn. Read numbers back and get a yes before using them. If the caller interrupts, stop and listen. If you do not know something, say so and offer a person. Never invent an order, a price or a date.
29
+
30
+ To check an order, use the tool. Never guess an order's status."""
31
+
32
+
33
+ class SanamAgent(Agent):
34
+ def __init__(self) -> None:
35
+ super().__init__(instructions=INSTRUCTIONS)
36
+
37
+ @function_tool
38
+ async def get_order_status(self, order_number: str) -> str:
39
+ """Look up an order by its number and return its status.
40
+
41
+ Args:
42
+ order_number: The order number the caller read out, digits only.
43
+ """
44
+ # A real line reaches the order system here. The demo answers from a
45
+ # table so the call has something true to say.
46
+ orders = {
47
+ "4471": "shipped yesterday, arriving tomorrow before 6pm with SMSA",
48
+ "2209": "being packed, ships today",
49
+ }
50
+ return orders.get(order_number.strip(), "no order found with that number")
51
+
52
+
53
+ async def entrypoint(ctx: JobContext) -> None:
54
+ await ctx.connect()
55
+
56
+ session = AgentSession(
57
+ stt=voho.STT(language="ar-SA"),
58
+ llm=openai.LLM(model="gpt-4o-mini"),
59
+ tts=voho.TTS(voice="layla"),
60
+ vad=silero.VAD.load(),
61
+ # Barge-in: the caller talking over the agent stops it mid-sentence.
62
+ allow_interruptions=True,
63
+ min_endpointing_delay=0.4,
64
+ )
65
+
66
+ await session.start(agent=SanamAgent(), room=ctx.room)
67
+ await session.say("أهلاً وسهلاً في متاجر سنام، معك ليلى. كيف أقدر أساعدك؟", allow_interruptions=True)
68
+
69
+
70
+ if __name__ == "__main__":
71
+ cli.run_app(WorkerOptions(entrypoint_fnc=entrypoint))
@@ -0,0 +1,53 @@
1
+ """Voho for LiveKit Agents: Arabic speech, Saudi and Gulf dialects.
2
+
3
+ from livekit.plugins import voho
4
+
5
+ session = AgentSession(
6
+ stt=voho.STT(language="ar-SA"),
7
+ tts=voho.TTS(voice="layla"),
8
+ llm=...,
9
+ )
10
+
11
+ Set ``VOHO_API_KEY`` or pass ``api_key=``. Keys are created at
12
+ https://app.voho.ai/tokens and billed there. Docs: https://docs.voho.ai/livekit
13
+ """
14
+
15
+ from .models import DEFAULT_LANGUAGE, DEFAULT_MODEL, DEFAULT_VOICE, STTLanguage, TTSModel, TTSVoice
16
+ from .stt import STT, RecognizeStream
17
+ from .tts import TTS, ChunkedStream, SynthesizeStream
18
+ from .version import __version__
19
+
20
+ __all__ = [
21
+ "STT",
22
+ "TTS",
23
+ "RecognizeStream",
24
+ "ChunkedStream",
25
+ "SynthesizeStream",
26
+ "STTLanguage",
27
+ "TTSModel",
28
+ "TTSVoice",
29
+ "DEFAULT_LANGUAGE",
30
+ "DEFAULT_MODEL",
31
+ "DEFAULT_VOICE",
32
+ "__version__",
33
+ ]
34
+
35
+ from livekit.agents import Plugin # noqa: E402
36
+
37
+ from .log import logger # noqa: E402
38
+
39
+
40
+ class VohoPlugin(Plugin):
41
+ def __init__(self) -> None:
42
+ super().__init__(__name__, __version__, __package__, logger)
43
+
44
+
45
+ Plugin.register_plugin(VohoPlugin())
46
+
47
+ # Cleanup docs of unexported modules
48
+ _module = dir()
49
+ NOT_IN_ALL = [m for m in _module if m not in __all__]
50
+
51
+ __pdoc__ = {}
52
+ for n in NOT_IN_ALL:
53
+ __pdoc__[n] = False