End of utterance detection for LiveKit Agents
Project description
Turn detector plugin for LiveKit Agents
This plugin introduces end-of-turn detection for LiveKit Agents using a custom open-weight model to determine when a user has finished speaking.
Traditional voice agents use VAD (voice activity detection) for end-of-turn detection. However, VAD models lack language understanding, often causing false positives where the agent interrupts the user before they finish speaking.
By leveraging a language model specifically trained for this task, this plugin offers a more accurate and robust method for detecting end-of-turns.
See https://docs.livekit.io/agents/build/turns/turn-detector/ for more information.
Installation
pip install livekit-plugins-turn-detector
Usage
Multilingual model
We've trained a multilingual model that supports the following languages: English, French, Spanish, German, Italian, Portuguese, Dutch, Chinese, Japanese, Korean, Indonesian, Russian, Turkish
The multilingual model requires ~400MB of RAM and completes inferences in ~25ms.
from livekit.plugins.turn_detector.multilingual import MultilingualModel
session = AgentSession(
...
turn_detection=MultilingualModel(),
)
Usage with RealtimeModel
The turn detector can be used even with speech-to-speech models such as OpenAI's Realtime API. You'll need to provide a separate STT to ensure our model has access to the text content.
session = AgentSession(
...
stt=deepgram.STT(model="nova-3", language="multi"),
llm=openai.realtime.RealtimeModel(),
turn_detection=MultilingualModel(),
)
Running your agent
This plugin requires model files. Before starting your agent for the first time, or when building Docker images for deployment, run the following command to download the model files:
python my_agent.py download-files
Downloaded model files
Model files are downloaded to and loaded from the location specified by the HF_HUB_CACHE environment variable. If not set, this defaults to $HF_HOME/hub (typically ~/.cache/huggingface/hub).
For offline deployment, download the model files first while connected to the internet, then copy the cache directory to your deployment environment.
Model system requirements
The end-of-turn model is optimized to run on CPUs with modest system requirements. It is designed to run on the same server hosting your agents.
The model requires <500MB of RAM and runs within a shared inference server, supporting multiple concurrent sessions.
License
The plugin source code is licensed under the Apache-2.0 license.
The end-of-turn model is licensed under the LiveKit Model License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file livekit_plugins_turn_detector-1.3.9.tar.gz.
File metadata
- Download URL: livekit_plugins_turn_detector-1.3.9.tar.gz
- Upload date:
- Size: 8.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0d765b75f6450001807714437976d16dcbcc7d8447b8457b400444b6f0a99df0
|
|
| MD5 |
b0ba33b2c59110af9a724a6d12a0ecd3
|
|
| BLAKE2b-256 |
e3355852d8c1d188278a947ac10a46e5938591406007b892eec122fc99f6b706
|
File details
Details for the file livekit_plugins_turn_detector-1.3.9-py3-none-any.whl.
File metadata
- Download URL: livekit_plugins_turn_detector-1.3.9-py3-none-any.whl
- Upload date:
- Size: 10.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db759319e962dde65699dc970f65467b6fb471341d393c40c7c0714001021b0d
|
|
| MD5 |
9841ee700d2c296847d7f4983a906367
|
|
| BLAKE2b-256 |
521f66a2d3044990b96eb406ce9cbd86dfd7db10837e5f53f6d4b6463257626a
|