Класс FormMetadata

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

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

Класс FormMetadata

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

Поле

Тип поля

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

Описание

Key

String

Да

Идентификатор формы.

Используется для предварительного импорта формы и при запуске её распознавания

Name

String

Нет

Название формы

Childs

Список из дочерних элементов класса FormElementMetadata

Да

Коллекция (иерархия) элементов на форме (поля формы)

CultureCode

String

Нет

Код культуры в соответствии с которым будут сериализованы распознанные данные.

Например: “ru-RU”.

Если не передавать, будет использован InvariantCulture

FormSettings

FormSettings

Нет

Дополнительные параметры распознавания

Mode

Int32 (nullable)

Нет

Режим заполнения формы.

0 — Произнесение в формате ключ + значение (используется по умолчанию).

1 — Voice Wizard. Система произносит (TTS) ключ и ожидает от пользователя произнесения значения

FormCommands

List<FormCommandSetMetadata>

Нет

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

ThemeId

String

Нет — при работе через Voice2Med Client,
Да — при работе через Dictation Server

Идентификатор словаря распознавания, который позволяет явно указать, какой словарь распознавания использовать при обработке полей, поддерживающих свободный ввод
atten_yell

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

Например, у нас есть поле «Комментарий»:

1.Пользователь произносит: «Комментарий» и фокус устанавливается на этом поле (словарь распознавания не оказывает влияния).

2.Пользователь произносит: «В этом поле будет какой-то произвольный текст» (результат распознавания зависит от выбранного словаря распознавания).

Для остальных полей словарь распознавания никак не влияет на их заполнение.

 

Пример использования:

{
    "Key":"a0bc1744-010c-4414-84e6-acabeff7b517",
    "Name":"Форма №1",
    "Childs":[…],
    "CultureCode":"ru-RU",
    "Mode": 1,
    "FormSettings": {…},
    "ThemeId": "main_2.3.13",
    "FormCommands": []
}