Text

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

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

Text

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

При этом существует две равноправные формы описания:

•полная форма, содержащая key, synonyms, type и, возможно, postfix,

•сокращённая форма, содержащая лишь key и value.

•Сокращённая форма описания текстовых полей предоставляет возможность не указывать поля Type, Synonyms и Postfix. В этом случае единственный синоним задается значением поля Value, а текстовый тип данных подразумевается.

Полная форма

Поле

Тип поля

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

Описание

Key

String

Да

Идентификатор поля в ИС

Synonyms

Список строк

Да

Набор всех возможных вариантов произнесения одного и того же поля.

Коллекция строк, по которым система будет определять, что распознаваемые данные соответствуют данному элементу или полю

Type

Int32

Да

Тип поля установлен 0

 

{
    "Type": 0,
    "Synonyms": [
        "Описание"
    ],
    "Key": "9cb3cf80-8f5d-4bdd-9956-16aecb405f3a"
}

 

Сокращённая форма

Поле

Тип поля

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

Описание

Key

String

Да

Идентификатор типа формы. По этому идентификатору кэшируются метаданные

Value

String

Да

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

 

{
    "Value": "Описание",
    "Key": "9cb3cf80-8f5d-4bdd-9956-16aecb405f3a"
}

 

Ответ от Voice2Med

При распознавании возвращается в виде ValuedElementInfo<String>:

{
    "MessageType": 1,
    "Data": {
        "Type": 0,
        "Value": "Надиктованный текст",
        "Key": "9cb3cf80-8f5d-4bdd-9956-16aecb405f3a"
    }
}