Получить статус распознавания

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

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

Описание

Действие получает статусы распознавания отправленных документов

Под статусом отправленных документов подразумеваются выходные параметры: поле "ID готовых документов" с коллекцией с номерами документов, которые находятся в статусе "export" в текущий момент, и поле "Таблица со статусами" – таблица с информацией обо всех пакетах документов, подходящих по запрашиваемым параметрам

Пользователь отправляет на распознавание в Сойку документы. Там они будут обработаны в соответствии с заданными параметрами. Для того, чтобы получить результаты распознавания, пользователю необходимо проверить статус документа, в котором содержится информация о том, прошли ли документы обработку и готовы ли они к в экспорту, были ли ошибки в распознавании, пройдена ли верификация. Статус документа содержится в результате выполнения действия "Получить статус распознавания". Далее, документы, которые успешно прошли обработку можно направить в действие "Получить результат распознавания", используя ID, полученный в результате.

Общие принципы работы с Soica указаны в действии "Распознать". Распознать

Действие отправляет файл на распознавание в сервис Робин OCR с Сойкой.

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

Параметры

Входные параметры

URL Ссылка для аутентификации на сервисе Сойки (RestAPI)

Логин Логин для входа в систему Сойки

Пароль Пароль для входа в систему Сойки

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

Конечная дата Дата, до которой документы были отправлены на распознавание. Если поле не заполнено, конечной датой будет текущая дата

Тайм-аут, мс Время в миллисекундах, в течение которого действие будет ожидать ответ от сервера

Выходные параметры

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

Таблица со статусами Таблица, в которой указываются данные о документах, отправленных на распознавание в указанный диапазон времени.

Настройки

Свойство	Описание	Тип	Пример заполнения	Обязательность заполнения поля	Примечание
Входные параметры
URL	Ссылка для аутентификации на сервисе Сойки (RestAPI)	Robin.String	http://localhost/administrator	Да
Логин	Логин для входа	Robin.String	admin	Да
Пароль	Пароль для входа	Robin.Password	admin	Да
Начальная дата	Дата, начиная с которой документы были отправлены на распознавание. Если поле не заполнено, начальной датой будет дата отправки на сервер самого первого документа	Robin.DateTime		Нет	Если обе даты заполнены, то в таблице будут указаны документы внутри диапазона дат. Если "Дата До" указана раньше, чем "Дата От", то в таблице будут указаны документы внутри диапазона дат. Не будет ошибки. Если заполнена только "Начальная дата" – документы от указанной даты до текущей. Если заполнена только "Конечная дата" – документы с первого использования сервера до указанной даты.
Конечная дата	Дата, до которой документы были отправлены на распознавание. Если поле не заполнено, конечной датой будет текущая дата	Robin.DateTime		Нет
Тайм-аут, мс	Время в миллисекундах, в течение которого действие будет ожидать ответ от сервера	Robin.Numeric		Нет	Если не заполнен, то стандартный тайм-аут от httpClient в С# 100 секунд= 100 000 мс Если тайм-аут закончился раньше, чем получены результаты, то вернутся пустые результаты.
Результаты
ID готовых документов	Коллекция идентификационных номеров документов, которые готовы к экспорту	Robin.Collection			Коллекция с ID только готовых для экспорта документов в статусе "export". Если документ не готов для экспорта, то получить результаты его распознавания нельзя. Соответственно, получать все ID не имеет смысла.
Таблица со статусами	Таблица, в которой указываются данные о документах, отправленных на распознавание в указанный диапазон времени	Robin.Table			Состоит из столбцов: ID Название документа Класс документа Статус Описание ошибки

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

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

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

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

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

Задача

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

Решение

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

Реализация

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

- параметры действия «Отправить на распознавание»;
- параметры действия "Получить статус распознавания".
- параметры действия "Сохранить таблицу в CSV".