Skip to main content

End of utterance detection for LiveKit Agents

Project description

Turn detector plugin for LiveKit Agents

⚠️ Deprecated. This plugin is deprecated and will be removed in a future release. Use livekit.agents.inference.AudioTurnDetector instead — it ships with livekit-agents, requires no additional install, and replaces both the English and Multilingual text-based models with a unified audio end-of-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.

See https://docs.livekit.io/agents/build/turns/turn-detector/ for more information.

Usage

The recommended replacement is AudioTurnDetector, available from livekit-agents directly:

from livekit.agents.inference import AudioTurnDetector

session = AgentSession(
    ...
    turn_detection=AudioTurnDetector(),
)

Usage with RealtimeModel

AudioTurnDetector works with speech-to-speech models such as OpenAI's Realtime API:

session = AgentSession(
    ...
    llm=openai.realtime.RealtimeModel(),
    turn_detection=AudioTurnDetector(),
)

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 -m livekit.agents 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

livekit_plugins_turn_detector-1.6.0rc2.tar.gz (7.4 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.6.0rc2.tar.gz.

File metadata

File hashes

Hashes for livekit_plugins_turn_detector-1.6.0rc2.tar.gz
Algorithm Hash digest
SHA256 3c5ec240835676749a2382b0415699818c7fd63ca95c7b2401751ca5934d1f58
MD5 26cd47fa9cd57e6fd54bde8b3d085a2c
BLAKE2b-256 c73d1f292f12c52d00c9114b02f3c5a9e4cacf20679d825beff68bb2c9df7890

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_turn_detector-1.6.0rc2.tar.gz:

Publisher: publish.yml on livekit/agents

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file livekit_plugins_turn_detector-1.6.0rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for livekit_plugins_turn_detector-1.6.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 5ee31ca4d6e9e11c206a7175fa3ffc91e55174da47b9c28ec9f43eadcaaf6968
MD5 937b8efd7433e96e8acf034c36670816
BLAKE2b-256 0f3946b804f8063be6554025a498d20639b9c56d76582367fe0d9de61064a92c

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_turn_detector-1.6.0rc2-py3-none-any.whl:

Publisher: publish.yml on livekit/agents

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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