|
<< Показать Оглавление >>
Описание API |
![]()
|
API использует протокол полнодуплексной связи WebSocket. Однако, часть операций больше соответствует синхронной модели запросов, поэтому для таких запросов предусмотрена альтернатива в виде REST API. |
Работа ИС через Voice2Med Client
Для запуска распознавания и заполнения формы ИС должна подключиться к клиентскому приложению Voice2Med Client посредством WebSocket и передать сообщение с описанием заполняемой формы (метаданные, описывающие форму). Любое сообщение, отправляемое между Voice2Med Client и ИС посредством WebSocket, оборачивается в типизированный класс-контейнер DictationApiMessage<T>.
ИС обязательно должна прислать описание формы перед началом голосового заполнения. Передать метаданные возможно как непосредственно при запуске распознавания, так и импортировать заранее, до запуска распознавания. |
После успешной обработки сообщения Voice2Med Client отправляет в ИС уведомление об изменении текущей активной формы и режима работы. В случае ошибки обработки клиентское приложение отправляет оповещение об ошибке (ErrorInfo).
Далее Voice2Med Client распознаёт произносимый пользователем текст в соответствии с грамматикой формы и отправляет в ИС различные сообщения. Например, с описанием того, какое поле и какими данными нужно заполнить или на какое поле следует перевести фокус.
После заполнения всех полей формы ИС должна сообщить Voice2Med Client об окончании завершения работы с формой и получить в ответ уведомление об изменении режима работы.
Работа ИС напрямую с сервером Dictation Server
В некоторых случаях нельзя использовать приложение Voice2Med Client, однако возможно подключение ИС напрямую к Dictation Server.
Например, при работе ИС под управлением операционной системы семейства Linux приложение Voice2Med Client не предоставляет доступ к Form API.
Тогда ИС должна взаимодействовать напрямую с Dictation Server и выполнять все функции клиентского приложения Voice2Med Client.
При подключении напрямую к серверу Dictation Server вашему приложению потребуется взаимодействовать с балансировщиком нагрузки, самостоятельно обрабатывать звук, отправлять его на сервер распознавания и интерпретировать ответы. Для упрощения мы рекомендуем подключаться к Voice2Med Client, который решает ряд задач. |
Если на сервере Dictation Server используется шифрование трафика, то вместо WS-подключения подключайтесь к нему по протоколу WebSockets Secure (WSS), а для REST-запросов используйте протокол HTTPS. |
Смотрите также: