livekit-plugins-aircaps 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,10 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.egg-info/
4
+ dist/
5
+ build/
6
+ .env
7
+ .pytest_cache/
8
+ .ruff_cache/
9
+ .mypy_cache/
10
+ .DS_Store
@@ -0,0 +1,28 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project are documented here. The format follows
4
+ [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
5
+ [Semantic Versioning](https://semver.org/).
6
+
7
+ ## [Unreleased]
8
+
9
+ ## [0.1.0] - 2026-11-19
10
+
11
+ ### Added
12
+
13
+ - `aircaps.STT`: streaming speech-to-text with AirCaps Live 1 (`aircaps-live-1`) for LiveKit Agents. Interim
14
+ transcripts while the user speaks; a final transcript per turn when the stream is flushed (`manual_flush`), or when
15
+ the model detects the end of the turn (`end_of_turn=True`, with `end_of_turn_mode` and single-value overrides).
16
+ - Start/end-of-speech events around each worded turn, recognition usage events, and `update_options()` for open
17
+ streams.
18
+ - Endpoint lookup before each session; reconnection with a new lookup when a session drops or ends; a turn cut short
19
+ by a dropped session ends with its text so far; refused keys, models and options are not retried.
20
+ - Audio paced to real time, and at most the newest 1.25 s of audio that queued while a session connected is sent.
21
+ - Keepalive pings while no audio is sent.
22
+ - Example voice agent `examples/agent.py`.
23
+ - Tests against a local fake of the AirCaps API.
24
+
25
+ Tested with LiveKit Agents 1.8.13.
26
+
27
+ [Unreleased]: https://github.com/aircaps/livekit-plugins-aircaps/compare/v0.1.0...HEAD
28
+ [0.1.0]: https://github.com/aircaps/livekit-plugins-aircaps/releases/tag/v0.1.0
@@ -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,165 @@
1
+ Metadata-Version: 2.5
2
+ Name: livekit-plugins-aircaps
3
+ Version: 0.1.0
4
+ Summary: AirCaps Live speech-to-text for LiveKit Agents
5
+ Project-URL: Homepage, https://aircaps.ai
6
+ Project-URL: Documentation, https://aircaps.ai/docs/guides/live-1
7
+ Project-URL: Repository, https://github.com/aircaps/livekit-plugins-aircaps
8
+ Project-URL: Issues, https://github.com/aircaps/livekit-plugins-aircaps/issues
9
+ Project-URL: Changelog, https://github.com/aircaps/livekit-plugins-aircaps/blob/main/CHANGELOG.md
10
+ Author: AirCaps
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ Keywords: agents,aircaps,audio,livekit,realtime,speech-to-text,stt,webrtc
14
+ Classifier: Development Status :: 4 - Beta
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3 :: Only
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
24
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
25
+ Classifier: Typing :: Typed
26
+ Requires-Python: >=3.10.0
27
+ Requires-Dist: livekit-agents<2,>=1.8.13
28
+ Provides-Extra: example
29
+ Requires-Dist: livekit-agents[silero]<2,>=1.8.13; extra == 'example'
30
+ Requires-Dist: python-dotenv; extra == 'example'
31
+ Description-Content-Type: text/markdown
32
+
33
+ # livekit-plugins-aircaps
34
+
35
+ [![PyPI](https://img.shields.io/pypi/v/livekit-plugins-aircaps)](https://pypi.org/project/livekit-plugins-aircaps/)
36
+ [![CI](https://github.com/aircaps/livekit-plugins-aircaps/actions/workflows/ci.yml/badge.svg)](https://github.com/aircaps/livekit-plugins-aircaps/actions/workflows/ci.yml)
37
+
38
+ [AirCaps](https://aircaps.ai) speech-to-text for [LiveKit Agents](https://github.com/livekit/agents).
39
+
40
+ `aircaps.STT` streams the user's audio to **AirCaps Live 1** (`aircaps-live-1`), a low-latency real-time English
41
+ speech-to-text model built for voice agents. It sends interim transcripts while the user speaks and the turn's final
42
+ transcript the moment the turn ends: when LiveKit's turn handling says so, or, with `end_of_turn=True`, when the model
43
+ detects it.
44
+
45
+ Maintained by AirCaps, the company that provides AirCaps Live 1.
46
+
47
+ ## Installation
48
+
49
+ ```bash
50
+ pip install livekit-plugins-aircaps
51
+ ```
52
+
53
+ or `uv add livekit-plugins-aircaps`.
54
+
55
+ ## Prerequisites
56
+
57
+ An AirCaps API key: sign in to the [AirCaps console](https://console.aircaps.ai), open **API keys** and create one.
58
+ AirCaps Live 1 is available to every account, one session at a time by default
59
+ ([talk to us](https://aircaps.ai/contact) for more). The [AirCaps Live 1 guide](https://aircaps.ai/docs/guides/live-1)
60
+ describes the model and its protocol.
61
+
62
+ ```bash
63
+ export AIRCAPS_API_KEY=...
64
+ ```
65
+
66
+ ## Usage
67
+
68
+ By default the session's own turn handling decides when the user has finished speaking. LiveKit flushes the stream
69
+ at the end of each turn (from its VAD or turn detector, or a manual commit), and the final transcript comes back right
70
+ away:
71
+
72
+ ```python
73
+ from livekit.agents import AgentSession
74
+ from livekit.plugins import aircaps, silero
75
+
76
+ session = AgentSession(
77
+ stt=aircaps.STT(),
78
+ vad=silero.VAD.load(),
79
+ # ... llm, tts, turn_handling, etc.
80
+ )
81
+ ```
82
+
83
+ Without a flush, words stay interim until the stream ends, so use a VAD (or a turn detector) in this mode.
84
+
85
+ ### Model-detected end of turn
86
+
87
+ To let AirCaps detect the end of each turn instead, turn on `end_of_turn` and use the STT's turn detection. The
88
+ model's end of turn has already waited out the user's pause, so set LiveKit's own endpointing delay to 0 (its default
89
+ adds 0.5 s to every turn):
90
+
91
+ ```python
92
+ from livekit.agents import AgentSession, TurnHandlingOptions
93
+ from livekit.plugins import aircaps
94
+
95
+ session = AgentSession(
96
+ stt=aircaps.STT(end_of_turn=True, end_of_turn_mode="balanced"),
97
+ turn_handling=TurnHandlingOptions(turn_detection="stt", endpointing={"min_delay": 0}),
98
+ # ... llm, tts, vad, etc.
99
+ )
100
+ ```
101
+
102
+ ### Options
103
+
104
+ | Option | Default | |
105
+ | --- | --- | --- |
106
+ | `model` | `"aircaps-live-1"` | The AirCaps model |
107
+ | `end_of_turn` | `False` | Let the model detect the end of each turn |
108
+ | `end_of_turn_mode` | `"balanced"` | `"min_latency"`, `"balanced"` or `"max_accuracy"`. A mode sets the values below; any of them given beside it overrides that one |
109
+ | `end_of_turn_threshold` | the mode's | How sure the model must be that the turn ended, 0.2 to 0.9 |
110
+ | `min_turn_silence_ms` | the mode's | The shortest pause that can end a turn, 0 to 1000 ms |
111
+ | `max_turn_silence_ms` | the mode's | A pause this long always ends the turn, 500 to 5000 ms, or 0 for no limit |
112
+ | `vad_threshold` | the mode's | How sure the model's voice detector must be that a sound is speech, 0.3 to 0.9 |
113
+ | `api_key` | `AIRCAPS_API_KEY` | AirCaps API key |
114
+ | `base_url` | `"https://api.aircaps.com"` | AirCaps API address |
115
+ | `http_session` | LiveKit's shared session | An `aiohttp.ClientSession` to use |
116
+
117
+ `stt.update_options(...)` changes the end-of-turn settings, also for streams already open.
118
+
119
+ Audio is resampled to 16 kHz mono. The model transcribes English and supports streaming recognition only; key terms
120
+ and speaker labels are not available.
121
+
122
+ How it works:
123
+
124
+ - Before each session the plugin asks the AirCaps API where to connect
125
+ (`GET /v1/realtime/endpoint?model=aircaps-live-1`), then opens that WebSocket, so audio goes to the nearest server.
126
+ - A flush sends `finalize`; the turn's final transcript comes straight back.
127
+ - A dropped or ended session (sessions last up to an hour) is reopened, with a new address lookup. A turn cut short by
128
+ the drop ends with its text so far.
129
+
130
+ ## Running the example
131
+
132
+ [`examples/agent.py`](examples/agent.py) is LiveKit's basic voice agent with AirCaps as its speech-to-text (the LLM
133
+ and the voice come from LiveKit Inference).
134
+
135
+ ```bash
136
+ git clone https://github.com/aircaps/livekit-plugins-aircaps.git
137
+ cd livekit-plugins-aircaps
138
+ cp .env.example .env # add AIRCAPS_API_KEY and your LiveKit project's URL, key and secret
139
+ uv sync --extra example
140
+ uv run examples/agent.py console
141
+ ```
142
+
143
+ `console` runs the agent in your terminal with your microphone and speakers; `dev` connects it to your LiveKit
144
+ project. `AIRCAPS_END_OF_TURN=1` switches it to model-detected end of turn.
145
+
146
+ ## Tests
147
+
148
+ ```bash
149
+ uv sync
150
+ uv run pytest
151
+ ```
152
+
153
+ The tests run against a local fake of the AirCaps API; no key is needed.
154
+
155
+ ## Compatibility
156
+
157
+ Tested with LiveKit Agents 1.8.13, on Python 3.10 to 3.13.
158
+
159
+ ## Support
160
+
161
+ Open an [issue](https://github.com/aircaps/livekit-plugins-aircaps/issues), or [contact AirCaps](https://aircaps.ai/contact).
162
+
163
+ ## License
164
+
165
+ Apache 2.0, see [LICENSE](LICENSE).
@@ -0,0 +1,133 @@
1
+ # livekit-plugins-aircaps
2
+
3
+ [![PyPI](https://img.shields.io/pypi/v/livekit-plugins-aircaps)](https://pypi.org/project/livekit-plugins-aircaps/)
4
+ [![CI](https://github.com/aircaps/livekit-plugins-aircaps/actions/workflows/ci.yml/badge.svg)](https://github.com/aircaps/livekit-plugins-aircaps/actions/workflows/ci.yml)
5
+
6
+ [AirCaps](https://aircaps.ai) speech-to-text for [LiveKit Agents](https://github.com/livekit/agents).
7
+
8
+ `aircaps.STT` streams the user's audio to **AirCaps Live 1** (`aircaps-live-1`), a low-latency real-time English
9
+ speech-to-text model built for voice agents. It sends interim transcripts while the user speaks and the turn's final
10
+ transcript the moment the turn ends: when LiveKit's turn handling says so, or, with `end_of_turn=True`, when the model
11
+ detects it.
12
+
13
+ Maintained by AirCaps, the company that provides AirCaps Live 1.
14
+
15
+ ## Installation
16
+
17
+ ```bash
18
+ pip install livekit-plugins-aircaps
19
+ ```
20
+
21
+ or `uv add livekit-plugins-aircaps`.
22
+
23
+ ## Prerequisites
24
+
25
+ An AirCaps API key: sign in to the [AirCaps console](https://console.aircaps.ai), open **API keys** and create one.
26
+ AirCaps Live 1 is available to every account, one session at a time by default
27
+ ([talk to us](https://aircaps.ai/contact) for more). The [AirCaps Live 1 guide](https://aircaps.ai/docs/guides/live-1)
28
+ describes the model and its protocol.
29
+
30
+ ```bash
31
+ export AIRCAPS_API_KEY=...
32
+ ```
33
+
34
+ ## Usage
35
+
36
+ By default the session's own turn handling decides when the user has finished speaking. LiveKit flushes the stream
37
+ at the end of each turn (from its VAD or turn detector, or a manual commit), and the final transcript comes back right
38
+ away:
39
+
40
+ ```python
41
+ from livekit.agents import AgentSession
42
+ from livekit.plugins import aircaps, silero
43
+
44
+ session = AgentSession(
45
+ stt=aircaps.STT(),
46
+ vad=silero.VAD.load(),
47
+ # ... llm, tts, turn_handling, etc.
48
+ )
49
+ ```
50
+
51
+ Without a flush, words stay interim until the stream ends, so use a VAD (or a turn detector) in this mode.
52
+
53
+ ### Model-detected end of turn
54
+
55
+ To let AirCaps detect the end of each turn instead, turn on `end_of_turn` and use the STT's turn detection. The
56
+ model's end of turn has already waited out the user's pause, so set LiveKit's own endpointing delay to 0 (its default
57
+ adds 0.5 s to every turn):
58
+
59
+ ```python
60
+ from livekit.agents import AgentSession, TurnHandlingOptions
61
+ from livekit.plugins import aircaps
62
+
63
+ session = AgentSession(
64
+ stt=aircaps.STT(end_of_turn=True, end_of_turn_mode="balanced"),
65
+ turn_handling=TurnHandlingOptions(turn_detection="stt", endpointing={"min_delay": 0}),
66
+ # ... llm, tts, vad, etc.
67
+ )
68
+ ```
69
+
70
+ ### Options
71
+
72
+ | Option | Default | |
73
+ | --- | --- | --- |
74
+ | `model` | `"aircaps-live-1"` | The AirCaps model |
75
+ | `end_of_turn` | `False` | Let the model detect the end of each turn |
76
+ | `end_of_turn_mode` | `"balanced"` | `"min_latency"`, `"balanced"` or `"max_accuracy"`. A mode sets the values below; any of them given beside it overrides that one |
77
+ | `end_of_turn_threshold` | the mode's | How sure the model must be that the turn ended, 0.2 to 0.9 |
78
+ | `min_turn_silence_ms` | the mode's | The shortest pause that can end a turn, 0 to 1000 ms |
79
+ | `max_turn_silence_ms` | the mode's | A pause this long always ends the turn, 500 to 5000 ms, or 0 for no limit |
80
+ | `vad_threshold` | the mode's | How sure the model's voice detector must be that a sound is speech, 0.3 to 0.9 |
81
+ | `api_key` | `AIRCAPS_API_KEY` | AirCaps API key |
82
+ | `base_url` | `"https://api.aircaps.com"` | AirCaps API address |
83
+ | `http_session` | LiveKit's shared session | An `aiohttp.ClientSession` to use |
84
+
85
+ `stt.update_options(...)` changes the end-of-turn settings, also for streams already open.
86
+
87
+ Audio is resampled to 16 kHz mono. The model transcribes English and supports streaming recognition only; key terms
88
+ and speaker labels are not available.
89
+
90
+ How it works:
91
+
92
+ - Before each session the plugin asks the AirCaps API where to connect
93
+ (`GET /v1/realtime/endpoint?model=aircaps-live-1`), then opens that WebSocket, so audio goes to the nearest server.
94
+ - A flush sends `finalize`; the turn's final transcript comes straight back.
95
+ - A dropped or ended session (sessions last up to an hour) is reopened, with a new address lookup. A turn cut short by
96
+ the drop ends with its text so far.
97
+
98
+ ## Running the example
99
+
100
+ [`examples/agent.py`](examples/agent.py) is LiveKit's basic voice agent with AirCaps as its speech-to-text (the LLM
101
+ and the voice come from LiveKit Inference).
102
+
103
+ ```bash
104
+ git clone https://github.com/aircaps/livekit-plugins-aircaps.git
105
+ cd livekit-plugins-aircaps
106
+ cp .env.example .env # add AIRCAPS_API_KEY and your LiveKit project's URL, key and secret
107
+ uv sync --extra example
108
+ uv run examples/agent.py console
109
+ ```
110
+
111
+ `console` runs the agent in your terminal with your microphone and speakers; `dev` connects it to your LiveKit
112
+ project. `AIRCAPS_END_OF_TURN=1` switches it to model-detected end of turn.
113
+
114
+ ## Tests
115
+
116
+ ```bash
117
+ uv sync
118
+ uv run pytest
119
+ ```
120
+
121
+ The tests run against a local fake of the AirCaps API; no key is needed.
122
+
123
+ ## Compatibility
124
+
125
+ Tested with LiveKit Agents 1.8.13, on Python 3.10 to 3.13.
126
+
127
+ ## Support
128
+
129
+ Open an [issue](https://github.com/aircaps/livekit-plugins-aircaps/issues), or [contact AirCaps](https://aircaps.ai/contact).
130
+
131
+ ## License
132
+
133
+ Apache 2.0, see [LICENSE](LICENSE).
@@ -0,0 +1,64 @@
1
+ """A voice agent that listens with AirCaps Live 1.
2
+
3
+ LiveKit's basic voice agent with AirCaps as its speech-to-text; the LLM and the voice come from LiveKit Inference.
4
+
5
+ uv sync --extra example
6
+ uv run examples/agent.py console # talk to it in the terminal
7
+ uv run examples/agent.py dev # or join it from a LiveKit room
8
+
9
+ Set AIRCAPS_API_KEY, and LIVEKIT_URL, LIVEKIT_API_KEY and LIVEKIT_API_SECRET for your LiveKit project (in .env).
10
+ Set AIRCAPS_END_OF_TURN=1 to let the AirCaps model decide when each turn ends.
11
+ """
12
+
13
+ import os
14
+
15
+ from dotenv import load_dotenv
16
+
17
+ from livekit.agents import (
18
+ Agent,
19
+ AgentServer,
20
+ AgentSession,
21
+ JobContext,
22
+ TurnHandlingOptions,
23
+ cli,
24
+ inference,
25
+ )
26
+ from livekit.plugins import aircaps, silero
27
+
28
+ load_dotenv()
29
+
30
+ END_OF_TURN = os.environ.get("AIRCAPS_END_OF_TURN") == "1"
31
+
32
+
33
+ class Assistant(Agent):
34
+ def __init__(self) -> None:
35
+ super().__init__(
36
+ instructions="You are a helpful assistant in a voice conversation. Keep your answers short, "
37
+ "and do not use emojis, markdown or other formatting that cannot be spoken."
38
+ )
39
+
40
+ async def on_enter(self) -> None:
41
+ self.session.generate_reply(instructions="Greet the user and offer your help.")
42
+
43
+
44
+ server = AgentServer()
45
+
46
+
47
+ @server.rtc_session()
48
+ async def entrypoint(ctx: JobContext) -> None:
49
+ session = AgentSession(
50
+ stt=aircaps.STT(end_of_turn=END_OF_TURN),
51
+ llm=inference.LLM("openai/gpt-4.1-mini"),
52
+ tts=inference.TTS("cartesia/sonic-3", voice="9626c31c-bec5-4cca-baa8-f8ba9e84c8bc"),
53
+ vad=silero.VAD.load(),
54
+ # With AirCaps end of turn, the model's decision already includes the user's pause:
55
+ # LiveKit adds no delay of its own.
56
+ turn_handling=TurnHandlingOptions(turn_detection="stt", endpointing={"min_delay": 0})
57
+ if END_OF_TURN
58
+ else TurnHandlingOptions(turn_detection="vad"),
59
+ )
60
+ await session.start(agent=Assistant(), room=ctx.room)
61
+
62
+
63
+ if __name__ == "__main__":
64
+ cli.run_app(server)
@@ -0,0 +1,46 @@
1
+ # Copyright 2026 AirCaps
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
+ """AirCaps plugin for LiveKit Agents
16
+
17
+ Streaming speech-to-text with AirCaps Live.
18
+ """
19
+
20
+ from .models import EndOfTurnMode, STTModels
21
+ from .stt import STT, SpeechStream, STTOptions
22
+ from .version import __version__
23
+
24
+ __all__ = ["STT", "SpeechStream", "STTOptions", "STTModels", "EndOfTurnMode", "__version__"]
25
+
26
+
27
+ from livekit.agents import Plugin
28
+
29
+ from .log import logger
30
+
31
+
32
+ class AirCapsPlugin(Plugin):
33
+ def __init__(self) -> None:
34
+ super().__init__(__name__, __version__, __package__, logger)
35
+
36
+
37
+ Plugin.register_plugin(AirCapsPlugin())
38
+
39
+ # Cleanup docs of unexported modules
40
+ _module = dir()
41
+ NOT_IN_ALL = [m for m in _module if m not in __all__]
42
+
43
+ __pdoc__ = {}
44
+
45
+ for n in NOT_IN_ALL:
46
+ __pdoc__[n] = False
@@ -0,0 +1,3 @@
1
+ import logging
2
+
3
+ logger = logging.getLogger("livekit.plugins.aircaps")
@@ -0,0 +1,19 @@
1
+ # Copyright 2026 AirCaps
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
+ from typing import Literal
16
+
17
+ STTModels = Literal["aircaps-live-1"]
18
+
19
+ EndOfTurnMode = Literal["min_latency", "balanced", "max_accuracy"]