Individualios API integracijos

Integruokite savo chatbotą su pasirinktinėmis API

Naudodami mūsų dirbtinio intelekto veiksmų rengyklę galite sukurti bet kokią pasirinktinę integraciją su bet kuria vidine sistema, galinčia pateikti duomenis per API galinius taškus. Pavyzdžiui, galite nustatyti, kad chatbotas patikrintų prekės likutį jūsų sandėlyje, užsakymo būseną jūsų ERP sistemoje arba esamą kliento sąskaitos likutį.

Taip pat galite vykdyti veiksmus išorinėms sistemoms atnaujinti - pavyzdžiui, iškviesti galinius taškus, kurie registruoja susitikimus arba webhookus.

Būtinosios sąlygos

ℹ️ Prieš pradėdami įsitikinkite, kad turite ChatLab prenumeratą, leidžiančią pasirinktines API integracijas. Peržiūrėkite kainų puslapį

Pasirinktinės API pridėjimas prie jūsų chatboto

Pasirinktinės API integravimas leidžia jūsų chatbotui bendrauti su išorinėmis paslaugomis - pavyzdžiui, su jūsų el. parduotuve, gauti duomenis arba atlikti veiksmus naudotojo vardu.

Šiame vadove sužinosite, kaip ChatLab platformoje nustatyti pasirinktinę API.

Jūsų API

Turite turėti viešai pasiekiamus API galinius taškus, kuriuos galėtų iškviesti chatbotas - tai reiškia, kad turite pateikti duomenis iš savo e-commerce platformos arba pasirinktinės sistemos per API galinius taškus, kad mūsų chatbotas galėtų juos iškviesti, gauti šiuos duomenis ir pateikti juos jūsų naudotojams.

API iškvietimas per chatbotą

Chatbotas dinamiškai iškvies API naudotojų bendravimo metu, atsižvelgdamas į poreikį pasiekti išorinius duomenis arba atlikti konkrečius veiksmus. Svarbu atkreipti dėmesį į šiuos dalykus:

• Nėra garantuoto iškvietimo: API bus iškviečiama tik tada, kai chatboto logika nuspręs, kad tai būtina. Nėra jokių garantijų, kada ar kaip dažnai API bus iškviečiama.

• Reikalavimai DI modeliui: Siekiant optimalaus veikimo, rekomenduojama naudoti aukštesnio lygio DI modelius, palaikančius sudėtingą funkcijų iškvietimą (angl. function calling), tokius kaip GPT-4o ar naujesnius. Šie modeliai geriau nustato tinkamus momentus API iškviesti, remdamiesi pokalbio kontekstu ir naudotojo ketinimu.

• Atsižvelgimas į kontekstą: Chatbotas bandys iškviesti API kaskart, kai pokalbyje atpažins kontekstą, atitinkantį API paskirtį, tačiau pats iškvietimas priklausys nuo kelių veiksnių, tokių kaip:

  • Išorinės API pasiekiamumas ir atsako greitis.
  • Esama pokalbio būsena ir naudotojo užklausos (prompts).
  • Vidiniai DI modelio pasitikėjimo lygiai ir vertinimo algoritmai, sprendžiantys dėl iškvietimo būtinybės.

Žingsniai, kaip nustatyti pasirinktinę API

1 žingsnis: Eikite į pasirinktinės API nustatymus

1. Prisijunkite prie savo ChatLab valdymo skydelio.

2. Kairėje šoninėje juostoje, skiltyje Settings (Nustatymai), spustelėkite Custom API (Pasirinktinė API).

2 žingsnis: Apibrėžkite naują API

1. Spustelėkite mygtuką + Define API (+ Apibrėžti API).

2. Lauke API Name (API pavadinimas) įveskite savo API pavadinimą.

3. Lauke URL nurodykite išorinės paslaugos, prie kurios norite prisijungti, bazinį URL adresą.

4. Spustelėkite Save (Išsaugoti), kad sukurtumėte API.

3 žingsnis: Pridėkite API operacijas

1. Naujai sukurtoje API eilutėje spustelėkite mygtuką View (Peržiūrėti).

2. Spustelėkite + Define API Operation (+ Apibrėžti API operaciją), kad nustatytumėte atskiras API operacijas (galinius taškus).

3. Užpildykite reikiamą informaciją:

• Operation Name (Operacijos pavadinimas): aprašomasis operacijos pavadinimas.
• Operation URI (Operacijos URI): operacijos galinio taško kelias (pvz., /v1/resource).

4 žingsnis: Konfigūruokite galinio taško URI ir parametrus

1. Galinio taško URI konfigūracija:

• Pridėkite visus operacijai reikalingus kelio kintamuosius spustelėdami + Add path variable (+ Pridėti kelio kintamąjį).
• Įveskite kintamojo duomenis ir, jei reikia, pažymėkite juos kaip privalomus.

• Pasirinkite reikšmės šaltinį:
  • Provided by user to chatbot - jei šiai reikšmei užpildyti reikalinga naudotojo pateikta informacija.
  • Constant - jei tai pastovi reikšmė, kurią turėsite nurodyti apibrėždami API operaciją.
• Pridėkite naujai sukurtą kelio kintamąjį į kelio apibrėžimą tarp dviejų „@“ simbolių: @myvariable@:

1. Užklausos parametrai (Query Parameters):

• Pridėkite užklausos parametrus spustelėdami + Add query parameter (+ Pridėti užklausos parametrą).
• Nurodykite parametro pavadinimą, duomenų tipą ir šaltinį (pvz., pateiktą naudotojo arba chatboto).

5 žingsnis: Nustatykite užklausos metodą ir turinį (Body)

1. Pasirinkite operacijos HTTP metodą (pvz., GET, POST).

2. Jei užklausos metodas yra POST, sukonfigūruokite užklausos turinį (request body):

• Pasirinkite turinio tipą (pvz., application/json).
• Pridėkite užklausos turinio parametrus, nurodydami pavadinimą, duomenų tipą ir šaltinį.

• Pridėkite kintamuosius į turinio apibrėžimą - dažniausiai tai yra JSON formatas, kuriame galite įterpti apibrėžtus kintamuosius.

6 žingsnis: Nustatykite operacijos antraštes

Pridėkite antraštes - pvz., Authorization ar kitas, kurių reikalauja jūsų API. Žemiau pateiktame ekrano vaizde parodyta, kaip nustatyti nuolatinį žetoną (token) Authorization antraštėje:

7 žingsnis: Išsaugokite operaciją

1. Peržiūrėkite konfigūraciją ir įsitikinkite, kad visa informacija yra teisinga.

2. Spustelėkite Save changes (Išsaugoti pakeitimus), kad išsaugotumėte API operaciją.

8 žingsnis: Išbandykite API integraciją

1. Naudokite Test API (Išbandyti API) funkciją, kad išsiųstumėte bandomąją užklausą ir įsitikintumėte, jog integracija veikia tinkamai.

2. Stebėkite žurnalus (logs), ar nėra klaidų ar problemų, ir prireikus pakoreguokite konfigūraciją.

9 žingsnis: Priskirkite API operacijas chatbotui

Kai API Operations yra apibrėžtos, laikas jas priskirti chatbotui. Pagrindiniame chatbotų valdymo lange pasirinkite chatbotą, spustelėkite Integrations (Integracijos) ir kairiajame meniu pasirinkite AI API Actions (DI API veiksmai).

Spustelėkite Attach (Prisegti) ties pasirinkta API operacija.

10 žingsnis: Pridėkite vaidmens instrukcijas chatbotui

Pagrindiniame chatbotų valdymo lange pasirinkite savo chatbotą, spustelėkite Settings (Nustatymai) ir kairiajame meniu pasirinkite Role (Vaidmuo).

Spustelėkite Provide custom role instructions (Pateikti pasirinktines vaidmens instrukcijas).

Pridėkite instrukcijas, kaip naudoti naujai pridėtą API operaciją, pavyzdžiui, galite pridėti taisyklę:

„- Kai naudotojas teiraujasi apie parduotuvės asortimento likutį, visada iškviesk funkciją getItems ir pateik jos rezultatą pagal šias taisykles...“

Patarimai sėkmingai integracijai

• Įsitikinkite, kad bazinis URL ir galiniai taškai yra teisingi bei pasiekiami.

• Patikrinkite, ar tinkamai sukonfigūruoti visi autentifikavimo reikalavimai (pvz., API raktai ar žetonai).

• Kruopščiai išbandykite kiekvieną operaciją, kad įsitikintumėte, jog ji grąžina laukiamus atsakymus.

Atlikę šiuos veiksmus, galite sklandžiai integruoti pasirinktines API į savo ChatLab chatbotą, išplėsdami jo funkcionalumą ir suteikdami geresnę patirtį naudotojams.

Pasirinktinės API integracijos apsauga

Norėdami užtikrinti, kad jūsų pasirinktinė API būtų saugi ir apsaugota nuo neteisėtos prieigos, atsižvelkite į šią gerąją praktiką:

Naudokite pastovius žetonus (tokens)

Pastovūs API žetonai: nustatykite pastovų API žetoną (arba raktą), kurio reikalaujama visoms užklausoms į API. Šis žetonas turi būti unikalus ir saugiai sugeneruotas.

• Kaip įgyvendinti: įtraukite žetoną į užklausos antraštę arba kaip užklausos parametrą kiekviename API iškvietime.

• Kur saugoti: saugiai išsaugokite žetoną savo ChatLab nustatymuose kaip pastovų operacijos parametrą.

Laikiniems žetonams naudokite prisijungimo galinį tašką

Prie API pridėkite papildomą API operaciją, kuri grąžina laikiną saugumo žetoną - t. y. prisijungimo galinį tašką prie jūsų sistemos.

Apibrėždami šią API operaciją, kaip pastovius API operacijos parametrus turėsite nurodyti savo sistemos prisijungimo duomenis. Kad chatbotas galėtų naudoti tokiu būdu gautą žetoną, turite pridėti saugumo žetoną kitų API operacijų apibrėžimuose ir pateikti tinkamas promptų instrukcijas tiek prisijungimo operacijai, tiek kitoms API operacijoms (pavyzdžiui, „Visada naudok saugumo žetoną, gautą iš prisijungimo operacijos, kaip parametrą security_token operacijai getOrder“).

Jautrios informacijos valdymas per ChatLab

Norėdami neleisti chatbotui rodyti jautrios informacijos, ChatLab naudotojai gali imtis šių veiksmų:

Naudokite promptų inžineriją DI elgesiui nukreipti

• Nustatykite aiškias instrukcijas promptuose: konfigūruodami chatbotą, promptų nustatymuose pateikite aiškias instrukcijas, kad nebūtų rodoma jokia jautri informacija. Pavyzdžiui:

  • Prompt pavyzdys: „Nerodyk jokios asmeninės, finansinės ar konfidencialios informacijos, gautos iš API iškvietimo.“
  • Sisteminių pranešimų naudojimas: pokalbio eigos pradžioje įtraukite sisteminį pranešimą, pabrėžiantį duomenų privatumo svarbą (pvz., „Užtikrink, kad visuose atsakymuose nebūtų jokios jautrios informacijos.“).

• Reguliariai atnaujinkite promptus: koreguokite promptus atsižvelgdami į naudotojų atsiliepimus arba duomenų jautrumo reikalavimų pasikeitimus. Tai padeda užtikrinti, kad DI nuosekliai laikytųsi naujausių jautrios informacijos tvarkymo gairių.

Kurkite API galinius taškus su integruota patikros logika

• Reikalaukite naudotojo tapatybės patvirtinimo prieigai prie jautrių duomenų: kurkite API galinius taškus taip, kad prieš grąžinant jautrius duomenis būtų atliekami patikrinimai. Pavyzdžiui:

  • Patikros parametrai: reikalaukite, kad naudotojai pateiktų tam tikrą informaciją (pvz., el. pašto adresą, užsakymo numerį arba konkretų saugumo klausimą), prieš API grąžinant su tuo naudotoju susijusius duomenis.
  • Kelių veiksnių patikra: įdiekite papildomus parametrus (pvz., užsakymo datą, pristatymo adresą arba slaptą kodą), kad patvirtintumėte naudotojo tapatybę ir užtikrintumėte, jog jis turi teisę pasiekti duomenis.

• Įdiekite atsarginius atsakymus (fail-safe): nustatykite savo API logiką grąžinti bendro pobūdžio pranešimus arba klaidas, jei reikalingi patikros duomenys nepateikiami arba nesutampa:

  • Pavyzdys: „Nepavyko gauti išsamios informacijos apie užsakymą. Patikrinkite savo el. pašto adresą ir užsakymo numerį.“

Naudokite ribotas duomenų apimtis API atsakymuose

• Sumažinkite atskleidžiamų duomenų kiekį: sukonfigūruokite API atsakymus taip, kad juose būtų tik tie duomenys, kurie būtini chatboto funkcijai atlikti, taip sumažinant riziką netyčia parodyti jautrią informaciją.
  • Pavyzdys: užuot grąžinę visą naudotojo profilį, grąžinkite tik konkrečius laukus, pvz., užsakymo būseną arba mokėjimo patvirtinimą, kurie yra reikalingi chatboto užduočiai atlikti.