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.0rc4.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.0rc4.tar.gz.

File metadata

File hashes

Hashes for livekit_plugins_turn_detector-1.0.0rc4.tar.gz
Algorithm Hash digest
SHA256 2770ecf1164809d98268eaf90aeeaebd3f4a6dadcb64269e778f49a3008216a7
MD5 7c9c9d1c72b3e5f09cd022e16d52f3fc
BLAKE2b-256 22da0036448cc84df57854bb4fb6f42d9143198d64c4410ab3c6ebd98ebf6791

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for livekit_plugins_turn_detector-1.0.0rc4-py3-none-any.whl
Algorithm Hash digest
SHA256 53d7d13028c953bd253fd2283f72d45d2ad0cf2ab958ae3efe4aa23e1886d4ee
MD5 f5a3de637215d0f9e2d5336a87fdacc2
BLAKE2b-256 5033dfb7e9fb361f3584a3e1d806ef661b6a5d651d275ab77726098b5669999f

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