История страницы

...

Extract data from a document

Группа действий: Распознавание текста

Действие извлекает данные из документов (Паспорт 2-3стр., Паспорт 5стр., СНИЛС) и сохраняет их в виде словаря, содержащего извлеченные данные документа, и изображение с блоками, из которых брались эти данные. Для извлечения данных действие использует сервисы Dbrain, поэтому для его работы потребуется API-ключ вендора.

Image Removed

Настройки

Action group: Text recognition

...

The action extracts data from documents (Passport 2-3 pages, Passport 5 pages, personal insurance policy number) and saves it as a dictionary containing extracted document data and an image with blocks from which the data was extracted. The action uses Dbrain services for data extraction, so it requires a vendor API key.

Image Added

Settings

Property	Description	Type	Filling example	Mandatory field
Parameters
File path	The path to the file to extract the data from. Supported formats

Свойство

Описание

Тип

Пример заполнения

Обязательность заполнения поля

Параметры

Путь к файлу

Путь к изображению, из которого нужно извлечь данные. Поддерживаемые форматы

: jpg, jpeg, bmp, png.

Robin.FilePath

.

C:\doc\img.png

Да

		Yes
API

ключУникальный идентификатор для доступа к сервису Dbrain

key

A unique identifier for accessing the service.

Robin.String

Да

Yes

Облачный сервер

Если значение "true", то действие будет отправлять запрос на облачный сервер DBrain. Если "false", действие отправит запрос на локальный сервер Dbrain

Cloud server

If the value is «true», the action will send a request to the DBrain cloud server. If «false», the action will send a request to the local DBrain server.

Robin.Boolean

true

Нет

No

Тип документа

Тип документа в исходном изображении. В зависимости от выбранного типа будут извлечены соответствующие наборы полей.

Выпадающий список из элементов:

Паспорт 2-3стр.
Паспорт 5стр.
СНИЛС

Document type

The type of document to extract data from.

Robin.String

Да

Путь к папке

	Yes
Folder path	The path to the folder where a copy of the source file with superimposed blocks will be saved, into which the recognition action divides it. To save it, you also need to fill in the «File name» field.

Путь к папке, в которую будет сохранена копия исходного изображения с наложенными блоками, на которые его делит действие для распознавания. Для сохранения также нужно заполнить поле "Имя файла".

Robin.FolderPath

C:\doc\

Folder

img

Нет

No

Имя файла

File name

The name of the copy of the source file with superimposed blocks (without extension). The image will be created with the *.png extension. To save it, you also need to fill in the «Folder path» field

Название изображения с наложенными блоками (без расширения). Изображение будет создано с расширением *.png. Для сохранения также нужно заполнить поле "Путь к папке"

.	Robin.String

Нет

	No
Time out	The time in milliseconds during which data will be extracted from the document. The default value is 120000 ms

Тайм-аут, мсВремя в миллисекундах, в течение которого будет происходить извлечение данных из документа. Значение по умолчанию 120000 мс

.	Robin.Numeric

Нет

No

ПерезаписатьЕсли значение "true", и в указанной папке существует изображение с таким же именем и расширением, то новое изображение с блоками его перезапишет. Если "false", файл перезаписан не будет, и действие вернет ошибку

Overwrite

If «true», and a file with the same name and extension exists in the specified folder, then a new file with blocks will overwrite it. If «false», the file will not be overwritten, and the action will return an error.

Robin.Boolean

true

Нет

No

Результаты

Results

Извлеченные данные

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

Extracted text

The data of each field in the document extracted from the original image.

Robin.Dictionary

Изображение с блоками


Image with blocks	The path to the image file with superimposed blocks

Путь к изображению с наложенными блоками

.	Robin.FilePath

Точность распознавания


Recognition confidence	The accuracy of recognition of each field in the image is in the range from 0 to 1. The key is the name of the field, the value is the accuracy of recognition of this field

Точность распознавания каждого поля на изображении в диапазоне от 0 до 1. Ключ - имя поля, значение - точность распознавания данного поля

.	Robin.Dictionary

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

Special conditions of use

Connecting to Dbrain: Подключение к Dbrain https://doc.dbrain.io/podklyuchenie/podklyuchenie-k-oblaku

Нейросеть распознает только российские документы.

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

Neural network recognizes only Russian documents.

For each document type, a set of fields that the robot will search for is defined. If the image does not contain the fields it is looking for, the field value will be returned empty. Keys are returned in Russian.

Passport keys (2-3 pp)Ключи для паспорта 2-3 стр.:

Паспорт выдан
Дата выдачи
Код подразделения
Фамилия
Имя
Отчество
Пол
Дата рождения
Место рождения
Номер и серия паспорта

Ключи для прописки Registration keys (5 стрp):

Полный адрес
Дата регистрации
Регион
Район
Пункт
Р-н
Улица
Дом
Строение
Квартира
Подразделение
Код подразделения

...

Номер СНИЛС
Фамилия
Имя
Отчество
Дата рождения
Место рождения
Пол
Дата регистрации

Робот вернет ошибку, еслиThe robot will return an error if:

заполнено поле "Путь к папке" и не заполнено "Имя файла".
заполнено поле "Имя файла" и не заполнено "Путь к файлу".
в поле "Путь к файлу" подается недопустимый формат входного файла.
по указанному пути уже есть файл с указанным именем и поле "перезаписать" = false.
указан неверный API-ключ.
Тайм-аут закончился, результат не получен.
Облачный сервер не отмечен, локальный сервер не развернут пользователем на машине.

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

Задача: распознать поля с данными документа из файла.

Решение: воспользоваться действием "Извлечь данные из документа".

Реализация:

Документ для распознания:

Image Removed

Перенести действие "Извлечь данные из документа" на рабочую область.
Image Removed
Настроить параметры действия "Извлечь данные из документа".
Image Removed
Нажать на кнопку "Старт" в верхней панели.

Результат: Программный робот отработал успешно. Поля с данными распознаны.

Image Removed

The "Folder path" field is filled in and the "File name" field is not filled in.
the "File name" field is filled in and the "File path" is not filled in.
an invalid input file format is entered in the "File path" field.
there is already a file with the specified name on the specified path and the "overwrite" field = false.
an invalid API key is specified.
Timeout expired, no result was received.
Cloud server is not checked, local server is not deployed by the user on the host.

Example of use

Task: recognize fields with document data from a file.

Solution: use the "Extract data from a document" action.

Implementation:

A document to recognize:

Image Added

Move the "Extract data from a document" action to the workspace.
Image Added
Set the parameters of the "Extract data from a document" action.
Image Added
Click on the "Start" button in the top panel.

Result

The program robot completed successfully. The data fields have been recognized.

Image Added

	Recognition accuracyТочность распознавания
Номер СНИЛС	1
Фамилия	1
Имя	1
Отчество	1
Дата рождения	1
Место рождения	1
Пол	1
Дата регистрации	1

Изображение с наложенными блокамиImage with superimposed blocks:

Дерево страниц

Сравнение версий

Старая версия 1

Новая версия 2

Ключ

Extract data from a document

Настройки

Settings

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

Special conditions of use

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

Example of use