React SDK
useScribe: React में रियल-टाइम स्पीच-टू-टेक्स्ट ट्रांसक्रिप्शन
Scribe और इसकी क्षमताओं के बारे में जानने के लिए स्पीच टू टेक्स्ट ओवरव्यू देखें। चरण-दर-चरण इस्तेमाल गाइड्स के लिए क्लाइंट-साइड स्ट्रीमिंग देखें।
इंस्टॉलेशन
अपने AI कोडिंग असिस्टेंट से ऑडियो ट्रांसक्राइब करने के लिए ElevenLabs स्पीच-टू-टेक्स्ट स्किल इस्तेमाल करें:
@elevenlabs/react, @elevenlabs/client से सब कुछ फिर से एक्सपोर्ट करता है, इसलिए आपको
दोनों पैकेज इंस्टॉल करने की ज़रूरत नहीं है।
इस्तेमाल
यहां Scribe से कनेक्ट होने और रीयल-टाइम ट्रांसक्रिप्शन दिखाने का एक न्यूनतम काम करने वाला उदाहरण है:
टोकन पाना
Scribe को ऑथेंटिकेशन के लिए एक बार इस्तेमाल होने वाला टोकन चाहिए। अपने सर्वर पर एक API एंडपॉइंट बनाएं:
आपकी ElevenLabs API कुंजी संवेदनशील है। इसे कभी क्लाइंट के सामने न दिखाएं। टोकन हमेशा सर्वर पर जनरेट करें।
हुक विकल्प
हुक को डिफ़ॉल्ट विकल्पों और कॉलबैक के साथ कॉन्फ़िगर करें:
कनेक्शन विकल्प
VAD विकल्प
VAD कमिट स्ट्रैटेजी इस्तेमाल करते समय ये विकल्प नियंत्रित करते हैं कि ट्रांसक्रिप्ट अपने-आप कब कमिट हों।
ऑडियो विकल्प
microphone ऑब्जेक्ट ये स्वीकार करता है:
व्यवहार विकल्प
कॉलबैक
सभी इवेंट कॉलबैक वैकल्पिक हैं और हुक विकल्पों के रूप में दिए जा सकते हैं:
- onConnect - WebSocket कनेक्शन स्थापित होने पर कॉल किया जाने वाला हैंडलर।
- onDisconnect - WebSocket कनेक्शन बंद होने पर कॉल किया जाने वाला हैंडलर।
- onSessionStarted - Scribe सेशन शुरू होने पर कॉल किया जाने वाला हैंडलर।
- onPartialTranscript - अस्थायी ट्रांसक्रिप्शन नतीजों के साथ कॉल किया जाने वाला हैंडलर।
{ text: string }प्राप्त करता है। - onCommittedTranscript - फ़ाइनल ट्रांसक्रिप्शन नतीजों के साथ कॉल किया जाने वाला हैंडलर।
{ text: string }प्राप्त करता है। - onCommittedTranscriptWithTimestamps - शब्द-स्तरीय टाइमिंग समेत फ़ाइनल ट्रांसक्रिप्शन नतीजों के साथ कॉल किया जाने वाला हैंडलर।
{ text: string; words?: { start: number; end: number }[] }प्राप्त करता है। - onError - सभी त्रुटियों के लिए सामान्य एरर हैंडलर।
Error | Eventप्राप्त करता है। - onAuthError - ऑथेंटिकेशन त्रुटियों पर कॉल किया जाने वाला हैंडलर।
{ error: string }प्राप्त करता है।
एरर कॉलबैक
सामान्य onError कॉलबैक सभी त्रुटियों के लिए ट्रिगर होता है। विस्तृत हैंडलिंग के लिए खास एरर कॉलबैक भी उपलब्ध हैं। सभी खास एरर कॉलबैक { error: string } प्राप्त करते हैं।
माइक्रोफ़ोन मोड
यूज़र के माइक्रोफ़ोन से सीधे ऑडियो स्ट्रीम करें:
मैन्युअल ऑडियो मोड (फ़ाइल ट्रांसक्रिप्शन)
पहले से रिकॉर्ड की गई ऑडियो फ़ाइलें ट्रांसक्राइब करें:
रिटर्न वैल्यू
स्टेट
- status - मौजूदा कनेक्शन स्थिति:
"disconnected","connecting","connected","transcribing", या"error"। - isConnected - कनेक्ट होने का संकेत देने वाला बूलियन।
- isTranscribing - सक्रिय रूप से ट्रांसक्राइब हो रहा है या नहीं, इसका संकेत देने वाला बूलियन।
- partialTranscript - मौजूदा आंशिक (अस्थायी) ट्रांसक्रिप्ट स्ट्रिंग।
- committedTranscripts -
TranscriptSegmentऑब्जेक्ट्स की ऐरे (नीचे देखें)। - error - मौजूदा एरर मैसेज या
null।
हर कमिट किए गए ट्रांसक्रिप्ट सेगमेंट का स्ट्रक्चर यह है:
मेथड्स
connect(options?)
Scribe से कनेक्ट करें। यहां दिए गए विकल्प हुक डिफ़ॉल्ट को ओवरराइड करते हैं:
disconnect()
डिस्कनेक्ट करें और संसाधन साफ़ करें:
sendAudio(audioBase64, options?)
ऑडियो डेटा भेजें (सिर्फ़ मैन्युअल मोड):
previousText फ़ील्ड सिर्फ़ सेशन के पहले ऑडियो चंक में भेजी जा सकती है। इसे
बाद के चंक्स में भेजने पर एरर आता है।
commit()
मौजूदा ट्रांसक्रिप्शन को मैन्युअल रूप से कमिट करें:
clearTranscripts()
स्टेट से सभी ट्रांसक्रिप्ट साफ़ करें:
getConnection()
अंडरलाइंग कनेक्शन इंस्टेंस पाएं:
कमिट स्ट्रैटेजी
ट्रांसक्रिप्शन कब कमिट हों, यह नियंत्रित करें:
ज़्यादा जानकारी के लिए ट्रांसक्रिप्ट और कमिट स्ट्रैटेजी देखें।
पूरा उदाहरण
यह VAD-आधारित कमिट स्ट्रैटेजी के साथ useScribe हुक इस्तेमाल करने वाले React कंपोनेंट का पूरा उदाहरण है: