Интеграции с персонализирани API

Интегрирайте Вашия чатбот с персонализирани API-та

Чрез нашия редактор за AI действия можете да изградите всякаква персонализирана интеграция с всяка бекенд система, която може да предостави данни чрез API крайни точки. Например можете да настроите чатбота да проверява наличността на продукт във Вашия склад, да проверява статуса на поръчка във Вашата ERP система или да проверява текущия баланс по сметката на клиента.

Можете също така да изпълнявате действия за актуализиране на външни системи - например да извиквате крайни точки за насрочване на срещи или Webhooks.

Предварителни изисквания

ℹ️ Преди да започнете - уверете се, че имате абонамент за ChatLab, който позволява интеграции с Custom API. Проверете страницата с цени

Добавяне на Custom API към Вашия чатбот

Интегрирането на персонализирано API позволява на Вашия чатбот да комуникира с външни услуги - например Вашия персонализиран магазин, извличайки данни или извършвайки действия от името на потребителя.

Това ръководство ще Ви преведе през стъпките, необходими за настройване на персонализирано API с помощта на платформата ChatLab.

Вашето API

Необходимо е да разполагате с публично достъпни API крайни точки, които могат да бъдат извиквани от чатбота - това означава, че трябва да предоставите данни от Вашата платформа за електронна търговия или Вашата персонализирана система чрез API крайни точки, за да може нашият чатбот да ги извиква с цел извличане на тези данни и предоставянето им на Вашите потребители.

Извикване на API от чатбота

API ще бъде извиквано динамично от чатбота по време на взаимодействията с потребителите въз основа на нуждата му от достъп до външни данни или извършване на конкретни действия. Важно е да се отбележи следното:

• Няма гарантирано извикване: API ще бъде извиквано само когато логиката на чатбота прецени, че това е необходимо. Няма гаранции кога или колко често ще бъде извиквано API.

• Изисквания към AI модела: За оптимална работа се препоръчва използването на AI модели от по-висок клас, които поддържат сложни извиквания на функции (function calling), като например GPT-4o или по-нова версия. Тези модели са по-умели в определянето на подходящите моменти за извикване на API въз основа на контекста на разговора и намерението на потребителя.

• Извиквания, съобразени с контекста: Чатботът ще се опита да извика API винаги когато разпознае контекст в разговора, който съответства на предназначението на API, но действителното извикване ще зависи от множество фактори, като например:

  • Наличност и скорост на отговор на външното API.
  • Текущото състояние на разговора и потребителските запитвания.
  • Нива на вътрешна увереност и алгоритми за оценка на AI модела при вземането на решение за необходимостта от извикването.

Стъпки за настройване на Custom API

Стъпка 1: Отидете до настройките на Custom API

1. Влезте в контролния панел на ChatLab.

2. В страничната лента отляво, под секцията Settings (Настройки), кликнете върху Custom API (Персонализирано API).

Стъпка 2: Дефинирайте ново API

1. Кликнете върху бутона + Define API (+ Дефиниране на API).

2. Въведете име за Вашето API в полето API Name (Име на API).

3. Посочете базовия URL на външната услуга, към която искате да се свържете, в полето URL.

4. Кликнете върху Save (Запазване), за да създадете API.

Стъпка 3: Добавете API операции

1. В новосъздадения запис на API кликнете върху бутона View (Преглед).

2. Кликнете върху + Define API Operation (+ Дефиниране на API операция), за да настроите отделни операции (крайни точки) за това API.

3. Попълнете задължителните данни:

• Operation Name: Описателно име за операцията.
• Operation URI: Пътят на крайната точка за операцията (напр. /v1/resource).

Стъпка 4: Конфигурирайте URI на крайната точка и параметрите

1. Конфигурация на URI на крайната точка:

• Добавете необходимите променливи на пътя за операцията, като кликнете върху + Add path variable (+ Добавяне на променлива за път).
• Въведете данните за променливата и ги маркирайте като задължителни, ако е необходимо.

• Изберете източника на стойността:
  • Предоставена от потребителя на чатбота - в случай че се изисква определена стойност от потребителя, за да бъде попълнена.
  • Константа - в случай че това е константна стойност, която трябва да предоставите при дефинирането на операцията на API.
• Добавете новосъздадената променлива на пътя в дефиницията на пътя между два знака „@“: @myvariable@:

1. Параметри на заявката (Query Parameters):

• Добавете параметри на заявката, като кликнете върху + Add query parameter (+ Добавяне на параметър за заявка).
• Дефинирайте името на параметъра, типа данни и източника (напр. предоставен от потребителя или от чатбота).

Стъпка 5: Задайте HTTP метод и тяло на заявката

1. Изберете HTTP метода за операцията (напр. GET, POST).

2. Ако методът на заявката е POST, конфигурирайте тялото на заявката:

• Изберете типа съдържание (напр. application/json).
• Добавете параметрите на тялото, като посочите име, тип данни и източник.

• Добавете променливите в дефиницията на тялото - обикновено това е json формат, където можете да поставите променливите, които сте дефинирали.

Стъпка 6: Задайте хедъри на операцията

Добавете хедъри - т.е. Authorization или други, необходими за Вашето API. Моля, разгледайте екранната снимка по-долу за настройване на постоянен токен в хедъра Authorization:

Стъпка 7: Запазете операцията

1. Прегледайте конфигурацията, за да се уверите, че всички данни са правилни.

2. Кликнете върху Save changes (Запазване на промените), за да запазите операцията на API.

Стъпка 8: Тествайте интеграцията на API

1. Използвайте функцията Test API (Тестване на API), за да изпратите тестова заявка и да се уверите, че интеграцията работи правилно.

2. Следете логовете за грешки или проблеми и коригирайте конфигурацията при необходимост.

Стъпка 9: Прикачете API операциите към чатбота

След като дефинирате операциите на API, е време да ги присвоите към чатбота. Изберете чатбота в основния панел с чатботове, кликнете върху Integrations (Интеграции) и изберете AI API Actions в менюто отляво

Кликнете върху Attach (Прикачване) на избраната операция на API

Стъпка 10: Добавете ролеви инструкции за чатбота

Изберете Вашия чатбот в основния панел с чатботове, кликнете върху Settings (Настройки), а в лявото меню изберете Role (Роля)

Кликнете върху Provide custom role instructions (Предоставяне на персонализирани ролеви инструкции).

Добавете инструкции относно използването на новодобавената API операция - например можете да добавите правило:

“- Когато потребителят попита за складовата наличност на магазина, винаги извиквай функцията getItems и визуализирай резултата от функцията съгласно следните правила…..”

Съвети за успешна интеграция

• Уверете се, че базовият URL и крайните точки са правилни и достъпни.

• Проверете дали всички изисквания за автентикация (като API ключове или токени) са конфигурирани правилно.

• Тествайте обстойно всяка операция, за да се уверите, че връща очакваните отговори.

Следвайки тези стъпки, можете безпроблемно да интегрирате персонализирани API-та във Вашия чатбот в ChatLab, разширявайки функционалността му и осигурявайки по-богато потребителско изживяване.

Защита на Вашата Custom API интеграция

За да гарантирате, че Вашето персонализирано API е защитено от неоторизиран достъп, вземете предвид следните добри практики:

Използвайте постоянни токени

Постоянни API токени: Задайте постоянен API токен (или ключ), който се изисква за всички заявки към API. Този токен трябва да бъде уникален и генериран по сигурен начин.

• Как се внедрява: Включете токена в хедъра на заявката или като параметър на заявката при всяко извикване на API.

• Къде се съхранява: Съхранявайте токена на сигурно място в настройките на ChatLab като константен параметър на операцията.

Използвайте крайна точка за вход за временни токени

Добавете допълнителна API операция към API-то, която връща временен токен за сигурност - т.е. крайна точка за вход (login) във Вашата система.

Ще трябва да предоставите данните си за вход, съответстващи на Вашата система, като константни параметри на операцията на API при дефинирането ѝ. За да може чатботът да използва токена, получен по този начин, е необходимо да добавите токена за сигурност в дефинициите на другите API операции и да въведете подходящи инструкции в промпта както за операцията за вход, така и за останалите операции (например „Always use the security token obtained from the Login operation as the security_token parameter for operation getOrder“).

Контрол на поверителната информация чрез ChatLab

За да предотвратят показването на поверителна информация от чатбота, потребителите на ChatLab могат да предприемат следните действия:

Използвайте промпт инженеринг за насочване на поведението на AI

• Задайте ясни инструкции в промптовете: При конфигурирането на чатбота предоставете точни инструкции в настройките на промпта, за да избегнете показването на каквато и да е чувствителна информация. Например:

  • Примерен промпт: „Не показвай никаква лична, финансова или конфиденциална информация, върната от API извикване.“
  • Използване на системни съобщения: Включете системно съобщение в началото на разговора, за да подчертаете значението на поверителността на данните (напр. „Увери се, че всички генерирани отговори изключват всякаква чувствителна информация.“).

• Редовно актуализирайте промптовете: Регулирайте промптовете въз основа на обратната връзка от потребителите или промените в изискванията за защита на данните. Това помага да се гарантира, че AI системно следва най-новите насоки за работа с чувствителна информация.

Проектирайте API крайни точки с вградена логика за верификация

• Изисквайте потребителска верификация за достъп до чувствителни данни: Проектирайте Вашите API крайни точки така, че да включват проверки за верификация, преди да върнат поверителни данни. Например:

  • Параметри за верификация: Изисквайте от потребителите да предоставят определена информация (като имейл адрес, номер на поръчка или конкретен въпрос за сигурност), преди API да върне данни, свързани с този потребител.
  • Многофакторна верификация: Внедрете допълнителни параметри (напр. дата на поръчка, адрес за доставка или таен код), за да потвърдите самоличността на потребителя и да се уверите, че той има право на достъп до данните.

• Внедрете резервни отговори при грешка: Настройте логиката на Вашето API да връща общи съобщения или грешки, ако необходимата верификация не е предоставена или не съвпада:

  • Пример: „Данните за поръчката не могат да бъдат извлечени. Моля, потвърдете Вашия имейл и номер на поръчка.“

Използвайте ограничен обхват от данни в API отговорите

• Минимизирайте разкриването на данни: Конфигурирайте API отговорите така, че да включват само данните, необходими за функционирането на чатбота, намалявайки риска от неволно показване на чувствителна информация.
  • Пример: Вместо да връщате пълни потребителски профили, връщайте само конкретни полета като статус на поръчката или потвърждение на плащането, които са необходими за изпълнението на задачата на чатбота.