Skip to main content

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, Hindi

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 -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.5.14.tar.gz (8.7 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.5.14-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for livekit_plugins_turn_detector-1.5.14.tar.gz
Algorithm Hash digest
SHA256 44a84d7f0663a3888eafe1a05bfb59e87d0c0c2b531fbdc050500f304c195858
MD5 ad3a5cdf02d5a01ac39d7c7b99144a9b
BLAKE2b-256 13e8ede03db84b8d5eedb5904999775b5c8394d3f79fce28799e8f66826e8992

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_turn_detector-1.5.14-py3-none-any.whl
Algorithm Hash digest
SHA256 bf4d1a480037552b5b5721e15f71473e7b2067ac0d4b98870cd47147f3a03cfb
MD5 c6b3dc976a9c19bc0c88942f92b15066
BLAKE2b-256 22dacc31e74b093031176207f5bfdd59810b58497b7f5cd2e8b332ce5c8e2f71

See more details on using hashes here.

Provenance

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