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.TurnDetector 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 TurnDetector, available from livekit-agents directly:

from livekit.agents.inference import TurnDetector

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

Usage with RealtimeModel

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

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

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.1.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.

livekit_plugins_turn_detector-1.6.1-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file livekit_plugins_turn_detector-1.6.1.tar.gz.

File metadata

File hashes

Hashes for livekit_plugins_turn_detector-1.6.1.tar.gz
Algorithm Hash digest
SHA256 27e13f3718575921f7ddad6da295f4514e8d4608875251a0b60e2b6004194821
MD5 70f451e8dd1c3e9c7c15f9cb914cddb4
BLAKE2b-256 352d2a2405e7b4cd1c9a8cdbd37a05045410e703c85694c07fe6c34a7ad23320

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_turn_detector-1.6.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for livekit_plugins_turn_detector-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b06bed121e9ff271496ee6fcdd4245301065f24e3807b36a976801d13f6ed935
MD5 a9b5ae4179c583679f8948763feb71c0
BLAKE2b-256 945c54db9ca1f360d92affbc07044f0514c4b4c24ca9c4aaf484ee77b0d5eb5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_turn_detector-1.6.1-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