ThunderPhone v3 હવે લાઇવ છે.સેલ્ફ-સર્વ, 2¢/મિનિટથી.જાહેરાત વાંચો

Widget

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"
    />
  )
}

Props

કોમ્પોનન્ટ ThunderPhoneWidgetProps દ્વારા નીચેના props સ્વીકારે છે:

| પ્રોપ | પ્રકાર | જરૂરી | ડિફૉલ્ટ | વર્ણન | |------|------|---------|-------------| | 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 માં) ચાલુ કરો. નવા વિજેટ્સ કોઈને સ્વીકારતા નથી, અને બંધ હોય તેવું 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 કૉલબૅક ટ્રિગર થાય છે, ત્યારે તેને બે ફીલ્ડ ધરાવતો એક એરર ઑબ્જેક્ટ મળે છે:

ફીલ્ડપ્રકારવર્ણન
errorstringમશીન દ્વારા વાંચી શકાય તેવો એરર કોડ
messagestringમાનવી દ્વારા વાંચી શકાય તેવું એરર વર્ણન

સામાન્ય એરર કોડમાં ડોમેન મંજૂર નથી, એજન્ટ મળ્યો નથી અને અમાન્ય API કીનો સમાવેશ થાય છે.


આગળના પગલાં