...

1. Для отправки документа на распознавание нужно выполнить минимум 2 запроса. Сначала  отправляется запрос на создание пакета, в запрос передается единственное изображение пакета или первое. Запрос возвращает GUID пакета. Если изображений в пакете должно быть несколько, то в последующих запросах эти изображения добавляются к пакету (по одному). Завершающим запросом надо запустить пакет на обработку. Во второй и последующие запросы передается GUID созданного пакета.

2. Формат результата настраивается заранее, в сценарии.

3. Пользователь будет получать результат в виде коллекции json-объектов или xml-контекстов. С полученными результатами можно работать действиями студии.

4. Список классов пакета пользователь должен знать перед запуском действия.

5. Классы пакетов будут настроены в системе инженером, нужно выбрать класс, подходящий для обработки изображения. Имя класса пакета - это имя настроенного проекта. Имя класса пакета нужно указывать при создании пакета (обязательно). Имя пакета надо задавать в запросе. 

6. Когда робот будет завершать работу с ошибкой, в тексте ошибки будет отображаться причина. 

7. Если статус документа не "export", то робот не сможет получить результат и пропустит документ. Пользователь сам должен будет передвинуть документ в другой статус на сервере.

8. Статусы: 

   1. import – импорт => ждать смены статуса
   2. recognize – распознавание =>ждать смены статуса
   3. validation – валидация=> вручную менять статус в системе Сойки
   4. export – экспорт => готово к выгрузке
   5. deleted - пакет был удален 
   6. inaccessible - пакет недоступен
   7. quality control -  если пользователь отправил по неправильному сценарию, вручную менять статус в системе Сойки.
9. Если таймаут истекает до того как получим распознанный текст будет получен пустой результат, действие не завершается с ошибкой.
   
10. 
    

Интерфейс Сойки. 

Аутентификация:

1. При первом подключении необходимо заходить через браузер, chrome предпочтительно. admin, admin.

2. Для получения доступа к функциям rest-сервиса требуется аутентификация – BasicHttpAuth, логин и пароль передаются в заголовке http, при этом логин в открытом виде, а пароль – зашифрованный MD5.

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

4. В двух вкладках открывают сразу же 2 модуля. Модуль администратора: http://localhost/administrator. Модуль валидации: http://localhost/validation. 

 Аутентификация при подключении через браузер - обязательная процедура для каждого пользователя. Личный логин и пароль пользователей связан с личными настроенными сценариями.

Image Added Image Added

Просмотр документа на валидации. 

Image Added

В режиме просмотра default с зажатой клавишей Shift можно выделить область, чтобы внести в нее правки. 

Image Added

Когда правки применены, изменения отражаются в системе.

Image Added

Способы обработки результата. 

Image Added

Действие "Отправить на распознавание" / "Send files for recognition"

...

Нужно заранее получить данные для аутентификации в сервисе Сойки.

Если за 120 секунд сервер не отправил ответ, то сервер недоступен.

Робот вернет ошибку, если:

1. в поле "Файл" подается неверный формат.

2. неверный логин или пароль подключения. 403

3. неверно указан путь, ссылка - 404

...

Чтобы получить результат, нужно чтобы файл был распознан системой и переведен в статус  "export". Если робот при проверке статуса документа робот получил любой статус, кроме "export", то робот вернет полученный статус документа и пустой файл результата распознавания.

Если за 120 секунд сервер не отправил ответ, то сервер недоступен.

Робот вернет ошибку, если:

...

1. неверно указан путь, ссылка - 404

2. неверный логин или пароль подключения. 403

3. выбранный сценарий обработки не подходит. 401

4. внутренняя ошибка сервера -500.

5. личные данные и ID документа не принадлежат одному пользователю.

   
   

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

Отправить + получить

...