SDK React
useScribe: trascrizione vocale in tempo reale in React
Per una panoramica di Scribe e delle sue funzionalità, consulta la panoramica di Speech to Text . Per guide dettagliate all’utilizzo, consulta lo streaming lato client.
Installazione
Usa la skill Speech to Text di ElevenLabs per trascrivere l’audio dal tuo assistente di coding IA:
@elevenlabs/react riesporta tutto da @elevenlabs/client, quindi non devi installare
entrambi i pacchetti.
Utilizzo
Ecco un esempio minimo funzionante che si connette a Scribe e visualizza la trascrizione in tempo reale:
Ottenere un token
Scribe richiede un token monouso per l’autenticazione. Crea un endpoint API sul tuo server:
La tua chiave API ElevenLabs è sensibile. Non esporla mai al client. Genera sempre il token sul server.
Opzioni dell’hook
Configura l’hook con opzioni e callback predefiniti:
Opzioni di connessione
Opzioni VAD
Queste opzioni controllano quando le trascrizioni vengono confermate automaticamente usando la strategia di conferma VAD.
Opzioni audio
L’oggetto microphone accetta:
Opzioni di comportamento
Callback
Tutte le callback degli eventi sono facoltative e possono essere fornite come opzioni dell’hook:
- onConnect - gestore chiamato quando viene stabilita la connessione WebSocket.
- onDisconnect - gestore chiamato quando viene chiusa la connessione WebSocket.
- onSessionStarted - gestore chiamato all’avvio della sessione Scribe.
- onPartialTranscript - gestore chiamato con risultati di trascrizione provvisori. Riceve
{ text: string }. - onCommittedTranscript - gestore chiamato con risultati di trascrizione finalizzati. Riceve
{ text: string }. - onCommittedTranscriptWithTimestamps - gestore chiamato con risultati di trascrizione finalizzati, inclusa la temporizzazione a livello di parola. Riceve
{ text: string; words?: { start: number; end: number }[] }. - onError - gestore di errori generico per tutti gli errori. Riceve
Error | Event. - onAuthError - gestore chiamato in caso di errori di autenticazione. Riceve
{ error: string }.
Callback degli errori
La callback generica onError viene attivata per tutti gli errori. Per una gestione più granulare sono disponibili anche callback per errori specifici. Tutte le callback per errori specifici ricevono { error: string }.
Modalità microfono
Trasmetti l’audio direttamente dal microfono dell’utente:
Modalità audio manuale (trascrizione di file)
Trascrivi file audio preregistrati:
Valori restituiti
Stato
- status - stato corrente della connessione:
"disconnected","connecting","connected","transcribing"o"error". - isConnected - valore booleano che indica se la connessione è attiva.
- isTranscribing - valore booleano che indica se la trascrizione è in corso.
- partialTranscript - stringa della trascrizione parziale corrente (provvisoria).
- committedTranscripts - array di oggetti
TranscriptSegment(vedi sotto). - error - messaggio di errore corrente oppure
null.
Ogni segmento di trascrizione confermato ha la seguente struttura:
Metodi
connect(options?)
Connettiti a Scribe. Le opzioni fornite qui sostituiscono i valori predefiniti dell’hook:
disconnect()
Disconnettiti e libera le risorse:
sendAudio(audioBase64, options?)
Invia dati audio (solo modalità manuale):
Il campo previousText può essere inviato solo nel primo blocco audio di una sessione. Se lo invii nei
blocchi successivi, si verifica un errore.
commit()
Conferma manualmente la trascrizione corrente:
clearTranscripts()
Cancella tutte le trascrizioni dallo stato:
getConnection()
Ottieni l’istanza di connessione sottostante:
Strategie di conferma
Controlla quando vengono confermate le trascrizioni:
Per maggiori dettagli, consulta Trascrizioni e strategie di conferma.
Esempio completo
Ecco un esempio completo di un componente React che usa l’hook useScribe con una strategia di conferma basata su VAD: