OCRSpace - OCR an image

Use the OCRSpace - OCR an image action A tool for building the processes, logic, and direction within workflows. Actions are the steps the workflow performs to complete a process. to perform optical character recognition on an image file.

For more information about the OCRSpace connector, go to OCRSpace.

Before you begin: 

Jump to:

Configure the OCRSpace - OCR an image action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add an action to the workflow.

  2. Select a Connection. If you do not have a connection, see Add a connection.
  1. Insert the file variable containing the image File.

OCRSpace - OCR an image action fields and settings

Section

Field

Description

Variable types

(Unlabeled)

Connection Credentials and other settings that enables workflows to communicate with external systems, services, or applications. It's required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.

The OCRSpace connection to use to OCR an image.

To refresh the available connections, click .

(n/a)
  File

The image file to perform OCR (optical character recognition) on.

Note: Your tenancy's default file storage location must be configured to hold files for later reference by the workflow. This location is used for uploaded files and for files stored as output from actions.

File
  Language The language to detect while performing the OCR. If no language is specified, English is used as default. See OCRSpace API language key in the Post Parameters table for the codes to use when using a variable. Text, Decimal, Integer, Boolean, DateTime, Collection
  Overlay If set to Yes, the action returns the coordinates of the bounding boxes for each word. If set to No, the OCR'ed text is returned only as a text block (this makes the JSON response smaller). Overlay data can be used, for example, to show text over the image. Boolean
  File type Overwrites the automatic file type detection based on content-type. Supported image file formats are png, jpg (jpeg), gif, tif (tiff) and bmp. Text, Decimal, Integer, Boolean, DateTime, Collection
  Detection orientation If set to Yes, the API autorotates the image correctly and sets the TextOrientation parameter in the JSON response. If the image is not rotated, then TextOrientation=0, otherwise it is the degree of the rotation, e. g. "270". Boolean
Searchable PDF Searchable PDF If set to Yes, the action generates a searchable PDF. This parameter automatically sets isOverlayRequired = true. Boolean
  Upscale resolution If set to Yes, the API does some internal upscaling. This can improve the OCR result significantly, especially for low-resolution PDF scans. Boolean
  Image contains a table If set to Yes, the OCR logic makes sure that the parsed text result is always returned line by line. This switch is recommended for table OCR, receipt OCR, invoice processing and all other type of input documents that have a table like structure. Boolean
  OCR engine version See OCR Engines. Text, Decimal, Integer, Boolean, DateTime, Collection
Output OCR Result

Stores the result of the action as an object. See OCR Space - API Documentation for information on these values.

The following values are returned:

  • Results: (Collection)
    • Text overlay: (Object)
      • Lines: (Collection)
        • Words: (Collection)
          • Word text: (Text)
          • Left: (Integer
          • Top: (Integer)
          • Height: (Integer)
          • Width: (Integer)
        • Maximum height: (Integer)
        • Minimum top: (Integer)
      • Has overlay: (Boolean)
      • Message: (Text)
    • File parse exit code: (Integer)
    • Parsed text: (Text)
    • Error message: (Text)
    • Error details: (Text)
  • OCR exit code: (Text)
  • Error on processing: (Boolean)
  • Error message: (Text)
  • Error details: (Text)
  • Searchable PDF: (Text)
  • Processing time in milliseconds: (Text)
 Object