JavaScript SDK
Scribe: tal-till-text-transkribering i realtid i JavaScript
För en översikt över Scribe och dess funktioner, se översikten över Speech to Text . För stegvisa användarguider, se strömning på klientsidan .
Installation
Använd ElevenLabs färdighet för tal till text för att transkribera ljud från din AI-kodningsassistent:
Det här biblioteket kan användas i alla JavaScript-baserade projekt. Om du använder React bör du överväga
hooken useScribe, som har
inbyggd hantering av tillstånd och livscykel.
Användning
Här är ett minimalt fungerande exempel som ansluter till Scribe och loggar transkriberingsresultat:
Hämta en token
Scribe kräver en token för engångsanvändning för autentisering. Skapa en API-slutpunkt på din server:
Din ElevenLabs API-nyckel är känslig. Exponera den aldrig för klienten. Generera alltid token på servern.
Anslutningsalternativ
Scribe.connect() accepterar antingen mikrofonalternativ eller manuella ljudalternativ. Båda delar en gemensam uppsättning grundalternativ.
Grundalternativ
Mikrofonalternativ
Skicka ett microphone-objekt för att strömma ljud direkt från användarens mikrofon. Anslutningen hanterar getUserMedia och ljudkodning automatiskt.
Manuella ljudalternativ
Skicka audioFormat och sampleRate för att skicka ljuddata manuellt via connection.send().
AudioFormat-enum
Mikrofonläge
Strömma ljud direkt från användarens mikrofon:
Manuellt ljudläge (filtranskribering)
Transkribera förinspelade ljudfiler genom att skicka ljuddata manuellt:
RealtimeConnection
Scribe.connect() returnerar en RealtimeConnection-instans med följande metoder.
on(event, listener)
Registrera en händelselyssnare. Se Händelser för tillgängliga händelsetyper.
off(event, listener)
Ta bort en tidigare registrerad händelselyssnare.
send(data)
Skicka ljuddata till Scribe (endast manuellt ljudläge).
Fältet previousText kan bara skickas i en sessions första ljudsegment. Om det skickas i
efterföljande segment uppstår ett fel.
commit()
Spara den aktuella transkriberingen manuellt. Behövs bara när du använder CommitStrategy.MANUAL.
close()
Stäng WebSocket-anslutningen och frigör resurser (mikrofonström, ljudkontext).
Händelser
Registrera händelselyssnare med connection.on(event, listener). Alla händelser finns som konstanter i enumen RealtimeEvents.
Transkriberingshändelser
Typen WordsItem innehåller tidsinformation på ordnivå:
Anslutningshändelser
Felhändelser
Alla felhändelser tar emot { error: string }.
Commit-strategier
Styr när transkriberingar sparas:
Mer information finns i Transkriptioner och commit-strategier.
Fullständigt exempel
Här är ett fullständigt exempel som transkriberar mikrofonljud med VAD-baserad commit-strategi: