Open in
React ਕੰਪੋਨੈਂਟ
ThunderPhone ਵੌਇਸ ਵਿਜਿਟ ਨੂੰ React ਐਪਲੀਕੇਸ਼ਨ ਵਿੱਚ ਐਂਬੈਡ ਕਰੋ
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) ਵਿੱਚ ਅੱਗੇ ਭੇਜਿਆ ਜਾਂਦਾ ਹੈ, ਜੋ ਉਸ ਸੈਸ਼ਨ ਲਈ ਏਜੰਟ ਦੀਆਂ ਕਨਫਿਗਰ ਕੀਤੀਆਂ ਡਿਫਾਲਟ ਸੈਟਿੰਗਾਂ ਨੂੰ ਓਵਰਰਾਈਡ ਕਰਦੇ ਹਨ। ਡੈਸ਼ਬੋਰਡ ਵਿੱਚ ਵਿਜੈਟ ਲਈ ਬਰਾਊਜ਼ਰ ਓਵਰਰਾਈਡਜ਼ ਹੇਠ (ਜਾਂ ਕੁੰਜੀ ਦੇ allowed_overrides ਵਿੱਚ) ਤੁਹਾਡੇ ਵੱਲੋਂ ਵਰਤੀ ਜਾਣ ਵਾਲੀ ਹਰ prop ਨੂੰ ਚਾਲੂ ਕਰੋ। ਨਵੇਂ ਵਿਜੈਟ ਕੋਈ ਵੀ ਸਵੀਕਾਰ ਨਹੀਂ ਕਰਦੇ, ਅਤੇ ਬੰਦ ਹੋਈ ਕੋਈ prop ਵਾਲੀ ਸੈਸ਼ਨ ਬੇਨਤੀ 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 ਵਰਤੋ -- ਉਤਪਾਦ ਵੇਰਵੇ, ਕੀਮਤਾਂ, ਜਾਂ ਪੰਨਾ-ਵਿਸ਼ੇਸ਼ FAQs। ਏਜੰਟ ਇਸਨੂੰ ਹਦਾਇਤਾਂ ਨਹੀਂ, ਸਗੋਂ ਪੰਨੇ ਦੀ ਸਮੱਗਰੀ ਵਜੋਂ ਮੰਨਦਾ ਹੈ। ਸਰਵਰ-ਸਾਈਡ ਇਸਨੂੰ 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 ਕੁੰਜੀ ਸ਼ਾਮਲ ਹਨ।