Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@salutejs/scenario
Advanced tools
Tiny helpers to make scenario for Salute family
Библиотека описания структры, матчинга и хендлеров пользовательского сценария.
npm i -S @salutejs/scenario
Словарь описывается локально в файле с заданной схемой. В зависимости от типа рекогнайзера, словарь может синхронизроваться с удалённой моделью распознования.
./src/intents.ts
import { createIntents } from '@salutejs/scenario';
export const intents = createIntents({
openItem: {
matchers: ['покажи', 'открой', 'открой номер'], // фразы, которые будут использованы для тренировки модели
},
slotFilling: {
matchers: ['захвати яблок', 'захвати @number ялок'],
variables: { // сущности, которые необходимо достать из фразы
number: {
required: true, // флаг обязательного присутствия сущности в сессии для продолжения сценария
questions: ['Сколько яблок?', 'Сколько?'],
},
},
},
});
import { createUserScenario } from '@salutejs/scenario';
// ...
const userScenario = createUserScenario({
OpenItemState: { // идентификатор состояния
match: intent('OpenItem'),
handle: ({ req, res }) => {
const { number } = req.variables;
res.appendCommand({ type: 'OpenItem', payload: selectItem({ number })(req) });
},
},
slotFillingState: {
match: intent('slotFilling'),
handle: ({ res, req }) => res.setPronounceText(`Вы попросили ${req.variables.number} яблок`),
},
});
Хелперы декларативного описания условия выполнения хендела на поступивший запрос.
import { createMatchers, createUserScenario, SaluteRequest } from '@salutejs/scenario';
import { intents } from './intents';
// NB: Указание типа запроса и словаря интентов добавляет интерактивный автокомплишен
const { match, intent, text, action, state, selectItem } = createMatchers<SaluteRequest, typeof intents>();
// Матчеры собираются в композицию функцией match
const userScenario = createUserScenario({
state1: {
match: match(intent('OpenItem'), state({ screen: 'main' }),
handle: () => {},
},
state2: {
match: text('да'), // распознование не будет передено в рекогнайзер
handle: () => {},
},
state3: {
match: action('LOAD_DATA'), // матчер на тип, передаваемый в server_action
handle: () => {},
},
});
NLP-платформа обладает набором специальных интентов, которые указывают на жизненный цикл смартапа: run_up
, close_app
. Кроме них случаются ситуации, когда фраза пользователя не попала ни под один матчер состояния. Грубо говоря, мы не поняли что хотел сказать пользователь. Такие состояние описываются в отдельном обработчике системного сценария.
import { createSystemScenario } from '@salutejs/scenario';
const systemScenario = createSystemScenario({
RUN_APP: ({ res }) => { // реакция на запуск смартапа
res.setPronounceText('Привет!');
},
CLOSE_APP: ({ res, session }) => { // реакция на закрытие смартапа
db.save(session);
},
NO_MATCH: ({ res }) => { // реакция на не распознанную реплику
res.setPronounceText('Я не понимаю');
},
});
Чтобы оплата работала, необходимо добавить переменную SMARTPAY_TOKEN
в environment.
Для отображения диалога оплаты на экране смартаппа, необходимо:
createInvoice
).res.askPayment
).import { createInvoice, SaluteHandler } from '@salutejs/scenario';
const handler: SaluteHandler = async ({ req, res }) => {
const { delivery_info, order } = req.variables;
const { invoice_id } = await createInvoice({ invoice: { delivery_info, order } });
res.askPayment(invoice_id);
};
Чтобы узнать о завершении диалога оплаты пользователем,
необходимо подписаться на системный сценарий PAY_DIALOG_FINISHED
.
import { createSystemScenario, findInvoice, PayDialogFinishedServerAction, PayDialogStatuses, PaymentInvoiceStatuses } from '@salutejs/scenario';
createSystemScenario({
PAY_DIALOG_FINISHED: async ({ req, res }) => {
const { parameters } = req.serverAction as PayDialogFinishedServerAction;
if (parameters.payment_response.response_code === PayDialogStatuses.success) {
// диалог завершился успешно, необходимо проверить статус платежа
const { invoice_status } = await findInvoice({ invoiceId: parameters.payment_response.invoice_id });
if (invoice_status === PaymentInvoiceStatuses.confirmed) {
// оплачено и можно формировать заказ
}
}
}
});
Интерфейс для адаптации текста с динамическими параметрами и плюрализацией в рамках персонажей семейства виртуальных ассистентов Салют.
Файлы с адаптацией лежат рядом с кодом, к которому они логически относятся.
src/handlers/mainPage
├── mainPage.i18n
│ ├── sber.ts — словарь для персонажа Сбер
│ ├── joy.ts — словарь для персонажа Джой
│ ├── athena.ts — словарь для персонажа Афина
│ └── index.ts — карта персонажей
Файл словаря — модуль, в котором лежит кейсет для одного языка с парами { ключ, перевод }
:
// mainPage/mainPage.i18n/sber.ts
export const sber = {
Пока: 'Bye',
Привет: 'Example',
};
Все словари должны быть объявлены в карте персонажей. Картой оперирует модуль i18n.
// mainPage/mainPage.i18n/index.ts
export * from './sber';
export * from './joy';
export * from './athena';
// mainPage/mainPage.ts
import * as keyset from './mainPage.i18n';
// ...
handle: ({ req, res }) => {
const greeting = req.i18n(keyset);
res.setPronounceText(greeting('Привет'));
},
// ...
Параметры объявляются в синтаксисе схожем с параметрами для template strings.
// mainPage/mainPage.i18n/sber.ts
export const sber = {
'Добрый день, {name}!': 'Добрый день, {name}!',
}
// mainPage/mainPage.i18n/joy.ts
export const joy = {
'Добрый день, {name}!': 'Привет, {name}!',
}
// mainPage/mainPage.ts
import * as keyset from './mainPage.i18n';
// ...
handle: ({ req, res }) => {
const greeting = req.i18n(keyset);
res.setPronounceText(greeting('Добрый день, {name}!', {
name: 'Костя',
}));
},
// ...
Для выражения плюрализация существует специальный параметр count
. Который соотносится с вариантами написания ключа через вложенные параметры: many
, some
, one
, none
.
// mainPage/mainPage.i18n/sber.ts
export const sber = {
'{count} операций': {
many: '{count} операция',
none: 'нет операций',
one: '{count} операция',
some: '{count} операции',
}
}
// mainPage/mainPage.ts
import * as keyset from './mainPage.i18n';
// ...
handle: ({ req, res }) => {
const transactions = req.i18n(keyset);
res.setPronounceText(transactions('{count} операций', {
count: 2,
}));
},
// ...
FAQs
Tiny helpers to make scenario for Salute family
We found that @salutejs/scenario demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.