ThunderPhone v3 sasa inapatikana.Anza mwenyewe, kuanzia 2¢/dakika.Soma tangazo

Developer cookbook

Vigezo na muktadha kwa kila simu

Ipe kila simu maelezo yake yenyewe, kama vigezo vilivyopewa majina kwa ajili ya prompt au muhtasari wa muundo huru, bila kumbadilisha ejenti.

Kila simu inaweza kuwa na aina mbili za ingizo kwa kila simu. Tumia mojawapo, au zote pamoja:

  • variables: thamani zilizopewa majina zinazojaza {{placeholders}} kwenye prompt. Tumia kwa sehemu ambazo prompt inarejelea kwa jina, kama vile jina la mpigaji simu, nambari ya akaunti au muda wa miadi.
  • context: maandishi ya muundo huru yanayoongezwa baada ya prompt. Tumia kwa maelezo mafupi yasiyotoshea kwenye kiolezo, kama vile maelezo ya kazi ya simu hii au dokezo zilizokusanywa awali.

Vyote viwili hufanya kazi na ejenti iliyohifadhiwa na usanidi wa moja kwa moja, katika kila njia ya kuanzisha simu iliyoelezwa hapa chini. Hakuna kinachobadilisha ejenti iliyohifadhiwa, historia yake ya matoleo au mipangilio yake mingine.

{
  "agent_id": 12,
  "variables": {"name": "Ada", "appointment_slot": "Tuesday at 10 AM"},
  "context": "Ada rescheduled twice last month. She prefers mornings and asked us not to call her work number."
}

Vigeu

Weka vishikizo katika prompt ya ejenti yako iliyohifadhiwa, kisha toa kitu cha variables unapoanzisha simu. ThunderPhone huonyesha maandishi kabla ya kutuma usanidi wa simu kwenye mazingira ya uendeshaji wa sauti.

Wakati hakuna thamani zinazohitajika, acha variables, usitume null (inakatalika kwa 400).

Vigezo mbadala na chaguo-msingi

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

Majina hutofautisha herufi kubwa na ndogo na hufuata [A-Za-z_][A-Za-z0-9_]*. Nafasi tupu kuzunguka jina zinaruhusiwa; nafasi tupu baada ya | ni sehemu ya chaguo-msingi na huhifadhiwa. {{name|Friend}} hutumia Friend wakati name haipo au ni null; mfuatano tupu ni thamani iliyotolewa waziwazi. Thamani zinazokosekana zisizo na chaguo-msingi huwa mifuatano tupu na majina yake huonekana kwenye unresolved_variables. Maandishi kati ya mabano mawili ya curly ambayo si kishikilia nafasi halali huondolewa. Maandishi yenye mabano mawili ya curly ndani ya kila thamani iliyotolewa huondolewa kivyake; thamani haiwezi kuondoa maandishi yanayoizunguka kwenye prompt au thamani nyingine. Vikomo vya mabano mawili ya curly visivyolingana huondolewa pia. Mifano ya JSON kwenye prompt haipaswi kutumia {{. Thamani ni maandishi ya kawaida, hayatekelezwi kama msimbo wala hayapanuliwi tena kwa kujirudia kama templeti.

Vigeu vinaweza pia kuonekana katika prompt za uthibitisho, ujumbe wa sauti unaotumwa, na maandishi ya tangazo la idhini wakati sehemu hiyo inatumwa kwa simu. Ejenti haina sehemu tofauti ya first_message: weka maelekezo yake ya mwanzo kwenye prompt. Vishikilia nafasi vilivyopo vya ujumbe wa sauti {agent_name} na {org_name} vinaendelea kufanya kazi.

Thamani na vikomo

Thamani zinaweza kuwa mifuatano ya maandishi, nambari, booleani, au null; booleani huonyeshwa kama true na false. Herufi za udhibiti za Unicode (Cc) isipokuwa mstari mpya (\n), kichupo (\t), na urejeshaji wa gari (\r), herufi za umbizo (Cf) isipokuwa kiunganishi kisicho na upana na kiunganishi chenye upana sifuri (U+200C, U+200D, zinazounda maneno katika lugha za Kihindi na lugha zinazotumia hati ya Kiarabu), na pointi za msimbo za surrogate (Cs) huondolewa; \r\n husawazishwa kuwa \n. Kila thamani ina kikomo cha herufi 2,000 inapoonyeshwa. Mifuatano ya maandishi iliyotolewa husafishwa na kukatwa kabla ya kuhifadhiwa pia. Objekti ya asili lazima itoshee katika 32 KB za JSON ya UTF-8; objekti kubwa zaidi hupokea 400 kwenye maombi ya simu/kikao, huku uagizaji wa kampeni ukiripoti safu batili moja moja. Mikusanyiko na objekti zilizo ndani ya nyingine hazikubaliki kama thamani. Funguo za metadata zisizolingana (kwa mfano, kichwa cha CSV chenye nafasi) huhifadhiwa na kurudishwa lakini haziwezi kurejelewa na kishikilia nafasi.

Muktadha

context ni mfuatano wa maandishi wa hadi herufi 20,000. ThunderPhone huiweka baada ya prompt, mara vigeu vya prompt vinapojazwa, kama kizuizi kilichotenganishwa:

<your prompt, with its variables filled in>
 
Details for this call:
<call_context>
Ada rescheduled twice last month. She prefers mornings and asked us not to call her work number.
</call_context>

Ejenti huisoma pamoja na maelekezo yake, kwa hiyo iandike jinsi ambavyo ungempa mwenzako maelezo kabla ya simu. Muktadha si kiolezo: {{name}} ndani yake hubaki jinsi ulivyoandikwa. Ikiwa maandishi yanahitaji thamani, weka thamani hiyo wewe mwenyewe kabla ya kutuma.

  • null, mfuatano tupu, au nafasi tupu pekee humaanisha hakuna muktadha.
  • Thamani ambayo si mfuatano, au ina zaidi ya herufi 20,000, hukataliwa kwa 400 kwenye maombi ya simu na sesheni; kutoka webhook ya usanidi, hushindwa ubadilishanaji kama variables zisizo sahihi (tazama hapa chini).
  • Nafasi tupu za mwanzo na mwisho huondolewa, na herufi zilezile za udhibiti na umbizo kama zilizo katika thamani za vigeu huondolewa.
  • Muktadha ni sehemu ya prompt ya simu, kwa hivyo huhesabiwa katika ukubwa wa prompt wa simu.

Kwenye ejenti wa hatua, muktadha hufuata prompt ya kila ejenti katika simu, si maelekezo ya kila hatua.

Vyanzo vya thamani

API ya simu zinazotoka

Tuma variables na context kwenye POST /v1/call:

{
  "from_number": "+15551234567",
  "to_number": "+14155552671",
  "agent_id": 12,
  "variables": {
    "name": "Ada",
    "account_id": "A-17",
    "appointment_slot": "Tuesday at 10 AM"
  },
  "context": "Ada asked to be called back about the late fee on her March invoice."
}

Vyote pia hufanya kazi na ejenti chaguomsingi ya simu kwa simu zinazotoka, au kwa config.prompt ya ndani. Ukiwa na config ya ndani, context inaweza pia kuwekwa ndani ya config, sehemu ileile ambayo webhook ya usanidi hurejesha; ukituma vyote viwili, lazima viwe maandishi yaleyale. Ufunguo wa idempotency hauwezi kutumika tena ukiwa na variables tofauti au context tofauti.

CSV ya kampeni

Safu za CSV zisizo za simu tayari zimehifadhiwa kama vigeu vya anwani. Kila upigaji simu sasa unazitumia kiotomatiki. Tumia vichwa kama name, account_id, na appointment_slot ili vilingane na vishikilia nafasi vyako. Ulinganishaji wa jina uliopo unaweza kuunganisha safu za jina la kwanza na la mwisho kuwa kigeu name. Anwani za kampeni hazina muktadha wa kila anwani.

Webhook ya usanidi badilifu

Kwenye njia ya webhook ya usanidi inayozuia, rejesha ejenti iliyohifadhiwa katika shirika lako pamoja na thamani zozote za kila simu. Kwa ejenti wa Full duplex, simu huhifadhi sauti ya ejenti hata simu inapoanza kwa lugha nyingine inayotumika: ramani za sauti kwa kila lugha na ubadilishaji asilia wa sauti havitumiki kwenye simu hiyo.

{
  "agent_id": 12,
  "variables": {"name": "Ada", "account_id": "A-17"},
  "context": "[REDACTED_LITERAL]"
}
{
  "agent_id": 12,
  "variables": {"name": "Ada", "account_id": "A-17"},
  "context": "Ada called yesterday about a leak in unit 4B; a plumber is booked for Friday."
}

Vigeu vya jibu hubatilisha vigeu vya kiwango cha ombi, huku funguo nyingine za ombi zikisalia. Thamani ya jibu ya null huchagua chaguo-msingi la kishikilia nafasi. Kitu kilichounganishwa lazima pia kitoshee ndani ya KB 32. Majibu ya ejenti iliyohifadhiwa hukubali tu agent_id, variables, context, language na timezone ya kila simu; rudisha usanidi wa ndani unapohitaji kubadilisha prompt au mipangilio mingine. Majibu ya webhook ya ejenti iliyohifadhiwa hutumia mgawanyo wa A/B wa ejenti uliotumwa kwenye simu za simu na widget; vigeu hutolewa baada ya uteuzi wa toleo mbadala. Jibu linapoweka language kwa ejenti isiyo ya Full duplex, simu pia hutumia sauti ya lugha hiyo ikiwa ejenti ina sauti iliyowekwa kwa ajili yake. Jibu lenye prompt hutumia daima usanidi wa ndani: agent_id yoyote katika jibu hilo hupuuzwa, ikiwemo metadata ya null au isiyo nambari kamili. Prompt ya ndani lazima bado ipitie uthibitishaji wa kawaida. Majibu ya webhook ya ndani yanaweza kujumuisha variables na context pia. context ambayo si string au ni ndefu kupita kiasi husababisha ubadilishanaji ushindikane: simu ya simu hukataliwa, na ombi la kipindi cha widget hushindwa kwa 400. Majibu ya webhook ya ejenti iliyohifadhiwa hutumia mgawanyo wa A/B wa ejenti uliotumwa kwenye simu za simu na widget; vigeu hutolewa baada ya uteuzi wa toleo mbadala. Kwa simu zinazoingia, tumia nambari isiyo na ejenti ya simu zinazoingia iliyotengwa na usanidi webhook yake ya nambari ya simu au shirika; funguo za widget hutumia mode="webhook". Arifa zinazoingia za mfumo wa endpoint hazitoi majibu ya usanidi yanayozuia.

Webhook ya usanidi wa simu ya ejenti

Ili kuweka namba ikipewa ejenti yake na kujaza tu thamani za simu, ipa ejenti webhook ya usanidi wa simu. Kabla ya kila simu inayoingia ambayo ejenti hujibu kwenye namba, webhook hupokea simu pamoja na kitambulisho, jina na toleo la ejenti, kisha hujibu kwa variables, context, language na timezone ya kila simu kama hapo juu, bila kuhitaji agent_id. Ejenti ambaye mipangilio yake inatumia kishikilia nafasi kisicho na chaguo-msingi anahitaji webhook hii ili kujibu namba ya simu: simu haianzi webhook inaposhindwa. Vishikilia nafasi vyenye chaguo-msingi, kama {{name|there}}, huruhusu ejenti kujibu bila hiyo.

Vichwa vya SIP

Simu zinazomfikia ejenti kupitia SIP (kwa anwani ya SIP, au namba kwenye muunganisho wa SIP wa mwongozo) zinaweza kubeba muktadha katika vichwa vya X-* na User-to-User. Kila kimoja huwa kigezo cha sip_, kama {{sip_x_amzn_connectcontactid}} au {{sip_uui}}, chenye kipaumbele cha chini zaidi: thamani yenye jina sawa kutoka API au webhook hutumika badala yake. Tazama Pitisha muktadha wa simu katika vichwa vya SIP. Thamani za vichwa huwekwa na mtumaji, kwa hivyo zichukulie kama zisizoaminika, sawa na thamani yoyote inayotolewa na kivinjari.

API ya kikao cha wijeti

POST /v1/widget/session inakubali variables na language za kiwango cha juu. Ufunguo wake unaoweza kuchapishwa huchagua ejenti iliyohifadhiwa. Funguo za hali ya webhook hutuma thamani hizi kwa webhook ya usanidi na kuunganisha jibu kama ilivyoelezwa hapo juu. variables za wijeti zinazotolewa na kivinjari zinadhibitiwa na mteja, hutumwa bila kubadilishwa katika web.incoming baada ya uthibitishaji na usafishaji wa mifuatano ulioelezwa hapo juu, na hurudiwa katika webhook za ukamilishaji na historia ya simu. Usizichukulie kama data ya kuaminika ya utambulisho au uidhinishaji.

Sehemu ya context ya kivinjari ya wijeti yenyewe ni tofauti: hubeba maandishi kutoka ukurasa ambao mgeni yuko, ambayo ejenti huyachukulia kama maudhui ya tovuti (tazama Pachika wijeti ya wavuti). Muktadha wa kila simu wa simu ya wijeti hutoka kwenye webhook ya usanidi ya ufunguo wa modi ya webhook, kama ilivyo hapo juu. Simu inapokuwa na vyote viwili, muktadha wa kila simu huja kwanza, kisha maudhui ya ukurasa.

API ya kikao cha wakati halisi

POST /v1/realtime/sessions inakubali variables, context na language za kiwango cha juu pamoja na agent_id au config ya ndani:

{
  "agent_id": 12,
  "variables": {"name": "Ada"},
  "context": "Ada is calling from the front desk about a guest's lost key card."
}

context huwekwa katika kiwango cha juu pekee; config ya ndani huikataa kama uga usiojulikana.

WebSocket ya Wakati Halisi

Kwa ejenti iliyohifadhiwa, prompt iliyowekwa ya ejenti iliyohifadhiwa hubaki kuwa prompt yake. session.instructions huwa muktadha wa simu, session.prompt.variables (au session.config.variables) huwa vigezo vyake, na session.language huwa lugha yake kwa kila simu. Chagua ejenti kwa kutumia session.prompt.id katika session.update ya kwanza, ambayo huanzisha kipindi mara sasisho hilo linapowasili:

{
  "type": "session.update",
  "session": {
    "type": "realtime",
    "prompt": {"id": "12", "variables": {"name": "Ada"}},
    "instructions": "Ada asked for a callback about her delivery window."
  }
}

?agent_id=12 kwenye URL ya muunganisho huanzisha ejenti mara tu soketi inapounganishwa, kabla ya session.update yoyote, hivyo haina ingizo la kila simu. Ongeza &wait_for_session_update=1 ili kusubiri session.update ya kwanza na kutumia maelekezo na vigezo vyake.

Katika kipindi cha ndani ya mstari (bila ejenti iliyohifadhiwa), session.instructions ndiyo prompt yenyewe, kama ilivyokuwa awali. Simu za majaribio za maikrofoni ya Builder na zilizosanifiwa hutatua chaguo-msingi na vishikilia nafasi vinavyokosekana, lakini hazina vigezo vya kila simu wala ingizo la muktadha.

Baada ya simu

GET /v1/calls, GET /v1/calls/{call_id}, telephony.complete, na web.complete zinajumuisha variables na unresolved_variables za mwisho zilizounganishwa. Mizigo ya zamani ya ukamilishaji inayojumuisha data.history hujumuisha hizi pia:

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

prompt_snapshot ya simu (GET /v1/calls/{call_id}) huonyesha prompt ya ejenti ikiwa na vigezo vyake vilivyojazwa na bloku ya muktadha imeongezwa.

Hifadhi kitambulisho chako cha CRM au kazi katika objekti ya vigezo ili kuunganisha simu iliyokamilika na rekodi yake asili. Vigezo na muktadha huhifadhiwa pamoja na rekodi ya simu; tuma tu taarifa zinazofaa kuhifadhiwa katika historia ya simu na webhook.

Uchezaji upya wa simu, katika seti za uthibitishaji, matokeo ya uchezaji upya na uchunguzi, hutumia vigezo na muktadha wa simu hiyo pamoja na prompt inayojaribiwa, hivyo uchezaji upya hujaribu kile ambacho ejenti kwenye simu hiyo angekuwa ameambiwa.

Uoanifu wa prompt zilizopo

Utoaji pia hutumika kwa prompt zilizopo za ejenti zilizohifadhiwa na vibadala vya A/B, usanidi wa ndani wa simu za kutoka na wa wakati halisi, pamoja na prompt zinazorejeshwa na webhook za usanidi. Vipa nafasi visivyojulikana vya {{name}} hubadilika kuwa maandishi matupu, hata wakati hakuna variables zinazotolewa. Kagua prompt zilizopo kabla ya utekelezaji, ikijumuisha prompt za ndani/webhook zinazotolewa na vyanzo vya nje ambazo ThunderPhone haiwezi kuorodhesha. Simu za maikrofoni ya Builder na uigaji hutumia tabia hiyo hiyo ya chaguo-msingi/tupu.