Skip to main content

End of utterance detection for LiveKit Agents

Project description

LiveKit Plugins Turn Detector

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. The current version supports English only and should not be used when targeting other languages.

Installation

pip install livekit-plugins-turn-detector

Usage

This plugin is designed to be used with the VoicePipelineAgent:

from livekit.plugins import turn_detector

agent = VoicePipelineAgent(
    ...
    turn_detector=turn_detector.EOUModel(),
)

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

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. On a 4-core server instance, it completes inference in ~50ms with minimal CPU usage.

The model requires 1.5GB of RAM and runs within a shared inference server, supporting multiple concurrent sessions.

We are working to reduce the CPU and memory requirements in future releases.

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

livekit_plugins_turn_detector-1.0.0rc1.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file livekit_plugins_turn_detector-1.0.0rc1.tar.gz.

File metadata

File hashes

Hashes for livekit_plugins_turn_detector-1.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 7bffe7151bd76bc31931f40e1d3f7ca6b8428db4418a0b71f2397cf13752589d
MD5 0434ff34b3491ee1ba90f0b0e5a99d0d
BLAKE2b-256 30f3da28aa85e6f9019122fc85dff5f36a2d45fea3379d1e6183c14f21538a55

See more details on using hashes here.

File details

Details for the file livekit_plugins_turn_detector-1.0.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for livekit_plugins_turn_detector-1.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 28c77038e0a5877c085978b60df7d2587628e27d77d48b583dbb9639c14e4e0f
MD5 9b1f0d05bdb48bafcb269f4e42fc5ccc
BLAKE2b-256 2c5dbe2854917a20f98c18bb9d197951054a936947c3f89a09e84597521b4dc0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page