Pielāgotas API integrācijas ļauj jūsu tērzēšanas robotam pieprasīt reāllaika informāciju no jūsu ERP, noliktavas sistēmas, CRM vai cita pakalpojuma. Tās var arī veikt izmaiņas, piemēram, izveidot pierakstu. Integrācija saglabā bāzes URL; katra operācija definē vienu izsaucamu pieprasījumu. Pēc tam jūs pievienojat atlasītās operācijas tērzēšanas robotam kā AI darbības.
Pirms darba sākšanas
Pārliecinieties, ka jūsu kontā ir iekļautas pielāgotas API integrācijas. Jums būs nepieciešams galapunkta URL, HTTP metode, parametru nosaukumi un veidi, autentifikācijas prasības un atbildes piemērs. Galapunktam jābūt sasniedzamam no ChatLab serveriem; localhost jūsu datorā nav darba vides galapunkts.
Konfigurēšanai izmantojiet HTTPS un testa pakalpojumu vai testa ierakstus. Testa pieprasījums patiešām izsauc galapunktu, tāpēc POST, PATCH vai DELETE pieprasījums var mainīt ārējos datus. Ja iespējams, veidojiet operācijas tā, lai tās būtu droši atkārtot.
1. Izveidojiet integrāciju
- Galvenajā navigācijā atveriet sadaļu Custom Integrations (Pielāgotās integrācijas).
- Noklikšķiniet uz + Define API Integration (+ Definēt API integrāciju).
- Ievadiet API name (API nosaukums) un API Base URL (API bāzes URL), piemēram,
https://api.example.com. - Noklikšķiniet uz Create API Integration (Izveidot API integrāciju).
- Tās saraksta ierakstā noklikšķiniet uz View (Skatīt) un pēc tam uz + Define API Operation (+ Definēt API operāciju).
2. Definējiet operāciju
Piešķiriet operācijai atpazīstamu nosaukumu un mašīnlasāmu Operation name (Operācijas nosaukums), piemēram, getProductDetails. Operācijas nosaukumam izmantojiet tikai burtus un ciparus, bez atstarpēm vai pasvītrām. Aprakstiet, ko operācija dara un kad tērzēšanas robotam tā būtu jāizmanto.
Ievadiet relatīvo URI, piemēram, /v1/products/@productId@. Bāzes URL un URI kopā veido pieprasījuma adresi.
Dažos esošajos ekrānuzņēmumos ir redzami vecāki piemēru nosaukumi vai vietturi figūriekavās. Ievērojiet pašreizējo sintaksi, kas aprakstīta tālāk: operāciju nosaukumus, piemēram, getProductDetails, un parametru vietturus, kurus ietver zīmes @.
Ceļa un vaicājuma parametri
Noklikšķiniet uz Add path variable (Pievienot ceļa mainīgo), lai definētu productId. Iestatiet tā datu tipu un vērtības avotu, pēc tam iekļaujiet @productId@ iekš URI. Ceļa mainīgie ir obligāti, un katram definētajam ceļa mainīgajam ir jāparādās URI, pirms varat saglabāt vai veikt testēšanu.
Izmantojiet Add query parameter (Pievienot vaicājuma parametru) tādiem parametriem kā limit vai language, kas atrodas aiz URL jautājuma zīmes. Ievadiet nosaukumu, kuru sagaida jūsu API, tā tipu, aprakstu un vērtības avotu.
Pieejamie vērtību avoti:
- Provided by user or chatbot: modelis nodrošina vērtību no sarunas. Paskaidrojiet sagaidāmo formātu un atbilstoši atzīmējiet obligātās vērtības.
- Constant: operācijā konfigurēta vērtība, piemēram, fiksēts konta identifikators vai ierobežots API akreditācijas datus.
- Random value: automātiski ģenerēta vērtība.
- Client context: vērtība, ko nodod mitinātāja vietne, ja tā ir pieejama jūsu kontam. Skatiet sadaļu Chat API.
Skalārie tipi ietver virkni (string), veselu skaitli (integer), daļskaitli (double) un Būla vērtību (boolean). Ķermeņa parametri atbalsta arī virkņu un veselu skaitļu masīvus.
3. Konfigurējiet metodi un pamattekstu (Body)
Izvēlieties GET, POST, PUT, PATCH vai DELETE atbilstoši savam galapunktam. Citām metodēm, kas nav GET, redaktors piedāvā raw vai form-data pieprasījuma saturu.
Neapstrādātam JSON pamattekstam definējiet pamatteksta parametrus un ievietojiet to vietturus @name@ veidnē. Pievienojiet atbilstošo Content-Type galveni, ko pieprasa jūsu galapunkts. Piemēram, ar virknes parametru name un virkņu masīva parametru tags:
{
"name": "@name@",
"tags": @tags@
}
Šī ir veidne, nevis burtisks JSON līdz aizstāšanas brīdim. Masīvu vietturi nedrīkst būt ietverti pēdiņās. Katrs definētais pamatteksta parametrs ir jāizmanto veidnē, kad tiek piemērots neapstrādāta pamatteksta redaktors. Testēšanas laikā pārbaudiet sagatavoto pieprasījumu, tostarp tekstu, kas satur pēdiņas vai īpašās rakstzīmes.
4. Pievienojiet autentifikācijas galvenes
Izmantojiet Add header (Pievienot galveni), lai definētu galvenes, ko sagaida API. Piekļuves marķierim (bearer token) izmantojiet galvenes nosaukumu Authorization, vērtības avotu Constant un vērtību Bearer YOUR_RESTRICTED_TOKEN.
Neiekļaujiet konfidenciālus datus uzvednēs un URL. Izvairieties no operācijām, kas modelim atgriež pieteikšanās marķierus un paļaujas uz instrukcijām to paslēpšanai. Ieteicams izmantot servera puses integrācijas galapunktu, kas pats pārvalda savu autentifikāciju un atklāj tikai atļauto operāciju.
5. Saglabājiet un testējiet pieprasījumu
- Operāciju redaktorā noklikšķiniet uz Save changes (Saglabāt izmaiņas). Atšķirībā no parastajiem tērzēšanas robota iestatījumiem šim redaktoram ir atsevišķa saglabāšanas poga.
- Noklikšķiniet uz Test API Operation (Testēt API operāciju). Tā ir atspējota, kamēr izmaiņas nav saglabātas.
- Ievadiet reprezentatīvas parametru vērtības. Masīvu testa ievadēm izmantojiet ar komatu atdalītas vērtības.
- Palaidiet testu tikai pret datiem, kurus jums ir atļauts lasīt vai mainīt.
- Pārbaudiet statusa kodu, atbildes pamattekstu, pieprasījuma URL, galvenes, pamattekstu un visus brīdinājumus, kas redzami rezultātos.
- Izlabojiet kļūdas, saglabājiet un pēc vajadzības atkārtojiet.
Nekopīgojiet testa rezultātus, kas satur akreditācijas datus. Ja iespējams, atgrieziet konkrētus, lapotus datus: liela apjoma atbildes var tikt saīsinātas, pirms tās sasniedz modeli.
6. Pievienojiet operāciju tērzēšanas robotam
Atveriet savu tērzēšanas robotu un dodieties uz Settings > Actions (Iestatījumi > Darbības). Izmantojiet plusa pogu, lai pievienotu darbību, atrodiet savu operāciju sadaļā Pielāgotie API un pievienojiet vai iespējojiet to. Tikai integrācijas izveide konta līmenī nepadara katru operāciju pieejamu katram tērzēšanas robotam.
Pārskatiet darbības instrukcijas un pieejamos drošības iestatījumus, pēc tam sagaidiet saglabāšanas statusu. Darbību redaktora aprakstu skatiet sadaļā AI darbības.
7. Paskaidrojiet, kad to lietot
Atveriet sadaļu Settings > Role & Behavior (Iestatījumi > Loma un uzvedība).
Ja izmantojat pielāgotas lomas instrukcijas, atlasiet Custom Role Definition (Pielāgota lomas definīcija) un pievienojiet precīzu noteikumu, piemēram: "Kad apmeklētājs jautā, vai prece ir noliktavā, izsauc getProductDetails ar tās preces ID. Ziņo par atgriezto pieejamību. Ja meklēšana neizdodas, paskaidro, ka pieejamību nevarēja pārbaudīt."
Saglabājiet citas noderīgās tērzēšanas robota instrukcijas. Sagaidiet saglabāšanas statusu, pēc tam izmantojiet sadaļas Overview (Pārskats) priekšskatījumu, lai pārbaudītu reālistiskus jautājumus, trūkstošus parametrus, kļūdas un neatļautus pieprasījumus. Priekšskatījuma sarunas var izsaukt reālas operācijas.
AI izsaukums netiek garantēts un ne vienmēr notiek tikai vienu reizi. Testējiet ar modeli, kas atlasīts jūsu tērzēšanas robotam; nepaļaujieties uz to, ka modeļa nosaukums vien garantē pareizu rīku izmantošanu.
Drošība un problēmu novēršana
Pirms sensitīvas informācijas atgriešanas vai izmaiņu veikšanas jūsu galapunktam ir jāautentificē pieprasījumi un jāautorizē katra lietotāja piekļuve. Pārlūkprogrammas nodrošināts klienta ID, e-pasts, pasūtījuma numurs vai konteksta lauks nav pietiekams identitātes apliecinājums. Ja nododat konkrēta lietotāja marķieri, izmantojot klienta kontekstu, jūsu serverim tas ir jāvalidē.
Atgrieziet tikai tos laukus, kas tērzēšanas robotam patiešām nepieciešami, piemēram, pasūtījuma statusu, nevis pilnu klienta profilu. Uzvednes instrukcijas var vadīt formulējumu, taču tās nevar garantēt, ka modelim atgrieztie sensitīvie dati paliks apslēpti.
Ja pieprasījums ir veiksmīgs testēšanas redaktorā, bet ne sarunā, pārbaudiet pievienoto darbību, tās iespējoto statusu, instrukcijas, obligātos parametrus un pieejamo kontekstu. Ja neizdodas abi, pārbaudiet URL, HTTP metodi, autentifikāciju, sagatavoto pamattekstu un sava galapunkta žurnālus. Izvairieties no atkārtotiem ierakstīšanas operācijas mēģinājumiem, kamēr nezināt, vai iepriekšējais pieprasījums bija veiksmīgs.