Інтегруйте свій чатбот зі сторонніми API
Використовуючи наш редактор дій штучного інтелекту, ви можете створити будь-яку власну інтеграцію з будь-якою бекенд-системою, яка здатна надавати дані через кінцеві точки API. Наприклад, ви можете налаштувати чатбот так, щоб він перевіряв наявність товару на складі, перевіряв статус замовлення у вашій ERP-системі або перевіряв поточний баланс на рахунку клієнта.
Ви також можете виконувати дії для оновлення зовнішніх систем - наприклад, викликати ендпоінти, які призначають зустрічі, або надсилати Webhook.
Передумови
ℹ️ Перш ніж розпочати, переконайтеся, що у вас є підписка ChatLab, яка дозволяє інтеграцію з Custom API. Перегляньте сторінку з цінами
Додавання Custom API до вашого чатбота
Інтеграція власного API дозволяє вашому чатботу взаємодіяти із зовнішніми сервісами - наприклад, із вашим власним інтернет-магазином, отримувати дані або виконувати дії від імені користувача.
Ця інструкція проведе вас через кроки, необхідні для налаштування власного API на платформі ChatLab.
Ваше API
Вам необхідно мати загальнодоступні кінцеві точки API, які може викликати чатбот - це означає, що вам потрібно відкрити доступ до даних із вашої платформи електронної комерції або власної системи через ендпоінти API, щоб наш чатбот міг звертатися до них, витягувати ці дані та надавати їх користувачам.
Виклик API чатботом
API викликатиметься чатботом динамічно під час взаємодії з користувачем, залежно від необхідності отримати зовнішні дані або виконати конкретні дії. Важливо звернути увагу на таке:
-
Виклик не гарантується: API викликатиметься лише тоді, коли логіка чатбота визначить це необхідним. Немає гарантій щодо того, коли саме або як часто викликатиметься API.
-
Вимоги до моделі AI: Для досягнення оптимальної продуктивності рекомендується використовувати моделі штучного інтелекту вищого рівня, які підтримують складні виклики функцій, такі як GPT-4o або новіші. Ці моделі краще визначають відповідні моменти для виклику API на основі контексту розмови та наміру користувача.
-
Виклики з урахуванням контексту: Чатбот намагатиметься викликати API щоразу, коли виявить у розмові контекст, що відповідає призначенню API, але фактичний виклик залежатиме від кількох факторів, таких як:
- Доступність і швидкість відповіді зовнішнього API.
- Поточний стан розмови та запити користувача.
- Внутрішній рівень впевненості та алгоритми оцінки моделі AI під час прийняття рішення про необхідність виклику.
Кроки для налаштування Custom API
Крок 1: Перейдіть до налаштувань Custom API
-
Увійдіть у свою панель керування ChatLab.
-
На бічній панелі ліворуч у розділі Settings (Налаштування) натисніть Custom API.
Крок 2: Визначте нове API
-
Натисніть кнопку + Define API (+ Визначити API).
-
Введіть назву вашого API у полі API Name (Назва API).
-
Вкажіть базову URL-адресу зовнішнього сервісу, до якого ви хочете підключитися, у полі URL.
-
Натисніть Save (Зберегти), щоб створити API.
Крок 3: Додайте операції API
-
У щойно створеному записі API натисніть кнопку View (Переглянути).
-
Натисніть + Define API Operation (+ Визначити операцію API), щоб налаштувати окремі операції (кінцеві точки) для API.
-
Заповніть необхідні дані:
- Operation Name: описова назва операції.
- Operation URI: шлях кінцевої точки для операції (наприклад,
/v1/resource).
Крок 4: Налаштуйте URI кінцевої точки та параметри
- Конфігурація URI кінцевої точки:
- Додайте будь-які змінні шляху, необхідні для операції, натиснувши + Add path variable (+ Додати змінну шляху).
- Введіть параметри змінної та за потреби позначте їх як обов'язкові.
- Виберіть джерело значення:
- Надається користувачем чатботу - якщо для заповнення цього поля потрібне значення від користувача.
- Константа - якщо це постійне значення, яке вам потрібно буде вказати під час визначення операції API.
- додайте щойно додану змінну шляху до визначення шляху між двома символами «@»: @myvariable@:
- Параметри запиту (Query Parameters):
- Додайте будь-які параметри запиту, натиснувши + Add query parameter (+ Додати параметр запиту).
- Вкажіть назву параметра, тип даних і джерело (наприклад, надається користувачем або чатботом).
Крок 5: Встановіть метод запиту та тіло запиту
-
Виберіть метод HTTP для операції (наприклад, GET, POST).
-
Якщо методом запиту є POST, налаштуйте тіло запиту:
- Виберіть тип вмісту (наприклад,
application/json). - Додайте параметри тіла запиту, вказавши назву, тип даних і джерело.
- Додайте змінні до визначення тіла запиту - зазвичай це структура JSON, де ви можете розмістити визначені вами змінні
Крок 6: Налаштуйте заголовки операції
Додайте заголовки - наприклад, Authorization або інші, необхідні для вашого API. Перегляньте знімок екрана нижче, щоб дізнатися, як налаштувати постійний токен у заголовку Authorization:
Крок 7: Збережіть операцію
-
Перевірте конфігурацію, щоб переконатися у правильності всіх даних.
-
Натисніть Save changes (Зберегти зміни), щоб зберегти операцію API.
Крок 8: Протестуйте інтеграцію API
-
Скористайтеся функцією Test API (Тестувати API), щоб надіслати тестовий запит і переконатися, що інтеграція працює належним чином.
-
Слідкуйте за журналами на наявність помилок чи неполадок і за потреби відкоригуйте конфігурацію.
Крок 9: Прив'яжіть операції API до чатбота
Коли API Operations (Операції API) визначено, настав час призначити їх чатботу. Виберіть чатбот на головній панелі керування чатботами, натисніть Integrations (Інтеграції) та виберіть AI API Actions (Дії AI API) у меню ліворуч
Натисніть Attach (Прив'язати) біля вибраної операції API
Крок 10: Додайте інструкції щодо ролі для чатбота
Виберіть свій чатбот на головній панелі керування чатботами, натисніть Settings (Налаштування), у лівому меню виберіть Role (Роль)
Натисніть Provide custom role instructions. (Надати власні інструкції щодо ролі.)
Додайте інструкції щодо використання щойно доданої операції API. Наприклад, ви можете додати правило:
“- When user asks for store inventory always call getItems function and render the result of the function with following rules…..”
Поради для успішної інтеграції
-
Переконайтеся, що базова URL-адреса та кінцеві точки правильні та доступні.
-
Перевірте правильність налаштування всіх вимог автентифікації (таких як ключі API або токени).
-
Ретельно тестуйте кожну операцію, щоб переконатися, що вона повертає очікувані відповіді.
Дотримуючись цих кроків, ви зможете безперешкодно інтегрувати власні API у ваш чатбот ChatLab, розширюючи його функціональність і забезпечуючи кращу взаємодію з користувачами.
Захист інтеграції вашого Custom API
Щоб забезпечити безпеку власного API та захистити його від несанкціонованого доступу, враховуйте такі перевірені практики:
Використовуйте постійні токени
Постійні токени API: Налаштуйте постійний токен (або ключ) API, який вимагатиметься для всіх запитів до API. Цей токен має бути унікальним і згенерованим безпечним способом.
-
Як впровадити: Включайте токен у заголовок запиту або як параметр запиту під час кожного виклику API.
-
Де зберігати: Надійно зберігайте токен у налаштуваннях ChatLab як константний параметр операції
Використовуйте кінцеву точку входу для тимчасових токенів
Додайте до API додаткову операцію API, яка повертає тимчасовий токен безпеки - тобто ендпоінт входу у вашу систему.
Під час визначення цієї операції API вам потрібно буде надати облікові дані для входу, що відповідають вашій системі, як постійні параметри операції API. Щоб чатбот міг використовувати отриманий таким чином токен, вам потрібно додати токен безпеки у визначення інших операцій API та додати відповідні інструкції у промпт як для операції входу, так і для інших операцій API (наприклад, «Always use the security token obtained from the Login operation as the security_token parameter for operation getOrder»).
Контроль конфіденційної інформації через ChatLab
Щоб запобігти відображенню конфіденційної інформації чатботом, користувачі ChatLab можуть вжити таких заходів:
Використовуйте інженерію промптів для керування поведінкою AI
-
Встановлюйте чіткі інструкції в промптах: Під час налаштування чатбота вказуйте точні інструкції в параметрах промпту, щоб уникнути відображення будь-якої конфіденційної інформації. Наприклад:
- Приклад промпту: «Do not display any personal, financial, or confidential information returned by an API call.»
- Використання системних повідомлень: Додайте системне повідомлення на початку процесу розмови, щоб підкреслити важливість конфіденційності даних (наприклад, «Ensure all outputs exclude any sensitive information.»).
-
Регулярно оновлюйте промпти: Коригуйте промпти на основі відгуків користувачів або змін у вимогах до конфіденційності даних. Це допоможе гарантувати, що штучний інтелект постійно дотримується найновіших рекомендацій щодо роботи з конфіденційною інформацією.
Проєктуйте кінцеві точки API з вбудованою логікою перевірки
-
Вимагайте перевірку користувача для доступу до конфіденційних даних: Проєктуйте кінцеві точки вашого API так, щоб вони включали перевірку перед поверненням конфіденційних даних. Наприклад:
- Параметри перевірки: Вимагайте від користувачів надання певної інформації (такої як адреса електронної пошти, номер замовлення або відповідь на контрольне запитання) до того, як API поверне дані, пов'язані з цим користувачем.
- Багатофакторна перевірка: Впроваджуйте додаткові параметри (наприклад, дату замовлення, адресу доставки або секретний код), щоб підтвердити особу користувача та переконатися, що він має право на доступ до даних.
-
Налаштуйте безпечні резервні відповіді: Налаштуйте логіку вашого API на повернення типових повідомлень або помилок, якщо необхідна перевірка не була пройдена або дані не збігаються:
- Приклад: «Unable to retrieve order details. Please verify your email and order number.»
Використовуйте обмежений обсяг даних у відповідях API
- Мінімізуйте розкриття даних: Налаштуйте відповіді API так, щоб вони містили лише дані, необхідні для роботи чатбота, зменшуючи ризик випадкового відображення конфіденційної інформації.
- Приклад: Замість повернення повних профілів користувачів повертайте лише окремі поля, такі як статус замовлення або підтвердження оплати, які потрібні для виконання завдання чатбота.