Open in
Kijenzi cha React
Pachika wijeti ya sauti ya ThunderPhone katika programu ya React
Kipengele cha ThunderPhoneWidget huonyesha upau wa simu wenye athari ya kioo na vidhibiti vilivyojengewa ndani vya kunyamazisha, kumaliza simu, na kuonyesha hali ya muunganisho. Hii ndiyo njia ya haraka zaidi ya kuongeza AI ya sauti kwenye programu ya React.
Usakinishaji
npm install @thunderphone/widgetMatumizi ya Msingi
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function App() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
/>
)
}Sifa
Kipengele kinakubali props zifuatazo kupitia ThunderPhoneWidgetProps:
| Sifa | Aina | Inahitajika | Chaguo-msingi | Maelezo |
|---|---|---|---|---|
publishableKey | string | Ndiyo | -- | Ufunguo wa API unaoweza kuchapishwa (pk_live_...) kutoka Wijeti za Wavuti katika dashibodi. Ejenti hupatikana kiotomatiki kutoka kwenye usanidi wa wijeti wa ufunguo. |
theme | 'light' | 'dark' | Hapana | 'light' | Mpangilio wa rangi. Hutumia darasa la tp--light au tp--dark kwenye mzizi wa wijeti. |
primaryColor | string | Hapana | '#000000' (light) / '#ffffff' (dark) | Mfuatano wa rangi wa CSS unaotumika kama rangi ya msisitizo (kitufe cha kupiga simu, umbo la wimbi, vionyeshi amilifu). |
title | string | Hapana | 'Voice assistant' | Maandishi yanayoonyeshwa kwenye upau wa wijeti. |
position | 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left' | Hapana | 'bottom-right' | Nafasi isiyobadilika katika eneo la kutazama kwa wijeti. |
apiBase | string | Hapana | 'https://api.thunderphone.com/v1' | Kubatilisha URL ya msingi ya API. |
language | string | Hapana | -- | Kubatilisha lugha kwa kila kipindi -- msimbo wa lugha au eneo kama vile en, es, au fr-FR. Isipowekwa, lugha iliyosanidiwa ya ejenti hutumika. Huhitaji language chini ya ubatilishaji wa kivinjari wa ufunguo. |
voice | string | Hapana | -- | Kubatilisha sauti kwa kila kipindi -- jina la sauti kama vile maria. Isipowekwa, sauti iliyosanidiwa ya ejenti hutumika. Huhitaji voice chini ya ubatilishaji wa kivinjari wa ufunguo. |
context | string | Hapana | -- | Muktadha wa ukweli wa ukurasa au tovuti kwa kila kipindi unaopitishwa kwa ejenti (kwa mfano, maelezo ya ukurasa anaotazama mgeni). Hukatwa upande wa seva hadi herufi 12,000. Huhitaji context chini ya ubatilishaji wa kivinjari wa ufunguo. |
onConnect | () => void | Hapana | -- | Huitwa kipindi cha sauti kinapounganishwa kwa mafanikio. |
onDisconnect | () => void | Hapana | -- | Huitwa kipindi kinapoisha. |
onError | (error) => void | Hapana | -- | Huitwa hitilafu zinapotokea. Kitu cha error kina sehemu za error (msimbo) na message. |
className | string | Hapana | -- | Jina la ziada la darasa la CSS linalotumika kwenye kontena la wijeti. |
ringtone | boolean | string | Hapana | false | Cheza sauti ya mlio wakati wa kuunganisha. true kwa sauti chaguo-msingi ya mlio, au mfuatano wa URL kwa sauti maalum. |
Mifano
Mandhari Meusi yenye Rangi Maalum
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"
/>
)
}Nafasi Maalum
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function App() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
position="bottom-left"
/>
)
}Lugha, Sauti na Muktadha kwa Kila Kikao
Prop za language, voice, na context hutumwa kwa ombi la kipindi (POST /widget/session) simu inapoanza, zikibatilisha chaguo-msingi zilizosanidiwa za ejenti kwa kipindi hicho. Washa kila prop unayotumia chini ya Ubatilishaji wa kivinjari kwa wijeti kwenye dashibodi (au katika allowed_overrides ya ufunguo). Wijeti mpya hazikubali yoyote, na ombi la kipindi lenye prop ambayo haijawashwa hushindwa kwa 400 override_not_allowed; tazama Ubatilishaji wa kivinjari.
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%."
/>
)
}Tumia context kumpa ejenti maarifa ya ukweli kuhusu ukurasa ambao mgeni yuko -- maelezo ya bidhaa, bei, au Maswali Yanayoulizwa Mara kwa Mara mahususi ya ukurasa. Ejenti huichukulia kama maudhui ya ukurasa, si kama maelekezo. Hukatwa upande wa seva hadi herufi 12,000.
Zenye Callbacks za Matukio
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}`)
}}
/>
)
}Zenye Uwekaji Mitindo Maalum
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;
}Tazama mwongozo wa uwekaji mitindo kwa madarasa yote ya CSS na sifa maalum zinazopatikana.
Yenye Mlio wa Simu
Cheza sauti ya simu inayolia wakati muunganisho unaanzishwa:
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function PhoneWidget() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
ringtone={true}
/>
)
}Tumia mlio maalum wa simu kwa kupitisha URL ya faili ya sauti:
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
ringtone="https://example.com/my-ringtone.mp3"
/>Mlio wa simu hurudiwa wakati wijeti iko katika hali ya connecting na hupungua kwa ulaini ejenti inapounganishwa.
Yenye Msingi Maalum wa API
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
apiBase="https://your-proxy.example.com/v1"
/>Ushughulikiaji wa Hitilafu
Callback ya onError inapowashwa, hupokea kitu cha hitilafu chenye sehemu mbili:
| Sehemu | Aina | Maelezo |
|---|---|---|
error | string | Msimbo wa hitilafu unaosomeka na mashine |
message | string | Maelezo ya hitilafu yanayosomeka na binadamu |
Misimbo ya hitilafu ya kawaida inajumuisha kikoa kisichoruhusiwa, ejenti haikupatikana, na ufunguo wa API usio sahihi.