Класс FormCommandSetMetadata

<< Показать Оглавление >>

Описание API > Формат описания формы > Классы структуры формы      

Класс FormCommandSetMetadata

Форма может использовать несколько наборов команд с параметрами для управления заполнения формы, переключаться между которыми можно в процессе заполнения. Параметры произносятся после команды: например, «Перейти к странице пять». Здесь «Перейти к странице» — команда, «пять» — параметр. Голосовая команда может не иметь параметров.

atten_red

Собственные голосовые команды более приоритетны, чем поля формы. Если название поля случайно совпадёт с названием собственной голосовой команды, то будет возвращена именно голосовая команда.

Набор команд содержит список элементов типа FormElementMetadata со следующими ограничениями:

•составное поле типа Complex может иметь только один уровень вложенности;

•нельзя использовать группы.

При распознавании фразы, соответствующей какой-либо команде, Voice2Med отправляет:

•уведомление о произнесении команды;

•уведомление о произнесении команды (без параметров).

Отдельно импортированный набор команд может использоваться с различными формами по его уникальному ключу. При этом набор команд, заданный в рамках описании формы, должен иметь уникальный ключ и не должен совпадать с другими ключами.

Если указан только Key, а поле Childs отсутствует, то Voice2Med использует импортированный ранее набор команд.

 

Класс содержит описание набора команд формы

Поле

Тип поля

Обязательное

Описание

Key

String

Нет

Идентификатор набора команд. Он используется для предварительного импорта набора команд и его последующего использования

Childs

Список из FormElementMetadata

Нет

Коллекция команд в наборе.

Если не указан, то используется предварительно импортированный список команд.

Тип (Type) указывает, какие данные должны возвращаться в качестве параметра при произнесении команды с параметром

CultureCode

String

Нет

Код культуры, в соответствии с которой будут сериализованы распознанные данные. Например: “ru-RU”

Должен совпадать с CultureCode формы

 

{
   "FormCommands":[
      {
         "Key":"Set1",
         "Childs":[
            {
               "Type":0,
               "Key":"Finish",
               "Synonyms":[
                  "Завершить"
               ]
            },
            {
               "Type":2,
               "Key":"GoTo",
               "Synonyms":[
                  "Перейти к странице"
               ]
            }
         ]
      },
      {
         "Key":"Set2",
         "Childs":[
            {
               "Type":0,
               "Key":"Decline",
               "Synonyms":[
                  "отклонить"
               ]
            },
            {
               "Type":0,
               "Key":"Upload",
               "Synonyms":[
                  "загрузить"
               ]
            }
         ]
      }
   ]
}