Базовый OCR
Возвращаем весь найденный текст из любых изображений документов
Рассказываем про сервис, чтобы вы понимали его возможности. Воспользоваться им пока что нельзя
«Базовый OCR» подойдёт для случаев, когда вам не нужны структурированные данные из документа, а нужно просто извлечь весь текст. Сервис поможет, когда нужно организовать поиск по большому массиву данных. Например, по книге.
Если вам нужны структурированные данные из документа, воспользуйтесь сервисом «Извлечение данных».
Чтобы воспользоваться сервисом, отправьте POST-запрос на URL https://latest.dbrain.io/basic_ocr
Параметры запроса к API
Асинхронный запрос
async — boolean
Поведение по умолчанию: async=false
— сервис обрабатывает запросы синхронно. При отправке запроса вы получите ответ только после окончательного завершения обработки запроса сервисом.
Если вам нужен асинхронный режим, укажите в запросе async=true
. В таком случае в ответ на запрос сервис вернёт в response body
параметр task_id
. Например:
Используйте этот task_id
, чтобы получить результаты классификации в методе result
:
Не забудьте указать в параметре token
ваш ключ лицензии. Рекомендуем запрашивать метод result
в цикле с периодом 1-2 секунды.
Возврат изображений
return_crops — boolean
Поведение по умолчанию:
false
— сервис не возвращает изображения найденных словtrue
— сервис возвращает изображения найденных слов
Тегирование запроса
task_tags — string array
Поведение по умолчанию: параметр не используется.
Функция тегирует запросы по вашему усмотрению. Это упрощает отслеживание пакетов документов, связанных с конкретным клиентом. Для использования функции, укажите в параметре task_tags
удобный вам тег: task_tags=тэг
Движок извлечения текста
engine — string
Поведение по умолчанию:
i
— основной движок извлечения текста, работает в локальных версиях сервиса. Мы не рекомендуем менять этот параметр без прямого указания от нашей службы поддержки.g
— второй альтернативный движок извлечения текста, работает только в облачной версии решения.
Рукописный текст
handwritten — boolean
Поведение по умолчанию:
false
— сервис ожидает документ, в котором содержится только печатный текстtrue
— сервис ожидает документ, в котором содержатся рукописные символы
Язык извлечения текста
language — string
Поведение по умолчанию:
rus
— русский язык.eng
— английский язык.any
— смесь русского, английского и других языков.
Тело запроса к API
Изображение
image — string ($binary)
Обязательно для передачи в запросе. Сервис ожидает изображение в двоичном виде.
Перед началом работы с сервисами советуем заглянуть в раздел «Общая информация о сервисах». В нём перечислили форматы файлов, которые поддерживают сервисы, описали общие для всех сервисов параметры API и расшифровали коды ошибок.
В ответе на запрос API:
task_id
— string, идентификатор запроса, формат: 32 символа, 16-ричная строкаstatus_code
— integer, дублирует код состояния HTTPsuccess
— boolean, статус выполнения запросаresult
— массив, содержит смысловую часть ответаpages
— массив, содержит страницы документаtext
— массив, содержит весь найденный на странице текстtext
— весь текст на страницеconfidence
— уровень уверенности алгоритма в корректности извлечения всего текста в блоке. Считается как усреднённый уровень уверенности по словамcoords
— координаты текста на документе по четырём точкам: верхний левый угол, верхний правый, нижний левый, нижний правый
blocks
— массив, который содержит найденные на странице блоки текста — например абзацыblock
— текст блокаconfidence
— уровень уверенности алгоритма в корректности извлечения всего текста в блоке, считается как усреднённый уровень уверенности по словамcoords
— координаты блока на странице по четырём точкам: верхний левый угол, верхний правый, нижний левый, нижний правый
words
— массив, содержит найденные на странице словаword
— текст словаconfidence
— уровень уверенности алгоритма в корректности извлечения текста словаcoords
— координаты слова на странице по четырём точкам: верхний левый угол, верхний правый, нижний левый, нижний правыйimage
— изображение слова в формате base64
letters
— массив, который содержит найденные на странице буквыletter
— текст буквыconfidence
— уровень уверенности алгоритма в корректности извлечения текста буквы
input_images
— оригинальное изображение из запроса в формате base64
task_tags
— теги, если они переданы в параметре task_tagstraceback
— сообщение об ошибке, которое содержит информацию о том, где произошла ошибка в коде и какие функции были вызваны перед ней. Это сообщение может помочь разработчикам понять причину возникновения ошибки и исправить ее. Передайте её нашей службе поддержки.pages_count
— число страниц в файле, актуально для PDF и DJVU
Остальные поля не несут практического смысла. Оставили их для совместимости со старыми версиями
Last updated