React SDK
useScribe: tal-till-text-transkribering i realtid i React
Se översikten över Speech to Text för en översikt över Scribe och dess funktioner. Se strömning på klientsidan för stegvisa användarguider.
Installation
Använd ElevenLabs speech-to-text-skill för att transkribera ljud från din AI-kodningsassistent:
@elevenlabs/react återexporterar allt från @elevenlabs/client, så du behöver inte installera
båda paketen.
Användning
Här är ett minimalt fungerande exempel som ansluter till Scribe och visar transkribering i realtid:
Hämta en token
Scribe kräver en engångstoken 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.
Hook-alternativ
Konfigurera hooken med standardalternativ och callbacks:
Anslutningsalternativ
VAD-alternativ
Dessa alternativ styr när transkript automatiskt bekräftas vid användning av VAD-bekräftelsestrategin.
Ljudalternativ
Objektet microphone accepterar:
Beteendealternativ
Callbacks
Alla händelse-callbacks är valfria och kan anges som hook-alternativ:
- onConnect - hanterare som anropas när WebSocket-anslutningen har upprättats.
- onDisconnect - hanterare som anropas när WebSocket-anslutningen stängs.
- onSessionStarted - hanterare som anropas när Scribe-sessionen startar.
- onPartialTranscript - hanterare som anropas med preliminära transkriberingsresultat. Tar emot
{ text: string }. - onCommittedTranscript - hanterare som anropas med slutförda transkriberingsresultat. Tar emot
{ text: string }. - onCommittedTranscriptWithTimestamps - hanterare som anropas med slutförda transkriberingsresultat inklusive tid på ordnivå. Tar emot
{ text: string; words?: { start: number; end: number }[] }. - onError - generell felhanterare för alla fel. Tar emot
Error | Event. - onAuthError - hanterare som anropas vid autentiseringsfel. Tar emot
{ error: string }.
Fel-callbacks
Den generella callbacken onError utlöses vid alla fel. Det finns även specifika fel-callbacks för mer detaljerad hantering. Alla specifika fel-callbacks tar emot { error: string }.
Mikrofonläge
Strömma ljud direkt från användarens mikrofon:
Manuellt ljudläge (filtranskribering)
Transkribera förinspelade ljudfiler:
Returvärden
Tillstånd
- status - aktuell anslutningsstatus:
"disconnected","connecting","connected","transcribing"eller"error". - isConnected - boolean som anger om ansluten.
- isTranscribing - boolean som anger om aktiv transkribering pågår.
- partialTranscript - aktuell delvis (preliminär) transkriptsträng.
- committedTranscripts - matris med
TranscriptSegment-objekt (se nedan). - error - aktuellt felmeddelande eller
null.
Varje bekräftat transkriptsegment har följande struktur:
Metoder
connect(options?)
Anslut till Scribe. Alternativ som anges här åsidosätter hookens standardvärden:
disconnect()
Koppla från och rensa resurser:
sendAudio(audioBase64, options?)
Skicka ljuddata (endast manuellt läge):
Fältet previousText kan endast skickas i en sessions första ljudsegment. Om det skickas i
efterföljande segment uppstår ett fel.
commit()
Bekräfta den aktuella transkriberingen manuellt:
clearTranscripts()
Rensa alla transkript från tillståndet:
getConnection()
Hämta den underliggande anslutningsinstansen:
Bekräftelsestrategier
Styr när transkriberingar bekräftas:
Mer information finns i Transkript och bekräftelsestrategier.
Komplett exempel
Här är ett komplett exempel på en React-komponent som använder hooken useScribe med VAD-baserad bekräftelsestrategi: