Egyedi API-integrációk

Integrálja chatbotját egyéni API-kkal

Az AI-műveletek szerkesztőnk segítségével bármilyen egyéni integrációt felépíthet bármely olyan háttérrendszerrel, amely képes adatokat közzétenni API-végpontokon keresztül. Beállíthatja például, hogy a chatbot ellenőrizze egy termék elérhetőségét a raktárában, lekérdezze a rendelés állapotát az ERP-rendszerében, vagy ellenőrizze az ügyfélszámla aktuális egyenlegét.

Külső rendszerek frissítésére szolgáló műveleteket is végrehajthat - például meghívhat időpontfoglalást kezelő végpontokat vagy webhookokat.

Előfeltételek

ℹ️ Mielőtt elkezdené - győződjön meg arról, hogy olyan ChatLab-előfizetéssel rendelkezik, amely engedélyezi a Custom API integrációkat. Tekintse meg az árazási oldalt

Egyéni API hozzáadása a chatbotjához

Egy egyéni API integrálása lehetővé teszi a chatbot számára, hogy külső szolgáltatásokkal kommunikáljon - például az Ön egyedi webáruházával -, adatokat kérjen le, vagy műveleteket hajtson végre a felhasználó nevében.

Ez az útmutató végigvezeti Önt az egyéni API beállításához szükséges lépéseken a ChatLab platform használatával.

Az Ön API-ja

Nyilvánosan elérhető API-végpontokkal kell rendelkeznie, amelyeket a chatbot meg tud hívni - ez azt jelenti, hogy az adatokat az e-kereskedelmi platformjából vagy egyedi rendszeréből API-végpontokon keresztül kell közzétennie, hogy a chatbotunk meg tudja hívni ezeket a végpontokat az adatok lekéréséhez és a felhasználóknak történő átadásához.

API-hívás a chatbot által

Az API-t a chatbot dinamikusan fogja meghívni a felhasználói interakciók során, annak alapján, hogy a chatbotnak szüksége van-e külső adatok elérésére vagy konkrét műveletek végrehajtására. Fontos megjegyezni a következőket:

• Nincs garantált hívás: Az API csak akkor kerül meghívásra, amikor a chatbot logikája úgy ítéli meg, hogy szükséges. Nincs garancia arra, hogy az API mikor vagy milyen gyakran fog meghívódni.

• AI-modellkövetelmények: Az optimális teljesítmény érdekében magasabb szintű, összetett függvényhívást (function calling) támogató AI-modellek használata javasolt, mint például a GPT-4o vagy újabb. Ezek a modellek jobban fel tudják mérni az API meghívásának megfelelő pillanatait a beszélgetés kontextusa és a felhasználó szándéka alapján.

• Kontextusfüggő hívások: A chatbot megpróbálja meghívni az API-t, amikor olyan kontextust észlel a beszélgetésben, amely illeszkedik az API céljához, de a tényleges hívás több tényezőtől függ, például:

  • A külső API elérhetősége és válaszideje.
  • A beszélgetés aktuális állapota és a felhasználói kérések.
  • Az AI-modell belső megbízhatósági szintjei és pontozási algoritmusai a hívás szükségességének eldöntésekor.

A Custom API beállításának lépései

1. lépés: Navigáljon a Custom API beállításaihoz

1. Jelentkezzen be a ChatLab vezérlőpultjára.

2. A bal oldali sávban, a Settings (Beállítások) menüpont alatt kattintson a Custom API lehetőségre.

2. lépés: Új API meghatározása

1. Kattintson a + Define API (+ API meghatározása) gombra.

2. Adja meg az API nevét az API Name (API neve) mezőben.

3. Adja meg a csatlakoztatni kívánt külső szolgáltatás alapértelmezett URL-címét az URL mezőben.

4. Kattintson a Save (Mentés) gombra az API létrehozásához.

3. lépés: API-műveletek hozzáadása

1. Az újonnan létrehozott API elemnél kattintson a View (Megtekintés) gombra.

2. Kattintson a + Define API Operation (+ API-művelet meghatározása) gombra az egyes műveletek (végpontok) beállításához az API-hoz.

3. Töltse ki a szükséges adatokat:

• Operation Name: A művelet leíró neve.
• Operation URI: A művelet végpontjának elérési útja (pl. /v1/resource).

4. lépés: A végpont URI és a paraméterek konfigurálása

1. Végpont URI konfigurációja:

• Adja meg a művelethez szükséges útvonalváltozókat (path variables) a + Add path variable (+ Útvonalváltozó hozzáadása) gombra kattintva.
• Adja meg a változó adatait, és szükség esetén jelölje meg kötelezőként.

• Válassza ki az érték forrását:
  • Provided by user to chatbot - amennyiben a felhasználótól származó érték szükséges a kitöltéséhez.
  • Constant - amennyiben ez egy állandó érték, amelyet az API-művelet meghatározásakor kell megadnia.
• Adja hozzá az újonnan létrehozott útvonalváltozót az útvonaldefinícióhoz két „@” jel közé írva: @myvariable@:

1. Lekérdezési paraméterek (Query Parameters):

• Adja hozzá a lekérdezési paramétereket a + Add query parameter (+ Lekérdezési paraméter hozzáadása) gombra kattintva.
• Határozza meg a paraméter nevét, adattípusát és forrását (pl. a felhasználó vagy a chatbot által megadott).

5. lépés: A kérés metódusának és törzsének beállítása

1. Válassza ki a HTTP-metódust a művelethez (pl. GET, POST).

2. Ha a kérés metódusa POST, konfigurálja a kérés törzsét (request body):

• Válassza ki a tartalomtípust (pl. application/json).
• Adja meg a törzsparamétereket a név, az adattípus és a forrás megadásával.

• Adja hozzá a változókat a törzs definíciójához - ez általában egy JSON, ahol elhelyezheti a megadott változókat

6. lépés: A művelet fejléceinek beállítása

Adjon hozzá fejléceket - például Authorization vagy más, az API által megkövetelt fejlécet. Kérjük, tekintse meg az alábbi képernyőképet az állandó token Authorization fejlécben történő beállításához:

7. lépés: A művelet mentése

1. Ellenőrizze a konfigurációt, hogy minden adat helyes-e.

2. Kattintson a Save changes (Módosítások mentése) gombra az API-művelet mentéséhez.

8. lépés: Az API-integráció tesztelése

1. Használja a Test API (API tesztelése) funkciót egy tesztkérés küldéséhez, és ellenőrizze, hogy az integráció megfelelően működik-e.

2. Figyelje a naplókat az esetleges hibák vagy problémák felderítéséhez, és szükség szerint módosítsa a konfigurációt.

9. lépés: Az API-műveletek hozzárendelése a信号-höz

Miután meghatározta az API Operations elemeket, ideje hozzárendelni őket a信号-höz. Válassza ki a chatbotot a fő chatbot-irányítópulton, kattintson az Integrations (Integrációk) lehetőségre, majd válassza az AI API Actions menüpontot a bal oldali menüben

Kattintson az Attach (Csatolás) gombra a kiválasztott API-műveletnél

10. lépés: Szerepkör-utasítások hozzáadása a信号-höz

Válassza ki a chatbotját a fő chatbot-irányítópulton, kattintson a Settings (Beállítások) gombra, majd a bal oldali menüben válassza a Role (Szerepkör) lehetőséget

Kattintson a Provide custom role instructions (Egyéni szerepkör-utasítások megadása) lehetőségre.

Adjon meg utasításokat az újonnan hozzáadott API-művelet használatára vonatkozóan, például megadhat egy ilyen szabályt:

„- Amikor a felhasználó a bolt raktárkészletéről kérdez, mindig hívd meg a getItems függvényt, és jelenítsd meg a függvény eredményét a következő szabályok szerint…..”

Tippek a sikeres integrációhoz

• Győződjön meg arról, hogy az alapértelmezett URL és a végpontok helyesek és elérhetők.

• Ellenőrizze, hogy az összes hitelesítési követelmény (például API-kulcsok vagy tokenek) megfelelően van-e konfigurálva.

• Teszteljen minden műveletet alaposan, hogy biztosan a várt válaszokat adja vissza.

Ezeket a lépéseket követve zökkenőmentesen integrálhat egyéni API-kat a ChatLab chatbotjába, bővítve annak funkcionalitását és gazdagabb felhasználói élményt nyújtva.

Az egyéni API-integráció biztonságossá tétele

Annak érdekében, hogy az egyéni API biztonságos legyen és védve maradjon az illetéktelen hozzáféréstől, vegye figyelembe a következő bevált gyakorlatokat:

Állandó tokenek használata

Állandó API-tokenek: Állítson be egy állandó API-tokent (vagy kulcsot), amely kötelező az API-hoz intézett minden kéréshez. Ennek a tokennek egyedinek kell lennie, és biztonságos módon kell generálni.

• Megvalósítás módja: Adja hozzá a tokent a kérés fejlécéhez vagy lekérdezési paraméterként minden API-hívásban.

• Hol tárolandó: Tárolja a tokent biztonságosan a ChatLab beállításaiban a művelet állandó paramétereként

Bejelentkezési végpont használata ideiglenes tokenekhez

Adjon hozzá egy további API-műveletet az API-hoz, amely ideiglenes biztonsági tokent ad vissza - vagyis egy bejelentkezési végpontot az Ön rendszeréhez.

A művelet meghatározásakor állandó API-műveleti paraméterként meg kell adnia a rendszeréhez tartozó bejelentkezési adatokat. Ahhoz, hogy a chatbot használni tudja az így kapott tokent, hozzá kell adnia a biztonsági tokent a többi API-művelet definíciójához, valamint megfelelő prompt-utasításokat kell adnia a bejelentkezési művelethez és a többi API-művelethez is (Például: „Mindig használd a Login műveletből kapott biztonsági tokent a getOrder művelet security_token paramétereként”).

Bizalmas információk felügyelete a ChatLab segítségével

A bizalmas információk chatbot általi megjelenítésének megelőzése érdekében a ChatLab felhasználói a következő lépéseket tehetik:

Prompt engineering alkalmazása az AI viselkedésének irányítására

• Világos utasítások beállítása a promptokban: A chatbot konfigurálásakor adjon meg kifejezett utasításokat a prompt beállításaiban, hogy elkerülje a bizalmas információk megjelenítését. Például:

  • Példa promptra: „Ne jeleníts meg semmilyen személyes, pénzügyi vagy bizalmas információt, amelyet egy API-hívás visszaküldött.”
  • Rendszerüzenetek használata: Illesszen be egy rendszerüzenetet a beszélgetési folyamat elejére az adatvédelem fontosságának megerősítésére (pl. „Gondoskodj arról, hogy minden válasz kizárja a bizalmas információkat.”).

• A promptok rendszeres frissítése: Módosítsa a promptokat a felhasználói visszajelzések vagy az adatbiztonsági követelmények változásai alapján. Ez segít biztosítani, hogy az AI következetesen kövesse a legfrissebb irányelveket a bizalmas információk kezelésével kapcsolatban.

API-végpontok kialakítása beépített ellenőrzési logikával

• Felhasználói ellenőrzés megkövetelése a bizalmas adatok eléréséhez: Úgy alakítsa ki az API-végpontokat, hogy ellenőrzéseket végezzenek a bizalmas adatok visszaadása előtt. Például:

  • Ellenőrzési paraméterek: Kötelezze a felhasználókat bizonyos adatok (például e-mail-cím, rendelési szám vagy egy konkrét biztonsági kérdés) megadására, mielőtt az API visszaadná az adott felhasználóhoz kapcsolódó adatokat.
  • Többtényezős ellenőrzés: Alkalmazzon további paramétereket (pl. rendelés dátuma, szállítási cím vagy egy titkos kód) a felhasználó személyazonosságának ellenőrzésére, és annak biztosítására, hogy jogosult-e az adatok elérésére.

• Hibabiztos válaszok bevezetése: Állítsa be az API logikáját úgy, hogy általános üzeneteket vagy hibákat adjon vissza, ha a szükséges ellenőrzés nem történik meg vagy nem egyezik:

  • Példa: „Nem sikerült lekérni a rendelés adatait. Kérjük, ellenőrizze e-mail-címét és rendelési számát.”

Korlátozott adatkörök használata az API-válaszokban

• Az adatok kitettségének minimalizálása: Konfigurálja úgy az API-válaszokat, hogy csak a chatbot funkciójához szükséges adatokat tartalmazzák, csökkentve a bizalmas információk véletlen megjelenítésének kockázatát.
  • Példa: A teljes felhasználói profilok visszaadása helyett csak konkrét mezőket adjon vissza, például a rendelés állapotát vagy a fizetési visszaigazolást, amelyek a chatbot feladatához szükségesek.