Извлечение данных
Извлекаем данные из изображений документов и возвращаем их в структурированном виде
Извлекаем данные из изображений документов и возвращаем их в структурированном виде
Полученные из сервиса данные можно использовать для предзаполнения онлайн-форм, сравнения с данными в CRM-системах, идентификации клиента и в десятках других бизнес-сценариев.
Что делает сервис:
Находит документы на фото и сканах
Обрабатывает многостраничные файлы в форматах PDF и DJVU
Отделяет документы от фона — бабушкиных ковров и узорчатых скатертей
Поправляет повёрнутые и зеркально отражённые документы
Извлекает данные из некачественных фото:
обрезанные;
смазанные;
бликующие;
с наложением посторонних предметов.
Если вы собираетесь работать только с качественными документами, воспользуйтесь перед извлечением данных
Есть 5 популярных способов взаимодействия с сервисом. Для любого вам нужен ключ лицензии. Чтобы получить ключ, напишите нам в или на .
Подготовьте изображение документа для теста. Если у вас такого нет, используйте .
Вы можете использовать эти параметры с любыми видами документов.
Если вам нужно извлечь данные только из одного типа документа, укажите этот тип в параметре doc_type:
Для извлечения данных только из главного разворота Паспорта РФ укажите doc_type=passport_main
Для извлечения данных из нескольких типов документов допишите их в запрос через &doc_type=
. Например, вам нужен главный разворот и прописка Паспорта РФ. В запросе это будет выглядеть так: doc_type=passport_main&doc_type=passport_registration
mode — string
Поведение по умолчанию: mode=default
Для этого передайте сервису извлечения данных результаты работы классификатора: изображение в параметре image
и тип документа в параметре doc_type
, а также укажите mode=recognize_only
. В таком случае сервис не будет запускать лишнюю классификацию документа и вы быстрее получите ответ.
return_crops — boolean
Поведение по умолчанию: return_crops=false
— cервис не возвращает найденные изображения документов.
Если вам нужны найденные сервисом изображения документов, укажите return_crops=true.
Сервис вернёт в ответе API изображение в параметре crop.
task_id
— string, идентификатор запроса, формат: 32 символа, 16-ричная строка
items
— массив, который содержит распознанные документы
text
— string, текст поля документа
confidence
— number, уровень уверенности алгоритма в корректности извлечения данных из поля
coords
— массив, координаты поля на документе, вырезанного и правильно ориентированного, по четырём точкам: верхний левый угол, верхний правый, нижний левый, нижний правый
doc_coords
— массив, координаты документа на оригинальном изображении по четырём точкам: верхний левый угол, верхний правый, нижний левый, нижний правый
confidence
— number, уровень уверенности алгоритма в корректности определения типа документа
task_tags
— массив string, теги, если они переданы в параметре task_tags
page_count
— integer, число страниц в файле, актуально для PDF и DJVU
docs_count
— integer, число распознанных документов в файле
traceback
— string, сообщение об ошибке, которое содержит информацию о том, где произошла ошибка в коде и какие функции были вызваны перед ней. Это сообщение может помочь разработчикам понять причину возникновения ошибки и исправить ее. Передайте её нашей службе поддержки.
Остальные поля не несут практического смысла. Оставили их для совместимости со старыми версиями
У каждого типа документа есть свои особенности извлечения. Изучите то, что нужно вам, тут:
Обратитесь к методу /recognize
по адресу . В этом способе только два обязательных параметра:
Откройте и нажмите кнопку Authorize
в правом верхнем углу
Поведение по умолчанию: сервис извлекает данные из всех , которые классификатор документов найдёт в файле.
Вы можете использовать сервис отдельно от сервиса извлечения данных. Построить разную логику обработки документов в зависимости от того какие типы документов классификатор нашёл на изображении.
Перед началом работы с сервисами изучите раздел . Там мы рассказываем про допустимые форматы файлов, виды запросов и ответов, набор HTTP-статусов и даём рекомендации по устранению ошибок
doc_type
— string, тип документа, все типы перечислены в
fields
— string, поля документа, список полей по каждому документу приведён в API-спецификация в .