SmartApp Framework — это фреймворк, который позволяет создавать смартапы с поддержкой виртуальных ассистентов Салют.
Project description
SmartApp Framework
SmartApp Framework - это Python-фреймворк, который позволяет создавать смартапы для виртуальных ассистентов Салют.
Оглавление
Конфигурация
Фреймворк и смартапы
Смартап - это приложение для виртуального ассистента Салют. С помощью смартапов пользователи могут вызвать такси, узнать погоду, управлять устройствами умного дома, записаться в салон красоты и совершить прочие действия, которые можно доверить ассистенту.
Виртуальный ассистент понимает текущие намерения пользователя и для каждой его реплики подбирает соответствующий запрос на выполнение ([интент](#TODO: вставить ссылку)). Поведение смартапа для различных интентов описывается с помощью сценариев. Интенты и сценарии связываются через смартапы, написанные на SmartApp Framework.
Инструменты фреймворка
Фреймворк содержит следующие инструменты:
- инструменты для создания сценариев;
- решения для автоматического тестирования;
- демо-приложение для просмотра примеров реализации;
- готовые механизмы для слот-филлинга и извлечения сущностей из текста.
Рекомендованные требования
- Linux, Mac OS или Windows (необходима установка Conda).
- 512 МБ свободной памяти.
- Python 3.6.8 - 3.9.6.
Настройка фреймворка
Обновление фреймворка
Для перехода на новую версию фреймворка выполните в терминале следующие команды:
python3 -m pip uninstall -y smart-app-framework
python3 -m pip install git+https://github.com/salute-developers/smart_app_framework@main
При переходе на версию фреймворка >=1.0.7.rc4 со старым смартапом необходимо в директории смартапа из файла static/.text_normalizer_resources/static_workdata.json
удалить строки 'Ё на Е'.
Установка фреймворка
Для установки фреймворка выполните в терминале следующую команду:
python3 -m pip install git+https://github.com/salute-developers/smart_app_framework@main
Создание проекта
Для создания проекта выполните в терминале следующую команду:
python3 -m smart_kit create_app <YOUR_APP_NAME>
После этого в текущей директории появится каталог с проектом. Он уже содержит в себе всё необходимое для запуска минимального приложения, включая базовый сценарий hello_scenario. Описание сценариев и форм можно найти в <YOUR_APP_NAME>/static/references/.
Тестирование онлайн
Для тестирования онлайн вам понадобится мобильное приложение Салют или собственное устройство, на котором будет запускаться смартап. Для такого тестирования:
- Запустите в терминале dev сервер:
python3 manage.py run_app
- Передайте в интернет порт. Для этого потребуется внешний IP-адрес. Если у вас его нет, воспользуйтесь специальными сервисами (например, Ngrok).
- Зарегистрируйтесь в кабинете разработчика - [SmartApp Studio](#TODO: вставить ссылку).
- Создайте в [SmartApp Studio](#TODO: вставить ссылку) свой смартап.
- Перейдите в настройки смартапа и укажите в поле "Настройки вебхука" адрес вашего сервера. Сохраните изменения.
- Запустите свой смартап с помощью фразы "Запусти <имя приложения>".
В терминале должны появиться записи о входящем сообщении, а ассистент ответит приветствием согласно сценарию hello_scenario.
Тестирование офлайн
Ниже представлен пример команды для терминала при тестировании офлайн и пример ответа, который выводится на экране:
localhost:~$ python <YOUR_APP_NAME>/manage.py local_testing
Текущий сценарий: hello_scenario
Привет! Введите help или ? для вызова списка команд.
> set intent run_app // смена интента на другой. По умолчанию имя сценария совпадает с именем интента
intent = run_app
> Привет
pronounceText: Как тебя зовут?
Документация
Вы можете ознакомиться с подробной документацией по работе со SmartApp Framework в [справочнике разработчика](#TODO: вставить ссылку).
Обратная связь
C вопросами и предложениями пишите нам по адресу [#TODO: вставить почту] или вступайте в наш Telegram канал - SmartMarket Community.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for smart_app_framework-1.0.8rc16.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88c142e017bcb8c9075eba9cbab27c6487ff21d96f462344d3c1f9ba0c481365 |
|
MD5 | 18dd98fc94e1623265739b6212fd7536 |
|
BLAKE2b-256 | 2bc58db49de7d5a4b74dc6e1d69bebf9aa8a1daa7aaf7f701e7d38849af758e1 |
Hashes for smart_app_framework-1.0.8rc16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a5ea721735532fbe1c80765d2c886a9799d3b0b7fe876f0cf717cf451492c7f |
|
MD5 | 8956ffeaa6b6999b817d4448300f3915 |
|
BLAKE2b-256 | 5673b5e60492ec9bceec1eeefe755013435f09194f808f01322095961cf6a233 |