AvatarSession-API leitet — die Brücke zwischen deiner Sprach-Pipeline und dem Avatar-Server, der die .hvia-Datei animiert. Zwei einsatzbereite Agent-Muster sind enthalten, sodass du mit dem Ansatz beginnen kannst, der am besten zu deiner Architektur passt.
Agent-Muster
Konversations-Agent
Vollständige Sprach-KI-Pipeline: STT → LLM → TTS → Avaluma-Avatar. Angetrieben von LiveKit Inference mit AssemblyAI, OpenAI GPT-4.1-mini und Cartesia Sonic-3.
Externes Audio
Streame rohes PCM-Audio direkt zum Avatar per LiveKit-DataStream und umgehe die AgentSession-Pipeline vollständig — ideal für eigene TTS- oder Audioquellen.
So funktioniert die AvatarSession
Beide Agenten basieren aufAvatarSession aus dem Paket avaluma-livekit-plugin. Du instanziierst sie mit deinen Zugangsdaten, rufst avatar.start() auf, und sie übernimmt das Beitreten zum Raum als separater Avatar-Teilnehmer sowie das Weiterleiten der Audio-Frames an den Avatar-Server zum Rendern.
Ein Muster wählen
| Konversations-Agent | Externes Audio | |
|---|---|---|
| Audioquelle | LiveKit Inference (STT → LLM → TTS) | Beliebiger externer Dienst oder Datei |
| AgentSession | Erforderlich | Optional |
| DataStream | Von AvatarSession verwaltet | Explizit (lk.audio_stream) |
| Am besten für | Schlüsselfertige Sprachassistenten | Eigenes TTS / vorerzeugtes Audio |
Abhängigkeiten
Alle Abhängigkeiten sind inpyproject.toml deklariert und werden von uv verwaltet:
pyproject.toml
| Paket | Zweck |
|---|---|
livekit | LiveKit-RTC-SDK — Raum-, Track- und DataStream-Primitive |
livekit-agents | Kern-Agent-Framework (enthält silero VAD und turn-detector) |
livekit-plugins-noise-cancellation | Unterdrückung von Hintergrundgeräuschen per BVC |
avaluma-livekit-plugin | AvatarSession — Avaluma-Avatar-Integration |
python-dotenv | Lädt Zugangsdaten aus .env.local |
Voraussetzungen
Stelle vor dem Start eines der Agenten sicher, dass du Folgendes hast:Docker & Docker Compose
Beide Agenten werden mit einer
docker-compose.yaml für einen konfigurationsfreien lokalen Start ausgeliefert.LiveKit-Konto
Ein LiveKit-Cloud-Projekt oder eine selbst gehostete Instanz. Du brauchst URL, API-Key und API-Secret.
Avatar-Server
Eine laufende
avatar-server-Instanz oder den gehosteten Endpunkt unter https://api.avaluma.ai.Avaluma-Lizenzschlüssel
Dein
AVALUMA_LICENSE_KEY aus dem Avaluma-Dashboard — direkt an AvatarSession übergeben.Deinen Agent testen
Sobald Agent und Avatar-Server laufen, verbinde dich mit einem dieser Clients:| Client | Wann verwenden |
|---|---|
| Avaluma Test-Client | Funktioniert mit jedem LiveKit-Setup — selbst gehostet oder Cloud |
| LiveKit Agent Playground | Verfügbar bei Nutzung eines LiveKit-Cloud-Projekts |
