Общие принципы работы с ROBIN OCR:

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. Если таймаут истекает до того как получим распознанный текст будет получен пустой результат, действие не завершается с ошибкой.
   
   
   

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

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

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

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

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

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

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

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

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

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

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

Файл прошел валидацию вручную. 

Файл получил статус "Экспорт".

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

Встроенные в студию действия по работе с JSON - файлами.

Пример составленной цепочки действий для обработки результата. Для распараллеливания процессов распознавания изображений можно использовать Очереди. 

Представленные для текущего пользователя классы пакетов.

Профиль распознавания по умолчанию -default. Интерфейс настройки профиля распознавания.

Пример исходного файла. 

Пример результирующего файла.

Составим последовательность действий, чтобы файл сохранился на компьютер.

Результат в виде json-файла. Нет необходимости сохранять полученный файл. Его можно сразу же обрабатывать действиями студии.

Действия студии, если результат получен в виде xml-файла. Далее можно воспользоваться действием "Получить элементы по XPath", чтобы получить необходимые для дальнейшей работы значения.

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

Действие отправляет файл на распознавание во внешнее приложение Soica.

Первое действие из связки Отправить+Получить. Отправить файл на распознавание и Получить результат распознавания разделено на 2 действия для случаев, когда система будет долго обрабатывать большой файл, поданный на вход. 

Настройки 

Login

Особые условия использования

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

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

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

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

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

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

Действие "Получить результат распознавания" / "Get recognition result"

Извлечение текста из файла файла изображения с использованием пред-настроенного профиля распознавания.

Настройки 

Login

Особые условия использования

Необходимо запустить действие "Отправить на распознавание" перед действием "Получить результат распознавания".

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

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

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

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

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

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

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

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

Login

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

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

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

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

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

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

    

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

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

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

Решение: использовать действия «Отправить на распознавание», "Получить результат распознавания".

Реализация:

1. Последовательно установить действия «Отправить на распознавание» и  "Получить результат распознавания" на рабочую область.
2. Заполнить параметры действий корректными данными:
   1. параметры  «Отправить на распознавание»; 
      
      
      
   2. параметры "Получить результат распознавания". 
      
   
   
3. Запустить робота по кнопке "Старт" в верхней панели. 
   

Результат: Робот вернет обработанные файлы. Результат представлен в виде коллекции с  json-объектами или xml-контекстами. Статус "export".

Распознать

Задача: распознать текст на документе.

Решение: использовать действие "Распознать". 

Реализация:

1. Установить действие "Распознать"на рабочую область.

2. Заполнить параметры действия корректными данными. 

   

3. Запустить робота по кнопке "Старт" в верхней панели. 
   

Результат: Робот вернул обработанные файлы. Результат представлен в виде коллекции с  json-объектами или xml-контекстами. Статус "export".