Настройка пользовательской API-интеграции с ИИ-Ассистентом
- просматривать каталог товаров
- оформлять и отслеживать заказы
- записываться на встречи
- получать персонализированные рекомендации
Также можно использовать данные клиентов для персонализации общения, например, приветствовать посетителей по имени или рекомендовать товары на основе предыдущих покупок.
API-интеграции помогают расширить возможности живого чата, улучшить пользовательский опыт, снизить нагрузку на команду поддержки.
Подготовьте схему OpenAPI
Схема OpenAPI содержит модели данных API, конечные точки, параметры запросов, форматы ответов.
Подробнее о формате: Формат OpenAPI 3.0
Пример схемы OpenAPI 3.0
Если API, которое вы хотите подключить, не имеет спецификации OpenAPI, её необходимо создать.
Разместите схему OpenAPI
Затем разместите файл OpenAPI schema на сервере публичным доступом. Вы можете использовать GitHub, Amazon S3 или любой сервис веб-хостинга.
Интеграция с ИИ-Ассистентом
- Войдите в свой аккаунт tawk.to.
- Выберите нужный проект (property).

3. Нажмите Дополнения на левой панели навигации.

4. Нажмите Настройки в разделе ИИ-Ассистент.

5. Выберите нужного ИИ-оператора.

6. Перейдите в раздел Интеграции / API.


8. В поле URL-схема введите URL вашего файла спецификации OpenAPI. Его можно получить из репозитория или хранилища, где размещён файл спецификации. Убедитесь, что URL публично доступен и корректно указывает на файл спецификации.

9. Укажите базовый URL API - это базовый (корневой) адрес API. Его предоставляет поставщик API. Все конечные точки, запросы и ответы, указанные в OpenAPI-спецификации, будут использовать этот URL. Убедитесь, что конечные точки в вашей спецификации совпадают с реальными конечными точками API, чтобы избежать ошибок.
https://petstore.swagger.io/v2

10. Настройте метод аутентификации API.
Выберите No Auth, если API не требует аутентификации. Если выбран API key, введите API Key и Value, предоставленные поставщиком API. Убедитесь, что используете правильный ключ, чтобы избежать ошибок аутентификации.


Как помочь ИИ-Ассистенту понять вашу API-интеграцию
- убедиться, что API schema содержит подробные описания конечных точек и параметров
- обновить Базовый промпт на странице Настроек, чтобы указать ИИ-Ассистенту, когда нужно выполнять API-запрос и какую информацию искать
- Если клиент спрашивает о статусе заказа, выполните [API call], чтобы получить соответствующую информацию.
Важно указывать API call точно так, как он определён в вашей API schema.
Изменение Базового промпта
Важные моменты
- API Base URL можно изменить, но Schema File URL изменить нельзя. Если вы обновите OpenAPI schema и получите новый URL, потребуется удалить интеграцию и добавить её снова с новым Schema File URL.
- Когда ИИ-Ассистент получает информацию через API-запрос, он приоритизирует её над другими источниками данных и использует для формирования ответа клиенту.
- Вы можете настроить ответы ИИ-Ассистента через Базовый промпт, например:
- задать тон общения
- добавить кнопки для взаимодействия с клиентом
- Каждый API-запрос имеет уникальный ID и считается отдельной точкой данных.
- Последующие API-запросы не связаны с предыдущими. Поэтому ИИ-Ассистент не использует результаты предыдущих API-запросов при выполнении новых.
- В длинных разговорах часть сообщений может обрезаться, поэтому ИИ-Ассистент может не учитывать информацию, указанную в начале диалога.
Рекомендации по настройке
- Тщательно протестируйте интеграцию на точность, задержку ответа и безопасность.
- Следуйте лучшим практикам аутентификации API и шифрования данных.
- Оптимизируйте интеграцию для быстрой и удобной работы чата.
- Создавайте ориентированный на клиента опыт, который повышает лояльность и увеличивает продажи.
- Убедитесь, что интеграция способна обрабатывать растущую нагрузку, по мере роста вашего бизнеса.
Примеры интеграций
- Нажмите на зелёный значок онлайн-чата
- Запланируйте звонок
- Посетите наше сообщество
