Kohandatud API integratsioonid (Custom API integrations) võimaldavad teie chatbotil pärida reaalajas teavet teie ERP-st, laosüsteemist, CRM-ist või muust teenusest. Samuti saavad need teha muudatusi, näiteks luua broneeringu. Integratsioon talletab baas-URL-i; iga operatsioon määratleb ühe väljakutsutava päringu. Seejärel seote valitud operatsioonid chatbotiga kui AI actions (AI-toimingud).
Enne alustamist
Veenduge, et teie konto sisaldab kohandatud API integratsioone. Vajate lõpp-punkti URL-i, HTTP-meetodit, parameetrite nimesid ja tüüpe, autentimisnõudeid ning näidisvastust. Lõpp-punkt peab olema ChatLabi serveritest kättesaadav; teie arvuti localhost ei ole tootmiskõlblik lõpp-punkt.
Kasutage seadistamiseks HTTPS-i ja testteenust või testkirjeid. Testpäring teeb päriselt väljakutse lõpp-punkti, seega võivad POST, PATCH või DELETE väliseid andmeid muuta. Võimalusel muutke operatsioonid turvaliselt korratavaks.
1. Looge integratsioon
- Avage peamenüüst Custom Integrations (Kohandatud integratsioonid).
- Klõpsake + Define API Integration (Määratle API integratsioon).
- Sisestage API name (API nimi) ja API Base URL (API baas-URL), näiteks
https://api.example.com. - Klõpsake Create API Integration (Loo API integratsioon).
- Klõpsake selle loendikirjes View (Vaata), seejärel + Define API Operation (Määratle API operatsioon).
2. Määratlege operatsioon
Andke operatsioonile äratuntav silt ja masinloetav Operation name (Operatsiooni nimi), näiteks getProductDetails. Kasutage operatsiooni nimes ainult tähti ja numbreid, mitte tühikuid ega alakriipse. Kirjeldage, mida operatsioon teeb ja millal chatbot peaks seda kasutama.
Sisestage suhteline URI, näiteks /v1/products/@productId@. Baas-URL ja URI moodustavad päringu aadressi.
Mõned olemasolevad ekraanipildid näitavad vanemaid näidisnimesid või looksulgudega kohahoidjaid. Järgige alltoodud kehtivat süntaksit: operatsioonide nimed nagu getProductDetails ja parameetrite kohahoidjad, mida ümbritsevad sümbolid @.
Tee- ja päringuparameetrid
Klõpsake Add path variable (Lisa teemuutuja), et määratleda productId. Määrake selle andmetüüp ja väärtuse allikas, seejärel lisage @productId@ URI-sse. Teemuutujad on kohustuslikud ja iga määratletud teemuutuja peab enne salvestamist või testimist URI-s esinema.
Kasutage valikut Add query parameter (Lisa päringuparameeter) parameetrite jaoks, nagu limit või language, mis käivad URL-i küsimärgi järel. Sisestage oma API oodatav nimi, selle tüüp, kirjeldus ja väärtuse allikas.
Saadaolevad väärtuste allikad hõlmavad järgmist:
- Provided by user or chatbot: mudel hangib väärtuse vestlusest. Selgitage oodatavat vormingut ja märkige nõutavad väärtused vastavalt.
- Constant: operatsioonis konfigureeritud väärtus, näiteks fikseeritud konto identifikaator või piiratud API mandaat.
- Random value: automaatselt genereeritav väärtus.
- Client context: hostveebisaidi edastatud väärtus, kui see on teie konto jaoks saadaval. Vaadake Chat API.
Skalaartüübid hõlmavad väärtusi string, integer, double ja boolean. Päringu keha (body) parameetrid toetavad ka string- ja integer-massiive.
3. Konfigureerige meetod ja päringu keha
Valige GET, POST, PUT, PATCH või DELETE vastavalt oma lõpp-punktile. Muude meetodite kui GET puhul pakub redaktor päringu sisuks valikuid raw või form-data.
Töötlemata JSON-keha (raw) puhul määratlege keha parameetrid ja sisestage nende kohahoidjad @name@ malli. Lisage sobiv päis Content-Type, mida teie lõpp-punkt nõuab. Näiteks string-tüüpi parameetri name ja string-massiivi tags parameetritega:
{
"name": "@name@",
"tags": @tags@
}
See on mall, mitte sõnasõnaline JSON enne asenduse tegemist. Massiivi kohahoidjaid ei tohi ümbritseda jutumärkidega. Töötlemata keha redaktori kasutamisel tuleb mallis ära kasutada iga määratletud keha parameeter. Kontrollige testimise ajal genereeritud päringut, sealhulgas jutumärke või erimärke sisaldavat teksti.
4. Lisage autentimispäised
Kasutage valikut Add header (Lisa päis), et määratleda API oodatavad päised. Bearer-tõendi puhul kasutage päise nime Authorization, väärtuse allikaks Constant ja väärtuseks Bearer YOUR_RESTRICTED_TOKEN.
Hoidke saladused viipadest ja URL-idest eemal. Vältige operatsioone, mis tagastavad mudelile sisselogimistõendeid ja loodavad juhistele nende peitmiseks. Eelistage serveripoolset integratsiooni lõpp-punkti, mis haldab ise oma autentimist ja teeb kättesaadavaks ainult lubatud operatsiooni.
5. Salvestage ja testige päringut
- Klõpsake operatsiooni redaktoris Save changes (Salvesta muudatused). Erinevalt tavapärastest chatboti seadetest (Settings) on sellel redaktoril eraldi salvestamisnupp.
- Klõpsake Test API Operation (Testi API operatsiooni). See on keelatud seni, kuni muudatused on salvestamata.
- Sisestage esinduslikud parameetrite väärtused. Massiivi testsisendite puhul kasutage komadega eraldatud väärtusi.
- Käitage testi ainult andmetega, mida teil on luba lugeda või muuta.
- Kontrollige olekukoodi, vastuse keha, päringu URL-i, päiseid, keha ja kõiki tulemustes kuvatavaid hoiatusi.
- Parandage vead, salvestage ja korrake vastavalt vajadusele.
Ärge jagage testväljundit, mis sisaldab mandaate. Võimalusel tagastage täpselt suunatud lehekülgedeks jaotatud andmed: mahukaid vastuseid võidakse kärpida enne, kui need mudelini jõuavad.
6. Siduge operatsioon chatbotiga
Avage oma chatbot, seejärel Settings > Actions (Seaded > Toimingud). Kasutage plussnuppu toimingu lisamiseks, leidke oma operatsioon kohandatud API-de alt ning siduge või lubage see. Ainuüksi konto tasemel integratsiooni loomine ei muuda iga operatsiooni igale chatbotile kättesaadavaks.
Vaadake üle toimingu juhised ja saadaolevad turvaseaded ning oodake, kuni kuvatakse salvestatud olek. Toimingute redaktori kohta vaadake AI actions.
7. Selgitage, millal seda kasutada
Avage Settings > Role & Behavior (Seaded > Roll ja käitumine).
Kui kasutate kohandatud rollijuhiseid, valige Custom Role Definition (Kohandatud rollimääratlus) ja lisage täpne reegel, näiteks: "Kui külastaja küsib, kas toode on laos olemas, kutsu välja getProductDetails selle toote ID-ga. Teata tagastatud saadavusest. Kui päring ebaõnnestub, selgita, et saadavust ei saanud kontrollida."
Säilitage chatboti muud kasulikud juhised. Oodake, kuni kuvatakse salvestatud olek, seejärel kasutage vaate Overview (Ülevaade) eelvaadet, et testida realistlikke küsimusi, puuduvaid parameetreid, vigu ja volitamata päringuid. Eelvaate vestlused võivad käivitada päris operatsioone.
AI väljakutsumine ei ole garanteeritud ega pruugi toimuda vaid ühekordselt. Testige oma chatboti jaoks valitud mudeliga; ärge eeldage, et pelgalt mudeli nimi tagab tööriista õige kasutamise.
Turvalisus ja tõrkeotsing
Teie lõpp-punkt peab päringud autentima ja autoriseerima iga kasutaja juurdepääsu enne tundliku teabe tagastamist või muudatuse tegemist. Brauseri edastatud kliendi ID, e-posti aadress, tellimuse number või kontekstiväli ei ole piisav isikutõend. Kui edastate kasutajapõhise tõendi kliendikonteksti kaudu, peab teie server seda valideerima.
Tagastage ainult need väljad, mida chatbot vajab, näiteks kliendi täieliku profiili asemel tellimuse olek. Viipajuhised võivad suunata sõnastust, kuid ei saa garanteerida, et mudelile tagastatud tundlikud andmed jäävad varjatuks.
Kui päring õnnestub testiredaktoris, kuid mitte vestluses, kontrollige seotud toimingut, selle lubatud olekut, juhiseid, nõutavaid parameetreid ja saadaolevat konteksti. Kui mõlemad ebaõnnestuvad, kontrollige URL-i, HTTP-meetodit, autentimist, genereeritud päringu keha ja oma lõpp-punkti logisid. Vältige kirjutusoperatsiooni korduvat uuesti proovimist, kuni teate, kas eelmine päring õnnestus.