Open in
React घटक
React अनुप्रयोगात ThunderPhone व्हॉइस विजेट एम्बेड करा
ThunderPhoneWidget कॉम्पोनंट म्यूट करणे, कॉल समाप्त करणे आणि कनेक्शन स्थिती दाखवणे यासाठी अंगभूत नियंत्रणे असलेला ग्लासमॉर्फिक कॉल बार रेंडर करतो. React अॅपमध्ये व्हॉइस AI जोडण्याचा हा सर्वात जलद मार्ग आहे.
स्थापना
npm install @thunderphone/widgetमूलभूत वापर
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function App() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
/>
)
}प्रॉप्स
कॉम्पोनंट ThunderPhoneWidgetProps द्वारे खालील प्रॉप्स स्वीकारतो:
| प्रॉप | प्रकार | आवश्यक | डीफॉल्ट | वर्णन |
|---|---|---|---|---|
publishableKey | string | होय | -- | डॅशबोर्डमधील वेब विजेट्स मधून मिळालेली प्रकाशित करता येणारी API की (pk_live_...). कीच्या विजेट कॉन्फिगरेशनमधून एजंट आपोआप निश्चित केला जातो. |
theme | 'light' | 'dark' | नाही | 'light' | रंग योजना. विजेट रूटला tp--light किंवा tp--dark क्लास लागू करते. |
primaryColor | string | नाही | '#000000' (लाइट) / '#ffffff' (डार्क) | अॅक्सेंट रंग म्हणून वापरली जाणारी CSS रंग स्ट्रिंग (कॉल बटण, वेव्हफॉर्म, सक्रिय निर्देशक). |
title | string | नाही | 'Voice assistant' | विजेट बारमध्ये प्रदर्शित होणारा मजकूर. |
position | 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left' | नाही | 'bottom-right' | विजेटसाठी निश्चित व्ह्यूपोर्ट स्थान. |
apiBase | string | नाही | 'https://api.thunderphone.com/v1' | API बेस URL ओव्हरराइड. |
language | string | नाही | -- | प्रत्येक सेशनसाठी भाषा ओव्हरराइड -- en, es, किंवा fr-FR यांसारखा भाषा कोड किंवा लोकेल. सेट नसल्यास, एजंटची कॉन्फिगर केलेली भाषा लागू होते. कीच्या ब्राउझर ओव्हरराइड्स अंतर्गत language आवश्यक आहे. |
voice | string | नाही | -- | प्रत्येक सेशनसाठी व्हॉइस ओव्हरराइड -- maria सारखे व्हॉइस नाव. सेट नसल्यास, एजंटचा कॉन्फिगर केलेला व्हॉइस लागू होतो. कीच्या ब्राउझर ओव्हरराइड्स अंतर्गत voice आवश्यक आहे. |
context | string | नाही | -- | एजंटकडे पाठवला जाणारा प्रत्येक सेशनसाठीचा वस्तुनिष्ठ पृष्ठ किंवा साइट संदर्भ (उदाहरणार्थ, अभ्यागत पाहत असलेल्या पृष्ठाचे तपशील). सर्व्हर-साइडवर 12,000 वर्णांपर्यंत छाटला जातो. कीच्या ब्राउझर ओव्हरराइड्स अंतर्गत context आवश्यक आहे. |
onConnect | () => void | नाही | -- | व्हॉइस सेशन यशस्वीरित्या कनेक्ट झाल्यावर कॉल केले जाते. |
onDisconnect | () => void | नाही | -- | सेशन संपल्यावर कॉल केले जाते. |
onError | (error) => void | नाही | -- | त्रुटी आल्यावर कॉल केले जाते. error ऑब्जेक्टमध्ये error (कोड) आणि message फील्ड असतात. |
className | string | नाही | -- | विजेट कंटेनरला लागू केले जाणारे अतिरिक्त CSS क्लास नाव. |
ringtone | boolean | string | नाही | false | कनेक्ट होत असताना रिंगटोन वाजवा. डीफॉल्ट रिंगटोनसाठी true, किंवा सानुकूल ऑडिओसाठी URL स्ट्रिंग वापरा. |
उदाहरणे
सानुकूल रंगासह गडद थीम
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function App() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
theme="dark"
primaryColor="#8b5cf6"
title="Talk to our AI"
/>
)
}सानुकूल स्थान
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function App() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
position="bottom-left"
/>
)
}प्रत्येक सेशनसाठी भाषा, आवाज आणि संदर्भ
कॉल सुरू झाल्यावर language, voice, आणि context props सत्र विनंतीकडे (POST /widget/session) पाठवले जातात आणि त्या सत्रासाठी एजंटचे कॉन्फिगर केलेले डीफॉल्ट ओव्हरराइड केले जातात. तुम्ही वापरत असलेला प्रत्येक prop डॅशबोर्डमधील विजेटच्या ब्राउझर ओव्हरराइड्स अंतर्गत चालू करा (किंवा कीच्या allowed_overrides मध्ये). नवीन विजेट्स कोणतेही ओव्हरराइड स्वीकारत नाहीत आणि बंद असलेला ओव्हरराइड असलेली सत्र विनंती 400 override_not_allowed सह अयशस्वी होते; ब्राउझर ओव्हरराइड्स पहा.
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function PricingPageWidget() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
language="es"
voice="maria"
context="Page: Pricing. Plans: Starter $29/mo, Pro $99/mo. Annual billing saves 20%."
/>
)
}भेट देणारा ज्या पृष्ठावर आहे त्याबद्दल एजंटला तथ्यात्मक माहिती देण्यासाठी context वापरा -- उत्पादन तपशील, किंमत किंवा पृष्ठ-विशिष्ट वारंवार विचारले जाणारे प्रश्न. एजंट त्याला सूचना म्हणून नव्हे, तर पृष्ठ सामग्री म्हणून हाताळतो. सर्व्हर-साइडवर ते 12,000 वर्णांपर्यंत कापले जाते.
इव्हेंट कॉलबॅकसह
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function SupportWidget() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
onConnect={() => {
console.log('Voice session connected')
analytics.track('widget_call_started')
}}
onDisconnect={() => {
console.log('Voice session ended')
analytics.track('widget_call_ended')
}}
onError={(error) => {
console.error(`Widget error: ${error.error} - ${error.message}`)
}}
/>
)
}सानुकूल स्टाइलिंगसह
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function BrandedWidget() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
primaryColor="#4a90d9"
className="my-custom-widget"
/>
)
}.my-custom-widget .tp-button--end {
background-color: #e74c3c;
}उपलब्ध सर्व CSS क्लासेस आणि सानुकूल गुणधर्मांसाठी स्टाइलिंग मार्गदर्शक पहा.
रिंगटोनसह
कनेक्शन स्थापित होत असताना फोन वाजण्याचा आवाज वाजवा:
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function PhoneWidget() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
ringtone={true}
/>
)
}ऑडिओ फाइल URL देऊन सानुकूल रिंगटोन वापरा:
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
ringtone="https://example.com/my-ringtone.mp3"
/>विजेट connecting स्थितीत असताना रिंगटोन सतत वाजते आणि एजंट कनेक्ट झाल्यावर ती सहजपणे मंद होते.
सानुकूल API बेससह
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
apiBase="https://your-proxy.example.com/v1"
/>त्रुटी हाताळणी
onError कॉलबॅक ट्रिगर झाल्यावर, त्याला दोन फील्ड असलेला त्रुटी ऑब्जेक्ट प्राप्त होतो:
| फील्ड | प्रकार | वर्णन |
|---|---|---|
error | string | मशीन-वाचनीय त्रुटी कोड |
message | string | मानव-वाचनीय त्रुटीचे वर्णन |
सामान्य त्रुटी कोडमध्ये डोमेनला परवानगी नाही, एजंट सापडला नाही आणि अवैध API की यांचा समावेश होतो.