Developer cookbook

ஒவ்வொரு அழைப்பிற்குமான மாறிகள்

அதன் டிப்ளாய் செய்யப்பட்ட prompt, கருவிகள் அல்லது அமைப்புகளை மாற்றாமல், ஒவ்வொரு அழைப்பிற்கும் சேமிக்கப்பட்ட ஏஜென்ட்டை தனிப்பயனாக்குங்கள்.

உங்கள் சேமித்த ஏஜென்டின் prompt-இல் placeholder-களை இடுங்கள், பின்னர் அழைப்பைத் தொடங்கும்போது variables object-ஐ வழங்குங்கள். சேமித்த உள்ளமைவும் பதிப்பு வரலாறும் மாறாமல் இருக்கும். அழைப்பு உள்ளமைவை குரல் இயக்கநேரத்திற்கு அனுப்புவதற்கு முன் ThunderPhone உரையைப் பதிலிடுகிறது.

மதிப்புகள் தேவையில்லாதபோது, variables-ஐ விடுங்கள்; null-ஐ அனுப்பாதீர்கள் (400 உடன் நிராகரிக்கப்படும்).

Placeholder-களும் இயல்புநிலை மதிப்புகளும்#

You are calling {{name|Friend}} about account {{account_id}}.
The available appointment is {{ appointment_slot }}.

பெயர்கள் எழுத்து வேறுபாட்டை உணரக்கூடியவை; அவை [A-Za-z_][A-Za-z0-9_]* வடிவத்தைப் பின்பற்றும். பெயரைச் சுற்றியுள்ள இடைவெளி அனுமதிக்கப்படும்; |-க்குப் பிறகுள்ள இடைவெளி இயல்புநிலை மதிப்பின் பகுதியாகும், அது பாதுகாக்கப்படும். name இல்லையெனில் அல்லது null எனில் {{name|Friend}}, Friend-ஐப் பயன்படுத்தும்; வெற்று சரம் வெளிப்படையாக வழங்கப்பட்ட மதிப்பாகும். இயல்புநிலை இல்லாத விடுபட்ட மதிப்புகள் வெற்று சரங்களாக மாறும்; அவற்றின் பெயர்கள் unresolved_variables-இல் தோன்றும். சரியான placeholder அல்லாத இரட்டை சுருள் அடைப்புக்குறிகளுக்கு இடையிலான உரை நீக்கப்படும். வழங்கப்பட்ட ஒவ்வொரு மதிப்பிற்குள்ளும் உள்ள இரட்டை சுருள் அடைப்புக்குறி உரை தனித்தனியாக நீக்கப்படும்; ஒரு மதிப்பு சுற்றியுள்ள prompt உரையையோ வேறொரு மதிப்பையோ நீக்க முடியாது. பொருந்தாத இரட்டை சுருள் அடைப்புக்குறி பிரிப்பான்களும் நீக்கப்படும். prompt-களில் உள்ள JSON எடுத்துக்காட்டுகள் {{-ஐப் பயன்படுத்தக்கூடாது. மதிப்புகள் எளிய உரையாகும்; அவை ஒருபோதும் குறியீடாக மதிப்பீடு செய்யப்படவோ template-களாக மீள்நிகழ்த்தப்படவோ மாட்டாது.

தொலைபேசி அழைப்பிற்காக அந்தப் புலம் அனுப்பப்படும்போது, உறுதிப்படுத்தல் prompt-கள், வெளியேறும் voicemail செய்திகள் மற்றும் சம்மத அறிவிப்பு உரையிலும் மாறிகள் தோன்றலாம். ஏஜென்டிற்கு தனி first_message புலம் இல்லை: அதன் தொடக்க வழிமுறைகளை prompt-இல் இடுங்கள். ஏற்கனவே உள்ள voicemail {agent_name} மற்றும் {org_name} placeholder-கள் தொடர்ந்து செயல்படும்.

மதிப்புகள் சரங்கள், எண்கள், தருக்க மதிப்புகள் அல்லது null ஆக இருக்கலாம்; தருக்க மதிப்புகள் true மற்றும் false ஆக உரையாக்கப்படும். புதியவரி (\n), தாவல் (\t), மற்றும் வரித்திரும்பல் (\r) தவிர்ந்த Unicode கட்டுப்பாட்டு (Cc) எழுத்துகள், அனைத்து வடிவமைப்பு (Cf) எழுத்துகள் மற்றும் பினாமி (Cs) குறியீட்டுப் புள்ளிகள் நீக்கப்படும்; \r\n, \n ஆகச் சீராக்கப்படும். உரையாக்கப்படும்போது ஒவ்வொரு மதிப்பும் 2,000 எழுத்துகளுக்கு வரையறுக்கப்படும். வழங்கப்பட்ட சரங்களும் சேமிப்பதற்கு முன் சுத்தம் செய்யப்பட்டு வெட்டப்படும். அசல் object UTF-8 JSON இன் 32 KB-க்குள் இருக்க வேண்டும்; அதைவிடப் பெரிய object-களுக்கு அழைப்பு/அமர்வு கோரிக்கைகளில் 400 கிடைக்கும், ஆனால் பிரச்சார இறக்குமதிகள் தவறான வரிசைகளைத் தனித்தனியாகப் புகாரளிக்கும். வரிசைகளும் உள்ளமைந்த object-களும் மதிப்புகளாக ஏற்கப்படாது. பொருந்தாத மெட்டாடேட்டா விசைகள் (எடுத்துக்காட்டாக இடைவெளியுள்ள CSV தலைப்பு) பாதுகாக்கப்பட்டு மீளளிக்கப்படும், ஆனால் placeholder மூலம் அவற்றைக் குறிப்பிட முடியாது.

மதிப்புகள் எங்கிருந்து வருகின்றன#

வெளிச்செல்லும் API#

POST /v1/call இல் agent_id உடன் variables ஐ அனுப்புங்கள்:

{
  "from_number": "+15551234567",
  "to_number": "+14155550199",
  "agent_id": 12,
  "variables": {
    "name": "Ada",
    "account_id": "A-17",
    "appointment_slot": "Tuesday at 10 AM"
  }
}

இது தொலைபேசி எண்ணின் இயல்புநிலை வெளிச்செல்லும் ஏஜென்டுடனும் அல்லது இன்லைன் config.prompt உடனும் செயல்படும். வேறுபட்ட மாறிகளுடன் ஒரே ஐடெம்போட்டென்சி கீயை மீண்டும் பயன்படுத்த முடியாது.

பிரச்சார CSV#

தொலைபேசி அல்லாத CSV நெடுவரிசைகள் ஏற்கனவே தொடர்பு மாறிகளாகச் சேமிக்கப்படுகின்றன. ஒவ்வொரு டயலும் இப்போது அவற்றைத் தானாகப் பயன்படுத்தும். உங்கள் இடஒதுக்கிகளுடன் பொருந்த name, account_id, மற்றும் appointment_slot போன்ற தலைப்புகளைப் பயன்படுத்துங்கள். ஏற்கனவே உள்ள பெயர் மேப்பிங், முதல் மற்றும் கடைசி பெயர் நெடுவரிசைகளை name மாறியாக இணைக்க முடியும்.

டைனமிக் உள்ளமைவு வெப்ஹுக்#

தடுக்கும் உள்ளமைவு வெப்ஹுக் பாதையில், உங்கள் நிறுவனத்தில் உள்ள சேமிக்கப்பட்ட ஏஜென்ட்டையும் ஒவ்வொரு அழைப்புக்கான மதிப்புகளையும் திருப்பி அனுப்புங்கள்:

{"agent_id": 12, "variables": {"name": "Ada", "account_id": "A-17"}}

பதிலின் கீகள் கோரிக்கை-நிலை மாறிகளை மேலெழுதும்; பிற கோரிக்கை கீகள் அப்படியே இருக்கும். null என்ற பதில் மதிப்பு இடஒதுக்கியின் இயல்புநிலையைத் தேர்ந்தெடுக்கும். இணைக்கப்பட்ட ஆப்ஜெக்ட் 32 KB-க்குள்ளும் இருக்க வேண்டும். சேமிக்கப்பட்ட-ஏஜென்ட் பதில்கள் agent_id மற்றும் variables ஐ மட்டுமே ஏற்கும்; prompt அல்லது அமைப்புகளை மாற்ற வேண்டுமெனில் இன்லைன் உள்ளமைவைத் திருப்பி அனுப்புங்கள். prompt உள்ள பதில் எப்போதும் இன்லைன் உள்ளமைவைப் பயன்படுத்தும்: அந்தப் பதிலில் உள்ள எந்த agent_id யும், null அல்லது முழுஎண் அல்லாத மெட்டாடேட்டா உட்பட, புறக்கணிக்கப்படும். இன்லைன் prompt வழக்கமான சரிபார்ப்பில் தேர்ச்சி பெற வேண்டும். இன்லைன் வெப்ஹுக் பதில்களிலும் variables இடம்பெறலாம். சேமிக்கப்பட்ட-ஏஜென்ட் வெப்ஹுக் பதில்கள் தொலைபேசி மற்றும் விட்ஜெட் அழைப்புகள் இரண்டிலும் ஏஜென்ட்டின் பயன்படுத்தப்பட்ட A/B பிரிப்பைப் பயன்படுத்தும்; மாறிகள் மாறுபாட்டுத் தேர்வுக்குப் பிறகு வழங்கப்படும். உள்வரும் தொலைபேசி அழைப்புகளில், ஒதுக்கப்பட்ட உள்வரும் ஏஜென்ட் இல்லாத எண்ணைப் பயன்படுத்தி, அதன் தொலைபேசி-எண் அல்லது நிறுவன வெப்ஹுக்கை உள்ளமைக்கவும்; விட்ஜெட் கீகள் mode="webhook" ஐப் பயன்படுத்தும். எண்ட்பாயிண்ட்-சிஸ்டம் உள்வரும் அறிவிப்புகள் தடுக்கும் உள்ளமைவு பதில்களை வழங்காது.

விட்ஜெட் மற்றும் நிகழ்நேர அமர்வு APIகள்#

POST /v1/widget/session மேல்-நிலை variables ஆப்ஜெக்ட்டை ஏற்கிறது. அதன் வெளியிடக்கூடிய கீ சேமிக்கப்பட்ட ஏஜென்ட்டைத் தேர்ந்தெடுக்கிறது. வெப்ஹுக்-பயன்முறை கீகள் இந்த மதிப்புகளை உள்ளமைவு வெப்ஹுக்கிற்கு அனுப்பி, மேலே விளக்கியபடி பதிலை இணைக்கும். உலாவி வழங்கும் விட்ஜெட்/நிகழ்நேர variables கிளையன்ட் கட்டுப்படுத்துபவை; மேலே விளக்கப்பட்ட சரிபார்ப்பு மற்றும் சரம் சுத்தப்படுத்தலுக்குப் பிறகு அவை web.incoming இல் மாற்றமின்றி அனுப்பப்படுகின்றன, மேலும் நிறைவு வெப்ஹுக்குகளிலும் அழைப்பு வரலாற்றிலும் சேர்க்கப்படுகின்றன. அவற்றை நம்பகமான அடையாள அல்லது அங்கீகாரத் தரவாகக் கருதாதீர்கள்.

POST /v1/realtime/sessions, agent_id (அல்லது இன்லைன் config) உடன் variables ஐ ஏற்கிறது. இவை அமர்வு-உருவாக்க API புலங்கள். நிகழ்நேர WebSocket பிரிட்ஜ் மாறிகள் விருப்பத்தை அனுப்பாது; அதை நேரடியாக அமர்வு-உருவாக்க APIக்கு வழங்குங்கள். விட்ஜெட் கிளையன்ட்கள் இடுகையிடப்பட்ட அமர்வு பேலோடில் variables ஐச் சேர்க்க வேண்டும்; SDK அனுப்புதல் இந்த API மாற்றத்தின் பகுதியாக இல்லை. பில்டர் மைக் மற்றும் சிமுலேட் செய்யப்பட்ட சோதனை அழைப்புகள் இயல்புநிலைகளையும் காணாத இடஒதுக்கிகளையும் தீர்மானிக்கும், ஆனால் ஒவ்வொரு அழைப்புக்கான மாறிகள் உள்ளீடு அவற்றில் இல்லை.

அழைப்புக்குப் பிறகு வழங்கப்படும் மதிப்புகள்#

GET /v1/calls, GET /v1/calls/{call_id}, telephony.complete, மற்றும் web.complete ஆகியவை இறுதியாக இணைக்கப்பட்ட variables மற்றும் unresolved_variables ஐக் கொண்டிருக்கும். data.history ஐ உள்ளடக்கும் பழைய நிறைவு பேலோடுகளிலும் அவை இடம்பெறும்:

{
  "variables": {"name": "Ada", "account_id": "A-17"},
  "unresolved_variables": ["appointment_slot"]
}

நிறைவடைந்த அழைப்பை அதன் மூலப் பதிவுடன் இணைக்க, உங்கள் CRM அல்லது பணி அடையாளங்காட்டியை மாறிகள் ஆப்ஜெக்ட்டில் சேமிக்கவும். இந்தப் புலங்கள் அழைப்புப் பதிவுடன் தக்கவைக்கப்படுகின்றன; அழைப்பு வரலாறு மற்றும் வெப்ஹுக்குகளில் தக்கவைக்க ஏற்ற தகவல்களை மட்டுமே அனுப்புங்கள்.

ஏற்கனவே உள்ள prompt இணக்கத்தன்மை#

ரெண்டரிங் ஏற்கனவே சேமிக்கப்பட்ட ஏஜென்ட் மற்றும் A/B மாறுபாட்டு prompt-கள், இன்லைன் அவுட்பவுண்ட் மற்றும் நிகழ்நேர கட்டமைப்புகள், மேலும் கட்டமைப்பு webhook-கள் மூலம் திரும்ப வரும் prompt-களுக்கும் பொருந்தும். அறியப்படாத {{name}} பிளேஸ்ஹோல்டர்கள், எந்த variables-மும் வழங்கப்படாதபோதிலும், வெற்று உரையாக மாறும். வெளியீட்டிற்கு முன் ஏற்கனவே உள்ள prompt-களைச் சரிபார்க்கவும்; இதில் ThunderPhone பட்டியலிட முடியாத வெளிப்புறமாக வழங்கப்பட்ட இன்லைன்/webhook prompt-களும் அடங்கும். Builder மைக்ரோஃபோன் மற்றும் சிமுலேஷன் அழைப்புகள் அதே இயல்புநிலை/வெற்று நடத்தையைப் பயன்படுத்தும்.