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

Поле с типом перечисление или ссылка на значения справочника, унаследованное от ValuedFormElementMetadata.

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

Поле	Тип поля	Обязательное	Описание
Key	String	Да	Идентификатор поля в ИС
Type	Int32	Да	Тип поля установлен 7
Synonyms	Список строк	Да	Набор всех возможных вариантов произнесения одного и того же поля. Коллекция строк, по которым система будет определять, что распознаваемые данные соответствуют данному элементу или полю
Postfix	Список строк	Нет	Коллекция строк, которые могут быть произнесены после значения, но не должны повлиять на результат распознавания
HandbookKey	String	Да	Ключ справочника, однозначно идентифицирующий этот справочник. Значение должно содержать только символы латинского алфавита, тире и цифры
AvailableValues	Список элементов состоящий из KeyValuePair<string, string>	Да	Список возможных значений
FreeTextAvaliable	Boolean	Нет	Разрешение ввода произвольного текста. По умолчанию имеет значение false

Обратите внимание, что поле FreeTextAvaliable по умолчанию имеет значение false. В исключительных случаях ему можно задать значение true. Это позволит заполнить данное поле не только одним из предустановленных вариантов, но и произвольным текстом (как будто это строковое поле).

Однако такой «свободный» ввод требует от пользователя особого «раздельного» произнесения: он должен произнести название поля, затем сделать паузу, убедиться, что поле стало активным, и лишь затем произнести произвольный текст.

{
    "HandbookKey": "38d61a2b-cde8-4d17-b806-60c5fa8c8769",
    "AvailableValues": [
        {
            "Key": "0",
            "Value": "Мужской"
        },
        {
            "Key": "1",
            "Value": "Женский"
        }
    ],
    "Type": 7,
    "Synonyms": [
        "Пол"
    ],
    "FreeTextAvaliable": false,
    "Key": "7b43b0e0-5e02-4422-984a-e4f531021744"
}

Ответ от Voice2Med

При распознавании возвращается в виде ValuedElementInfo<KeyValuePair<string, string>[]>:

{
    "MessageType": 1,
    "Data": {
        "Type": 7,
        "HandbookRow": [
            {
                "Key": "0",
                "Value": "Мужской"
            }
        ],
    "Key": "7b43b0e0-5e02-4422-984a-e4f531021744"
  }
}

При распознавании в поле свободного текста:

{
    "MessageType": 1,
    "Data": {
        "Type": 7,
        "Value": "Какой-то произвольный текст",
        "Key": "7b43b0e0-5e02-4422-984a-e4f531021744"
    }
}

Link

Link