Kohandatud API-integratsioonid

Integreerige oma chatbot kohandatud API-dega

Meie AI-tegevuste redaktori abil saate luua mis tahes kohandatud integratsiooni mis tahes taustasüsteemiga, mis suudab andmeid API-lõpp-punktide kaudu edastada. Näiteks saate panna chatboti kontrollima toote saadavust teie laos, tellimuse staatust teie ERP-süsteemis või kliendikonto hetkejääki.

Samuti saate käivitada toiminguid väliste süsteemide värskendamiseks - näiteks kutsuda välja lõpp-punkte, mis määravad kohtumisi või saadavad veebikonkse (Webhooks).

Eeltingimused

ℹ️ Enne alustamist veenduge, et teil on ChatLabi tellimus, mis võimaldab kohandatud API integratsioone. Vaadake hinnakirja lehte

Kohandatud API lisamine teie chatbotile

Kohandatud API integreerimine võimaldab teie chatbotil suhelda välisteenustega - näiteks teie e-poega, pärides andmeid või tehes kasutaja nimel toiminguid.

Käesolev juhend selgitab teile samme, mis on vajalikud kohandatud API seadistamiseks ChatLabi platvormi abil.

Teie API

Teil peavad olema avalikult kättesaadavad API-lõpp-punktid, mida chatbot saab välja kutsuda - see tähendab, et peate edastama andmeid oma e-kaubanduse platvormilt või kohandatud süsteemist API-lõpp-punktide kaudu, et meie chatbot saaks neid lõpp-punkte kutsuda, andmeid hankida ja neid teie kasutajatele edastada.

API väljakutsumine chatboti poolt

Chatbot kutsub API-t kasutajaga suhtlemise ajal dünaamiliselt välja vastavalt vajadusele pääseda ligi välistele andmetele või teha konkreetseid toiminguid. Oluline on märkida järgmist:

• Garanteeritud väljakutsumise puudumine: API-t kutsutakse välja ainult siis, kui chatboti loogika peab seda vajalikuks. Puuduvad garantiid selle kohta, millal või kui sageli API-t välja kutsutakse.

• Nõuded AI-mudelile: Optimaalse jõudluse tagamiseks on soovitatav kasutada kõrgema taseme AI-mudeleid, mis toetavad keerulist funktsioonide kutsumist (function calling), näiteks GPT-4o või uuemad. Need mudelid suudavad vestluse konteksti ja kasutaja kavatsuse põhjal paremini tuvastada sobivaid hetki API väljakutsumiseks.

• Kontekstitundlikud väljakutsed: Chatbot proovib API-t välja kutsuda alati, kui tuvastab vestluses konteksti, mis vastab API eesmärgile, kuid tegelik väljakutse sõltub mitmest tegurist, näiteks:

  • Välise API kättesaadavus ja vastamiskiirus.
  • Vestluse hetkeseis ja kasutaja sisendid (promptid).
  • AI-mudeli sisemine kindlustunne ja hindamisalgoritmid kõne vajalikkuse otsustamisel.

Sammud kohandatud API seadistamiseks

1. samm: minge kohandatud API seadetesse

1. Logige sisse oma ChatLabi töölauale.

2. Klõpsake vasakpoolsel külgribal jaotises Settings (Seaded) valikul Custom API (Kohandatud API).

2. samm: määrake uus API

1. Klõpsake nupul + Define API (+ Määra API).

2. Sisestage oma API nimi väljale API Name (API nimi).

3. Sisestage väljale URL selle välisteenuse baas-URL, millega soovite ühenduse luua.

4. API loomiseks klõpsake Save (Salvesta).

3. samm: lisage API toimingud

1. Klõpsake vastloodud kirjes API nupul View (Kuva).

2. Klõpsake nupul + Define API Operation (+ Määra API toiming), et seadistada API jaoks üksikud toimingud (lõpp-punktid).

3. Täitke nõutud andmed:

• Operation Name (Toimingu nimi): toimingu kirjeldav nimi.
• Operation URI (Toimingu URI): toimingu lõpp-punkti tee (nt /v1/resource).

4. samm: seadistage lõpp-punkti URI ja parameetrid

1. Lõpp-punkti URI seadistamine:

• Lisage toimingu jaoks vajalikud teemuutujad, klõpsates nupul + Add path variable (+ Lisa teemuutuja).
• Sisestage muutuja andmed ja märkige need vajadusel kohustuslikuks.

• Valige väärtuse allikas:
  • Provided by user to chatbot - juhul kui selle täitmiseks on vaja väärtust kasutajalt.
  • Constant - juhul kui tegemist on püsiväärtusega, mille peate esitama API toimingu määratlemise hetkel
• Lisage vastloodud teemuutuja tee määratlusesse kahe märgi „@” vahele: @minumuutuja@:

1. Päringuparameetrid (Query Parameters):

• Lisage mis tahes päringuparameetrid, klõpsates nupul + Add query parameter (+ Lisa päringuparameeter).
• Määrake parameetri nimi, andmetüüp ja allikas (nt kasutaja või chatboti poolt esitatud).

5. samm: määrake päringu meetod ja keha

1. Valige toimingu jaoks HTTP-meetod (nt GET, POST).

2. Kui päringu meetod on POST, seadistage päringu keha:

• Valige sisutüüp (nt application/json).
• Lisage keha parameetrid, täpsustades nime, andmetüübi ja allika.

• Lisage muutujad keha definitsiooni - tavaliselt on see JSON, kuhu saate paigutada määratletud muutujad

6. samm: määrake toimingu päised

Lisage päised - st Authorization või muud teie API jaoks vajalikud päised. Püsiva tokeni seadistamiseks päises Authorization vaadake allolevat kuvatõmmist:

7. samm: salvestage toiming

1. Vaadake konfiguratsioon üle ja veenduge, et kõik andmed on õiged.

2. API toimingu salvestamiseks klõpsake Save changes (Salvesta muudatused).

8. samm: testige API integratsiooni

1. Kasutage funktsiooni Test API (Testi API-t) testpäringu saatmiseks ning veenduge, et integratsioon töötab korralikult.

2. Jälgige logisid vigade või probleemide suhtes ning kohandage konfiguratsiooni vastavalt vajadusele.

9. samm: siduge API toimingud chatbotiga

Kui teil on API Operations määratletud, on aeg need chatbotile määrata. Valige peamisel chatbotide töölaual chatbot, klõpsake Integrations (Integratsioonid) ja valige vasakpoolsest menüüst AI API Actions (AI API toimingud)

Klõpsake valitud API toimingu juures nupul Attach (Seo)

10. samm: lisage chatbotile rollijuhised

Valige peamisel chatbotide töölaual oma chatbot, klõpsake Settings, valige vasakpoolsest menüüst Role (Roll)

Klõpsake valikul Provide custom role instructions (Määra kohandatud rollijuhised).

Lisage juhised vastlisatud API toimingu kasutamiseks, näiteks saate lisada reegli:

„- Kui kasutaja küsib poe laoseisu, kutsu alati välja funktsioon getItems ja kuva funktsiooni tulemus järgmiste reeglite alusel.....”

Soovitused edukaks integreerimiseks

• Veenduge, et baas-URL ja lõpp-punktid on õiged ning kättesaadavad.

• Kontrollige, et kõik autentimisnõuded (nt API-võtmed või tokenid) on õigesti konfigureeritud.

• Testige iga toimingut põhjalikult, tagamaks, et see tagastab oodatud vastused.

Järgides neid samme, saate kohandatud API-d sujuvalt oma ChatLabi chatbotiga integreerida, täiustades selle funktsionaalsust ja pakkudes paremat kasutajakogemust.

Oma kohandatud API integratsiooni turvamine

Tagamaks, et teie kohandatud API on turvaline ja volitamata juurdepääsu eest kaitstud, kaaluge järgmiste heade tavade järgimist:

Kasutage püsivaid tokeneid

Püsivad API tokenid: Seadistage püsiv API token (või võti), mida nõutakse kõigi API-päringute puhul. See token peaks olema unikaalne ja genereeritud turvaliselt.

• Kuidas rakendada: Lisage token igas API-väljakutses päringu päisesse või päringuparameetrina.

• Kus talletada: Talletage tokenit turvaliselt oma ChatLabi seadetes toimingu püsiparameetrina

Kasutage ajutiste tokenite jaoks sisselogimise lõpp-punkti

Lisage API-le täiendav API toiming, mis tagastab ajutise turvatokeni - st sisselogimise lõpp-punkt teie süsteemi.

Selle API toimingu määratlemisel peate esitama oma süsteemile vastavad sisselogimisandmed püsivate API toimingu parameetritena. Et chatbot saaks sel viisil hangitud tokenit kasutada, peate lisama turvatokeni teiste API toimingute definitsioonidesse ja lisama asjakohased promptijuhised nii sisselogimistoimingule kui ka teistele API toimingutele (näiteks „Kasuta sisselogimistoimingust Login saadud turvatokenit alati toimingu getOrder parameetrina security_token”).

Tundliku teabe kontrollimine ChatLabi kaudu

Vältimaks tundliku teabe kuvamist chatboti poolt, saavad ChatLabi kasutajad teha järgmisi samme:

Kasutage AI käitumise suunamiseks promptitehnoloogiat

• Määrake promptides selged juhised: Chatboti konfigureerimisel esitage prompti seadetes selged juhised tundliku teabe kuvamise vältimiseks. Näiteks:

  • Prompti näide: „Ära kuva isiklikku, finantsilist ega konfidentsiaalset teavet, mis tagastatakse API väljakutsest.”
  • Süsteemisõnumite kasutamine: Lisage vestlusvoo algusesse süsteemisõnum, mis rõhutab andmete privaatsuse olulisust (nt „Veendu, et kõik väljundid välistavad mis tahes tundliku teabe.”).

• Uuendage prompte regulaarselt: Kohandage prompte vastavalt kasutajate tagasisidele või andmetundlikkuse nõuete muutumisele. See aitab tagada, et AI järgib tundliku teabe käsitlemisel järjepidevalt uusimaid suuniseid.

Kujundage API-lõpp-punktid sisseehitatud kontrolliloogikaga

• Nõudke tundlikele andmetele juurdepääsuks kasutaja kontrollimist: Kujundage oma API-lõpp-punktid nii, et need sisaldaksid kontrolltoiminguid enne tundlike andmete tagastamist. Näiteks:

  • Kontrollparameetrid: Nõudke, et kasutajad esitaksid teatud teabe (nt e-posti aadress, tellimuse number või konkreetne turvaküsimus), enne kui API tagastab selle kasutajaga seotud andmed.
  • Mitmeastmeline kontroll: Rakendage täiendavaid parameetreid (nt tellimuse kuupäev, tarneaadress või salakood), et kontrollida kasutaja isikut ja veenduda tema volituses andmetele ligi pääseda.

• Rakendage tõrkekindlaid vastuseid: Seadistage oma API loogika tagastama üldiseid sõnumeid või veateateid, kui nõutud kinnitust ei esitata või see ei kattu:

  • Näide: „Tellimuse üksikasju ei õnnestunud hankida. Palun kontrollige oma e-posti aadressi ja tellimuse numbrit.”

Kasutage API vastustes piiratud andmemahtu

• Minimeerige andmete avaldamist: Konfigureerige API vastused sisaldama ainult neid andmeid, mis on vajalikud chatboti toimimiseks, vähendades riski tundliku teabe tahtmatuks kuvamiseks.
  • Näide: Tervete kasutajaprofiilide tagastamise asemel tagastage ainult konkreetsed väljad, nagu tellimuse staatus või maksekinnitus, mis on chatboti ülesande jaoks hädavajalikud.