OCR Text Detection and Extraction Add-on

Cloudinary is a cloud-based service that provides an end-to-end image and video management solution including uploads, storage, manipulations, optimizations and delivery. It offers a rich set of image manipulation capabilities, including cropping, overlays, graphic improvements, and a large variety of special effects.

The OCR Text Detection and Extraction add-on, powered by the Google Vision API, integrates seamlessly with Cloudinary's upload and manipulation functionality. It extracts all detected text from images, including multi-page documents like TIFFs and PDFs.

You can use the extracted text directly for a variety of purposes, such as organizing or tagging images. Additionally, you can take advantage of special OCR-based transformations, such as blurring, pixelating, or overlaying other images on all detected text with simple transformation parameters. You can also use the add-on to ensure that important texts aren't cut off when you crop your images.

You can use the add-on in normal mode for capturing text elements within a photograph or other graphical image, or in document mode for capturing dense text such as a scan of a document.

The following example uses the normal mode of the OCR add-on to pixelate the license plate text in this car photograph:

Original

Pixelated

URL Ruby PHP Python Node.js Java JS jQuery React Angular .Net Android iOS All

URL:

https://res.cloudinary.com/demo/image/upload/w_1520,h_1440,c_crop,g_west,x_50/e_pixelate_region:15,g_ocr_text/black_car.jpg

Ruby:

cl_image_tag("black_car.jpg", :transformation=>[
  {:width=>1520, :height=>1440, :gravity=>"west", :x=>50, :crop=>"crop"},
  {:effect=>"pixelate_region:15", :gravity=>"ocr_text"}
  ])

PHP:

cl_image_tag("black_car.jpg", array("transformation"=>array(
  array("width"=>1520, "height"=>1440, "gravity"=>"west", "x"=>50, "crop"=>"crop"),
  array("effect"=>"pixelate_region:15", "gravity"=>"ocr_text")
  )))

Python:

CloudinaryImage("black_car.jpg").image(transformation=[
  {'width': 1520, 'height': 1440, 'gravity': "west", 'x': 50, 'crop': "crop"},
  {'effect': "pixelate_region:15", 'gravity': "ocr_text"}
  ])

Node.js:

cloudinary.image("black_car.jpg", {transformation: [
  {width: 1520, height: 1440, gravity: "west", x: 50, crop: "crop"},
  {effect: "pixelate_region:15", gravity: "ocr_text"}
  ]})

Java:

cloudinary.url().transformation(new Transformation()
  .width(1520).height(1440).gravity("west").x(50).crop("crop").chain()
  .effect("pixelate_region:15").gravity("ocr_text")).imageTag("black_car.jpg");

JS:

cloudinary.imageTag('black_car.jpg', {transformation: [
  {width: 1520, height: 1440, gravity: "west", x: 50, crop: "crop"},
  {effect: "pixelate_region:15", gravity: "ocr_text"}
  ]}).toHtml();

jQuery:

$.cloudinary.image("black_car.jpg", {transformation: [
  {width: 1520, height: 1440, gravity: "west", x: 50, crop: "crop"},
  {effect: "pixelate_region:15", gravity: "ocr_text"}
  ]})

React:

<Image publicId="black_car.jpg" >
  <Transformation width="1520" height="1440" gravity="west" x="50" crop="crop" />
  <Transformation effect="pixelate_region:15" gravity="ocr_text" />
</Image>

Angular:

<cl-image public-id="black_car.jpg" >
  <cl-transformation width="1520" height="1440" gravity="west" x="50" crop="crop">
  </cl-transformation>
  <cl-transformation effect="pixelate_region:15" gravity="ocr_text">
  </cl-transformation>
</cl-image>

.Net:

cloudinary.Api.UrlImgUp.Transform(new Transformation()
  .Width(1520).Height(1440).Gravity("west").X(50).Crop("crop").Chain()
  .Effect("pixelate_region:15").Gravity("ocr_text")).BuildImageTag("black_car.jpg")

Android:

MediaManager.get().url().transformation(new Transformation()
  .width(1520).height(1440).gravity("west").x(50).crop("crop").chain()
  .effect("pixelate_region:15").gravity("ocr_text")).generate("black_car.jpg");

iOS:

imageView.cldSetImage(cloudinary.createUrl().setTransformation(CLDTransformation()
  .setWidth(1520).setHeight(1440).setGravity("west").setX(50).setCrop("crop").chain()
  .setEffect("pixelate_region:15").setGravity("ocr_text")).generate("black_car.jpg")!, cloudinary: cloudinary)

This section covers:

Extracting detected text
Blurring or pixelating detected text
Overlaying detected text with images
Text-based cropping
Signed URLs

Extracting detected text

You can return all text detected in an image file in the JSON response of any upload or update call.

The returned content includes a summary of all returned text and the bounding box coordinates of the entire captured text, plus a breakdown of each text element (an individual word or other set of characters without a space) captured and the bounding box of each such text element.

Requesting extracted text (upload/update methods)

To request inclusion of detected text in the response of your upload or update method call, set the ocr parameter to adv_ocr (for photos or images containing text elements) or adv_ocr:document (for best results on text-heavy images such as scanned documents).

For example, when using the upload method:

Ruby PHP Python Node.js Java All

Ruby:

Cloudinary::Uploader.upload("concert_ticket.jpg",  :ocr => "adv_ocr")

PHP:

\Cloudinary\Uploader::upload("concert_ticket.jpg", 
  array("ocr" => "adv_ocr"));

Python:

cloudinary.uploader.upload("concert_ticket.jpg",
  ocr = "adv_ocr")

Node.js:

cloudinary.v2.uploader.upload("concert_ticket.jpg", 
{ ocr: "adv_ocr" },
function(error, result) {console.log(result); });

Java:

cloudinary.uploader().upload("concert_ticket.jpg", 
  ObjectUtils.asMap("ocr", "adv_ocr"));

Or when using the update method:

Ruby PHP Python Node.js Java All

Ruby:

Cloudinary::Api.update ("concert_ticket.jpg", 
  :ocr => "adv_ocr")

PHP:

\Cloudinary\Api::update("concert_ticket.jpg", 
  array("ocr" => "adv_ocr"));

Python:

cloudinary.api.update("concert_ticket.jpg",
  ocr = "adv_ocr")

Node.js:

cloudinary.v2.api.update("concert_ticket.jpg", 
{ ocr: "adv_ocr" },
function(error, result) {console.log(result); });

Java:

cloudinary.api().update("concert_ticket.jpg", 
  ObjectUtils.asMap("ocr", "adv_ocr"));

Extracted text in the JSON response

When you upload an image (or perform an update operation) with the ocr parameter set to adv_ocr or adv_ocr:document, the JSON response includes an ocr node under the info section.

The ocr node of the response includes the following:

The name of the OCR engine used by the add-on (adv_ocr)
The status of the OCR operation
The detected language of the text
The outer bounding rectangle containing all of the detected text
A description listing the entirety of the detected text content, with a newline character (\n) separating groups of text
For multi-page files (e.g. PDFs), a node indicating the containing page
The bounding rectangle of each individual detected text element and the description (text content) of that individual element

For example, an excerpt from the ocr section of the JSON response from a scanned restaurant receipt image may look something like this:

 "info": {
    "ocr": {
      "adv_ocr": {
        "status": "complete",
        "data": [
          {
            "textAnnotations": [
              {
                "locale": "en",
                "boundingPoly": {
                  "vertices": [
                    {
                      "y": 373,
                      "x": 297
                    },
                    {
                      "y": 373,
                      "x": 1306
                    },
                    {
                      "y": 2735,
                      "x": 1306
                    },
                    {
                      "y": 2735,
                      "x": 297
                    }
                  ]
                },
                "description": "CREDIT CARD VOUCHER\nANY RESTAURANT\nANYWHERE\n(69) 
                  69696969\nDATE\n02/02/2014\nTIME\n11:11\nCARD TYPE\nMC\nACCT\n1234 1234 
                  1234 1111\nTRANS KEY\nHYU87 89798234\nAUTH CODE:\n12345\nEXP 
                  DATE:\n12/15\nCHECK:\n1341\nTABLE\n12\nSERVER\n34 
                  MONIKA\nSubtotal\n$1969.69\nGratuity\nTotal\nSignature:\nCustomer Copy\n"
              },
              {
                "boundingPoly": {
                  "vertices": [
                    {
                      "y": 373,
                      "x": 561
                    },
                    {
                      "y": 373,
                      "x": 726
                    },
                    {
                      "y": 426,
                      "x": 726
                    },
                    {
                      "y": 426,
                      "x": 561
                    }
                  ]
                },
                "description": "CREDIT"
              },
              {
                "boundingPoly": {
                  "vertices": [
                    {
            ...
            ...
            ...
    }

Using extracted text to process images

Once you have extracted text in your response, you can access it based on the response structure. For example, in Ruby:

result = Cloudinary::Uploader.upload(some_image_file_path, ocr: 'adv_ocr')

if result['info']['ocr']['adv_ocr']['status'] == 'complete'
  data = result['info']['ocr']['adv_ocr']['data']

Below are a few examples of ways to use the text extracted from an image:

1. Write the detected text to a file:

In the example below, the text extracted from the image is saved in the file system in an image_texts subfolder using the filename result_<public_id>.txt.

if result['info']['ocr']['adv_ocr']['status'] == 'complete'
  data = result['info']['ocr']['adv_ocr']['data']
  texts = data.map{|blocks| 
    annotations = blocks['textAnnotations'] || []
    first_annotation = annotations.first || {}
    (first_annotation['description'] || '').strip
  }.compact.join("\n")
  File.open("image_texts/#{result_['public_id']}.txt", 'w'){|f| f.write(texts)}
end

2. If an image has text, store it in a separate Cloudinary account folder

In the example below, the rename method is used to update the image IDs of images without text to a folder structure using the no_text folder, and changes the public ID's of images with text to an ID in the with_text folder.

if result['info']['ocr']['adv_ocr']['status'] == 'complete'
  data = result['info']['ocr']['adv_ocr']['data']
  folder = data.all?{|i| i.empty?} ?  'no_text' : 'with_text'
  Cloudinary::Uploader.rename(
    result['public_id'], # from_public_id
    "#{folder}/#{result['public_id']}" # to_public_id
  )
end

3. Tag images with specific words if detected

For example, for each resume scanned into a career site, check whether the words "Cloudinary", "MBA", or "algorithm" appear. If so, tag the resume file with the relevant keywords.

TAGS = %w(Cloudinary MBA algorithm).freeze
if result['info']['ocr']['adv_ocr']['status'] == 'complete'
  data = result['info']['ocr']['adv_ocr']['data']
  texts = data.map{|blocks| 
    annotations = blocks['textAnnotations'] || []
    first_annotation = annotations.first || {}
    (first_annotation['description'] || '').strip
  }.compact.join(" ")
  tags = TAGS.select{|tag| texts =~ /\b#{tag}\b/i}
  unless tags.empty?
    Cloudinary::Uploader.explicit(result['public_id'], type: 'upload', tags: tags)
  end
end

Blurring or pixelating detected text

Many images may have text, such as phone numbers, web site addresses, license plates, or other personal or commercial data, that you don't want visible in your delivered images. To blur or pixelate all detected text in an image, you can use Cloudinary's built-in pixelate_region or blur_region effect with the gravity parameter set to ocr_text. For example, we've blurred out the brand and model names on this smartphone:

Original

Blur branding texts

URL Ruby PHP Python Node.js Java JS jQuery React Angular .Net Android iOS All

URL:

https://res.cloudinary.com/demo/image/upload/e_blur_region:800,g_ocr_text/smartphone2.jpg

Ruby:

cl_image_tag("smartphone2.jpg", :effect=>"blur_region:800", :gravity=>"ocr_text")

PHP:

cl_image_tag("smartphone2.jpg", array("effect"=>"blur_region:800", "gravity"=>"ocr_text"))

Python:

CloudinaryImage("smartphone2.jpg").image(effect="blur_region:800", gravity="ocr_text")

Node.js:

cloudinary.image("smartphone2.jpg", {effect: "blur_region:800", gravity: "ocr_text"})

Java:

cloudinary.url().transformation(new Transformation().effect("blur_region:800").gravity("ocr_text")).imageTag("smartphone2.jpg");

JS:

cloudinary.imageTag('smartphone2.jpg', {effect: "blur_region:800", gravity: "ocr_text"}).toHtml();

jQuery:

$.cloudinary.image("smartphone2.jpg", {effect: "blur_region:800", gravity: "ocr_text"})

React:

<Image publicId="smartphone2.jpg" >
  <Transformation effect="blur_region:800" gravity="ocr_text" />
</Image>

Angular:

<cl-image public-id="smartphone2.jpg" >
  <cl-transformation effect="blur_region:800" gravity="ocr_text">
  </cl-transformation>
</cl-image>

.Net:

cloudinary.Api.UrlImgUp.Transform(new Transformation().Effect("blur_region:800").Gravity("ocr_text")).BuildImageTag("smartphone2.jpg")

Android:

MediaManager.get().url().transformation(new Transformation().effect("blur_region:800").gravity("ocr_text")).generate("smartphone2.jpg");

iOS:

imageView.cldSetImage(cloudinary.createUrl().setTransformation(CLDTransformation().setEffect("blur_region:800").setGravity("ocr_text")).generate("smartphone2.jpg")!, cloudinary: cloudinary)

Tip

When blurring or pixelating to hide content, you may want to take advantage of one of the access control options to prevent users from accessing the non-blurred or non-pixelated versions of the image.

Overlaying detected text with images

Overlaying an image based on OCR text detection is similar to the process for overlaying images in other scenarios: you specify the image to overlay, the width of the overlay, and the gravity (location) for the overlay. When you specify ocr_text as the gravity, each detected text element is automatically covered with the specified image.

In most cases, it works best to specify a relative width instead of an absolute width for the overlay. The relative width adjusts the size of the overlay image relative to the size of the detected text element. To do this, just add the fl_region_relative flag to your transformation, and specify the width of the overlay image as a percentage (1.0 = 100%) of the text element.

For example, suppose you run a real estate website where individuals or companies can list homes for sale. For revenue recognition purposes, it's important that the listings do not display private phone numbers or those of other real estate organizations. So instead, you overlay an image with your site's contact information that covers any detected text in the uploaded images.

URL Ruby PHP Python Node.js Java JS jQuery React Angular .Net Android iOS All

URL:

https://res.cloudinary.com/demo/image/upload/l_call_text,fl_region_relative,w_1.1,g_ocr_text/home_4_sale.jpg

Ruby:

cl_image_tag("home_4_sale.jpg", :overlay=>"call_text", :flags=>"region_relative", :width=>1.1, :gravity=>"ocr_text")

PHP:

cl_image_tag("home_4_sale.jpg", array("overlay"=>"call_text", "flags"=>"region_relative", "width"=>1.1, "gravity"=>"ocr_text"))

Python:

CloudinaryImage("home_4_sale.jpg").image(overlay="call_text", flags="region_relative", width=1.1, gravity="ocr_text")

Node.js:

cloudinary.image("home_4_sale.jpg", {overlay: "call_text", flags: "region_relative", width: "1.1", gravity: "ocr_text"})

Java:

cloudinary.url().transformation(new Transformation().overlay(new Layer().publicId("call_text")).flags("region_relative").width(1.1).gravity("ocr_text")).imageTag("home_4_sale.jpg");

JS:

cloudinary.imageTag('home_4_sale.jpg', {overlay: new cloudinary.Layer().publicId("call_text"), flags: "region_relative", width: "1.1", gravity: "ocr_text"}).toHtml();

jQuery:

$.cloudinary.image("home_4_sale.jpg", {overlay: new cloudinary.Layer().publicId("call_text"), flags: "region_relative", width: "1.1", gravity: "ocr_text"})

React:

<Image publicId="home_4_sale.jpg" >
  <Transformation overlay="call_text" flags="region_relative" width="1.1" gravity="ocr_text" />
</Image>

Angular:

<cl-image public-id="home_4_sale.jpg" >
  <cl-transformation overlay="call_text" flags="region_relative" width="1.1" gravity="ocr_text">
  </cl-transformation>
</cl-image>

.Net:

cloudinary.Api.UrlImgUp.Transform(new Transformation().Overlay(new Layer().PublicId("call_text")).Flags("region_relative").Width(1.1).Gravity("ocr_text")).BuildImageTag("home_4_sale.jpg")

Android:

MediaManager.get().url().transformation(new Transformation().overlay(new Layer().publicId("call_text")).flags("region_relative").width(1.1).gravity("ocr_text")).generate("home_4_sale.jpg");

iOS:

imageView.cldSetImage(cloudinary.createUrl().setTransformation(CLDTransformation().setOverlay("call_text").setFlags("region_relative").setWidth(1.1).setGravity("ocr_text")).generate("home_4_sale.jpg")!, cloudinary: cloudinary)

Original sign

Sign with your text overlay

Text-based cropping

When you want to be sure that text in an image is retained during a crop transformation, you can specify ocr_text as the gravity (g_ocr_text in URLs).

For example, the following example demonstrates what happens to the itsSnacktime.com text in the picture below if you crop it to a square with default (center gravity) cropping, auto gravity cropping, or ocr_text gravity cropping:

Original

default gravity
(centered)

auto gravity
(focus on most prominent elements)

ocr_text gravity
(focus on text regionss)

The transformation code for the last image looks like this:

URL Ruby PHP Python Node.js Java JS jQuery React Angular .Net Android iOS All

URL:

https://res.cloudinary.com/demo/image/upload/c_fill,g_ocr_text,h_250,w_250/snacktime.jpg

Ruby:

cl_image_tag("snacktime.jpg", :gravity=>"ocr_text", :height=>250, :width=>250, :crop=>"fill")

PHP:

cl_image_tag("snacktime.jpg", array("gravity"=>"ocr_text", "height"=>250, "width"=>250, "crop"=>"fill"))

Python:

CloudinaryImage("snacktime.jpg").image(gravity="ocr_text", height=250, width=250, crop="fill")

Node.js:

cloudinary.image("snacktime.jpg", {gravity: "ocr_text", height: 250, width: 250, crop: "fill"})

Java:

cloudinary.url().transformation(new Transformation().gravity("ocr_text").height(250).width(250).crop("fill")).imageTag("snacktime.jpg");

JS:

cloudinary.imageTag('snacktime.jpg', {gravity: "ocr_text", height: 250, width: 250, crop: "fill"}).toHtml();

jQuery:

$.cloudinary.image("snacktime.jpg", {gravity: "ocr_text", height: 250, width: 250, crop: "fill"})

React:

<Image publicId="snacktime.jpg" >
  <Transformation gravity="ocr_text" height="250" width="250" crop="fill" />
</Image>

Angular:

<cl-image public-id="snacktime.jpg" >
  <cl-transformation gravity="ocr_text" height="250" width="250" crop="fill">
  </cl-transformation>
</cl-image>

.Net:

cloudinary.Api.UrlImgUp.Transform(new Transformation().Gravity("ocr_text").Height(250).Width(250).Crop("fill")).BuildImageTag("snacktime.jpg")

Android:

MediaManager.get().url().transformation(new Transformation().gravity("ocr_text").height(250).width(250).crop("fill")).generate("snacktime.jpg");

iOS:

imageView.cldSetImage(cloudinary.createUrl().setTransformation(CLDTransformation().setGravity("ocr_text").setHeight(250).setWidth(250).setCrop("fill")).generate("snacktime.jpg")!, cloudinary: cloudinary)

Signed URLs

Cloudinary's dynamic image manipulation URLs are powerful tools for agile web and mobile development. However, due to the potential costs of your customers accessing unplanned dynamic URLs that apply the OCR text detection or extraction functionality, image manipulation add-on URLs are required (by default) to be signed using Cloudinary's authenticated API or, alternatively, you can eagerly generate the requested derived images using Cloudinary's authenticated API.

To create a signed Cloudinary URL, set the sign_url parameter to true when building a URL or creating an image tag.

For example, to generate a signed URL when applying a blur effect on the text of an image:

Ruby PHP Python Node.js Java JS jQuery React Angular .Net Android iOS All

Ruby:

cl_image_tag("smartphone2.jpg", :effect=>"blur_region:800", :gravity=>"ocr_text", :sign_url=>true)

PHP:

cl_image_tag("smartphone2.jpg", array("effect"=>"blur_region:800", "gravity"=>"ocr_text", "sign_url"=>true))

Python:

CloudinaryImage("smartphone2.jpg").image(effect="blur_region:800", gravity="ocr_text", sign_url=True)

Node.js:

cloudinary.image("smartphone2.jpg", {effect: "blur_region:800", gravity: "ocr_text", sign_url: true})

Java:

cloudinary.url().transformation(new Transformation().effect("blur_region:800").gravity("ocr_text")).signed(true).imageTag("smartphone2.jpg");

JS:

cloudinary.imageTag('smartphone2.jpg', {effect: "blur_region:800", gravity: "ocr_text", signUrl: true}).toHtml();

jQuery:

$.cloudinary.image("smartphone2.jpg", {effect: "blur_region:800", gravity: "ocr_text"})

React:

<Image publicId="smartphone2.jpg" signUrl="true">
  <Transformation effect="blur_region:800" gravity="ocr_text" />
</Image>

Angular:

<cl-image public-id="smartphone2.jpg" sign-url="true">
  <cl-transformation effect="blur_region:800" gravity="ocr_text">
  </cl-transformation>
</cl-image>

.Net:

cloudinary.Api.UrlImgUp.Transform(new Transformation().Effect("blur_region:800").Gravity("ocr_text")).Signed(true).BuildImageTag("smartphone2.jpg")

Android:

MediaManager.get().url().transformation(new Transformation().effect("blur_region:800").gravity("ocr_text")).signed(true).generate("smartphone2.jpg");

iOS:

imageView.cldSetImage(cloudinary.createUrl().setTransformation(CLDTransformation().setEffect("blur_region:800").setGravity("ocr_text")).generate("smartphone2.jpg", signUrl: true)!, cloudinary: cloudinary)

The generated Cloudinary URL shown below includes a signature component (/s--BDoTEjNU--/). Only URLs with a valid signature that matches the requested image manipulation will be approved for on-the-fly image manipulation and delivery.

https://res.cloudinary.com/demo/image/upload/s--BDoTEjNU--/e_blur_region:800,g_ocr_text/smartphone2.jpg

For more details on signed URLs, see Signed delivery URLs.

Notes

You can optionally remove the signed URL default requirement for a particular add-on by selecting it in the Allow unsigned add-on transformations section of the Security account settings in the Cloudinary console.
No OCR mechanism can identify 100% of the text in all images. The results may be affected by things like font, color, contrast between text and background, text angle, and more.
The OCR engine requires images with a minimum resolution of 1024 X 768.