Шаблон навыка Алисы на JAICF

by just-ai

GitHub Readme.md

Шаблонный проект навыка Алисы на JAICF

Это готовый к использованию шаблон проекта навыка голосового ассистента Яндекс Алиса. Написан с использованием фреймворка JAICF на языке Kotlin.

Как использовать

Вы можете развернуть этот навык в облаке Heroku в один клик, а затем продолжить разработку и отладку на своем ПК.

Развертывание на Heroku

  1. Скопируйте ваш OAuth токен
  1. Нажмите на кнопку ниже
Deploy

Вебхук будет автоматически развернут в облаке Heroku, и вы получите рабочий сервер, который далее сможете обновлять (см ниже).

При установке укажите ваш OAuth токен.

Тестирование

  1. После развертывания вебхука нажмите на кнопку View и скопируйте URL. Это и есть ваш вебхук.
  2. Создайте новый навык для Алисы в Яндекс Диалогах.
  3. Укажите название навыка и URL вебхука, который вы скопировали (остальные поля необязательны).
  4. Перейдите на вкладку Тестирование - навык будет запущен автоматически.

Локальная разработка и обновление сервера

Создание проекта

  1. Установите Heroku CLI.
  2. Выполните следующие команды в терминале
heroku login
heroku git:clone -a <название вашего приложения на Heroku>
cd <название вашего приложения на Heroku>
git remote add origin https://github.com/just-ai/alice-jaicf-template
git pull origin master
  1. Создайте новый проект в IntelliJ IDEA из исходных кодов (Project from Existing Sources), выберите Gradle из списка.

Разработка

Чтобы запустить вебхук локально, запустите Webhook.kt. Сервер запускается на порту 8080.

Чтобы разрабатывать навык, вам нужно получить публичный URL, который затем прописать в настройках вашего навыка в Яндекс Диалогах. Для этого можно установить ngrok, а затем выполнить команду ngrok http 8080 в терминале. Таким образом все запросы от Алисы будут приходить на ваш локальный ПК, и вы сможете отлаживать сценарий навыка.

Изучите документацию JAICF, чтобы понимать, как разрабатывать навык для Алисы

Обновление сервера

Как только вы готовы обновить сервер, выполните следующие команды в терминале:

git add .
git commit -am "описание ваших изменений"
git push

Heroku автоматически соберет и обновит ваш сервер.

Обратная связь

Если у вас возникли вопросы или проблемы, вы можете задать их в Slack сообществе фреймворка JAICF или создать задачу в этом репозитории.