Получить статус распознавания Версия 1 (Net)

Группа действий: Робин OCR Подгруппа Soica


Описание

Действие получает из сервиса SOICA статус распознавания отправленных документов, а также ID пакетов, готовых к экспорту.

Иконка действия

Параметры их настройка

Свойство

Описание

Тип

Пример заполненияОбязательность заполнения поляПримечание
Входные параметры

URL

Ссылка для аутентификации в сервисе SOICA (RestAPI)Robin.String  http://localhost/administratorДа
Логин

Логин для входа

Robin.String adminДа
ПарольПароль для входаRobin.Password adminДа
Начальная датаДата, начиная с которой документы были отправлены на распознавание. Если поле не заполнено, начальной датой будет дата отправки на сервер самого первого документаRobin.DateTime
Нет

Если обе даты заполнены, то в таблице будут указаны документы внутри диапазона дат

Если "Дата До" указана раньше, чем "Дата От", то в таблице будут указаны документы внутри диапазона дат. Не будет ошибки

Если заполнена только "Начальная дата" – документы от указанной даты до текущей

Если заполнена только "Конечная дата" – документы с первого использования сервера до указанной даты

Конечная датаДата, до которой документы были отправлены на распознавание. Если поле не заполнено, конечной датой будет текущая датаRobin.DateTime
Нет
Тайм-аут, мсВремя в миллисекундах, в течение которого действие будет ожидать ответ от сервиса SOICARobin.Numeric
Нет

Если не заполнен, то стандартный тайм-аут от httpClient в С# 100 секунд= 100 000 мс

Если тайм-аут закончился раньше, чем получены результаты, то вернутся пустые результаты

Результаты

ID готовых документов

Коллекция идентификационных номеров пакетов документов, которые готовы к экспорту

Robin.Collection


Коллекция с ID только готовых для экспорта документов в статусе "export". Если документ не готов для экспорта, то получить результаты его распознавания нельзя. Соответственно, получать все ID не имеет смысла
Статус документовТаблица, в которой указываются данные о документах, отправленных на распознавание в указанный диапазон времениRobin.Table

Состоит из столбцов:

  • ID
  • Название документа
  • Класс документа
  • Статус
  • Описание ошибки

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

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

Действие выдаст:

  • ошибка 403 "Неверный логин или пароль подключения", если задан неверный логин или пароль подключения;
  • ошибка 404 "Неверный адрес для аутентификации на сервере", если неверно указан путь или ссылка.

Общие принципы работы  SOICA можно посмотреть тут: Общий принцип работы SOIСA

Статусы:

  • import – импорт => ждать смены статуса для возможности дальнейшей обработки;
  • recognize – распознавание =>ждать смены статуса;
  • validation – валидация=> вручную менять статус;
  • export – экспорт =>можно запускать действие "Получить результат распознавания";
  • deleted - пакет был удален =>ждать смены статуса;
  • inaccessible - пакет недоступен =>ждать смены статуса;
  • quality control - тут может зависнуть файл, если пользователь отправил по неправильному сценарию, надо идти вручную проверять.

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

Задача

Отправить документ на распознавание и далее получить его статус распознавания и сохранить данные статусы в таблице формата CSV.

Решение

Использовать действия "Отправить на распознавание", "Получить статус распознавания", "Сохранить таблицу в CSV".

Реализация

  1. Последовательно установить действия "Отправить на распознавание", "Получить статус распознавания" и "Сохранить таблицу в CSV" на рабочую область.

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

    1. параметры действия  «Отправить на распознавание»; 

    2. параметры действия  "Получить статус распознавания". 

    3. параметры действия  "Сохранить таблицу в CSV". 

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

Результат

Робот отработал успешно.

Робот вернет CSV файл со статусами распознавания.

  • Нет меток