This release is a pre-release and may not be stable for production use.
SmartApp Framework
SmartApp Framework - это Python-фреймворк, который позволяет создавать смартапы для виртуальных ассистентов Салют.
Оглавление
Конфигурация
Фреймворк и смартапы
Смартап - это приложение для виртуального ассистента Салют. С помощью смартапов пользователи могут вызвать такси, узнать погоду, управлять устройствами умного дома, записаться в салон красоты и совершить прочие действия, которые можно доверить ассистенту.
Виртуальный ассистент понимает текущие намерения пользователя и для каждой его реплики подбирает соответствующий запрос на выполнение ([интент](#TODO: вставить ссылку)). Поведение смартапа для различных интентов описывается с помощью сценариев. Интенты и сценарии связываются через смартапы, написанные на SmartApp Framework.
Инструменты фреймворка
Фреймворк содержит следующие инструменты:
- инструменты для создания сценариев;
- решения для автоматического тестирования;
- демо-приложение для просмотра примеров реализации;
- готовые механизмы для слот-филлинга и извлечения сущностей из текста.
Рекомендованные требования
- Linux, Mac OS или Windows (необходима установка Conda).
- 512 МБ свободной памяти.
- Python 3.9 - 3.11.
Настройка фреймворка
Обновление фреймворка
Для перехода на новую версию фреймворка выполните в терминале следующие команды:
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 удалить строки 'Ё на Е'.
При переходе на версию фреймворка >=1.0.8rc15 со старым смартапом необходимо проверить соблюдение асинхронных интерфейсов методами классов-наследников классов Action, Requirement, FieldFillerDescription, Scenario, HandlerBase, SmartAppModel, BaseMainLoop.
Установка фреймворка
Для установки фреймворка выполните в терминале следующую команду:
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: Как тебя зовут?
Тестирование сценариев
Для тестирования обработки вашим навыком приходящих сообщений воспользуйтесь
python3 manage.py tests --run static/references/tests
Документация
Вы можете ознакомиться с подробной документацией по работе со SmartApp Framework в [справочнике разработчика](#TODO: вставить ссылку).
Разработка
Запуск тестов
Для тестов используется unittests.
Тесты находятся в директории tests
python -m unittest discover -s tests -v
poetry run task lint
Обратная связь
C вопросами и предложениями пишите нам по адресу [#TODO: вставить почту] или вступайте в наш Telegram канал - SmartMarket Community.
Metadata
Release files for smart-app-framework 2.4.0rc19
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| smart_app_framework-2.4.0rc19-py3-none-any.whl | Python 3 | none | any | Details for smart_app_framework-2.4.0rc19-py3-none-any.whl |
Release files / smart_app_framework-2.4.0rc19-py3-none-any.whl
| Download URL | smart_app_framework-2.4.0rc19-py3-none-any.whl |
|---|---|
| Size | 443.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
14e661c13f4b1ce5177c5c3d1060db2ff1ec3aea4c0756e95eee15568c374a21
|
|
BLAKE2b-256 checksum How to use checksums |
12253df0108399d10641b5eb58f1e766b9bed24d8314363008cdeedba8541568
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.11.17 Linux/7.0.0-1017-azure
|
Security for smart-app-framework 2.4.0rc19
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.