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 కోసం డ్యాష్బోర్డ్లోని widget కింద బ్రౌజర్ ఓవర్రైడ్లులో (లేదా key యొక్క allowed_overridesలో) ప్రారంభించండి. కొత్త widgets ఏదీ అంగీకరించవు; నిలిపివేయబడిన ఓవర్రైడ్ను కలిగి ఉన్న సెషన్ అభ్యర్థన 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%."
/>
)
}విజిటర్ ఉన్న పేజీ గురించి ఉత్పత్తి వివరాలు, ధరలు లేదా పేజీ-నిర్దిష్ట FAQలు వంటి వాస్తవ సమాచారాన్ని ఏజెంట్కు అందించడానికి 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 కీ ఉన్నాయి.