Настройка пользовательской API-интеграции с ИИ-Ассистентом

Инструкции ниже предназначены только для ПК и ноутбуков.
ИИ-Ассистент в tawk.to позволяет подключить чат к вашим внутренним системам и базам данных. Это даёт клиентам быстрый доступ к информации о товарах и заказах в режиме реального времени.
Например, пользователи смогут:
  • просматривать каталог товаров
  • оформлять и отслеживать заказы
  • записываться на встречи
  • получать персонализированные рекомендации

Также можно использовать данные клиентов для персонализации общения, например, приветствовать посетителей по имени или рекомендовать товары на основе предыдущих покупок.

API-интеграции помогают расширить возможности живого чата, улучшить пользовательский опыт, снизить нагрузку на команду поддержки.

Если вы используете несколько ИИ-операторов, они будут использовать одни и те же API-интеграции, обеспечивая точную и согласованную информацию во всех каналах.
В этом руководстве описаны основные шаги интеграции ИИ-Ассистент с внешними API через OpenAPI.

Подготовьте схему OpenAPI

Сначала вам понадобится OpenAPI schema - файл JSON (.json) или YAML (.yaml), который описывает взаимодействие между API и ИИ-Ассистентом.

Схема OpenAPI содержит модели данных API, конечные точки, параметры запросов, форматы ответов.

Убедитесь, что схема соответствует формату OpenAPI 3.0.

Подробнее о формате: Формат OpenAPI 3.0

Также можно ознакомиться с примером схемы:
Пример схемы OpenAPI 3.0

Если API, которое вы хотите подключить, не имеет спецификации OpenAPI, её необходимо создать. 

Для этого можно использовать инструменты Postman или Swagger EditorПосле создания спецификации рекомендуется проверить её с помощью Swagger validator или любого онлайн-валидатора OpenAPI.

Разместите схему OpenAPI

Затем разместите файл OpenAPI schema на сервере публичным доступом. Вы можете использовать GitHub, Amazon S3 или любой сервис веб-хостинга.

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

Интеграция с ИИ-Ассистентом

  1. Войдите в свой аккаунт tawk.to.
  2. Выберите нужный проект (property).

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

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

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

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

7. Нажмите Добавить инструмент в разделе API.

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

Примечание: если вы обновите файл OpenAPI schema и получите новый URL, необходимо удалить интеграцию и добавить её снова с новым Schema File URL.

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

10. Настройте метод аутентификации API.

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

Если выбран Базовый, введите имя пользователя и пароль.
11. Проверьте введённые данные и нажмите Сохранить.

Как помочь ИИ-Ассистенту понять вашу API-интеграцию

ИИ-Ассистент использует источники данных, включая 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 и шифрования данных.
    • Оптимизируйте интеграцию для быстрой и удобной работы чата.
    • Создавайте ориентированный на клиента опыт, который повышает лояльность и увеличивает продажи.
    • Убедитесь, что интеграция способна обрабатывать растущую нагрузку, по мере роста вашего бизнеса.

    Примеры интеграций

    Если вы хотите оставить отзыв об этой статье или вам нужна дополнительная помощь:

     
     
     
     
     
     

    Эта статья была вам полезна?

    13 из 20 понравилась эта статья