Abbyy OCR

UiPath.Abbyy.Activities.AbbyyOCR

note

The UiPath.Abbyy.Activities package has been deprecated and is currently out of support. Also, the package is unlisted from the UiPath Studio Manage Packages official feed. Check the Deprecation timeline for more details.

Extracts a string and its information from an indicated UI element or an image using Abbyy OCR Engine. It can be used with other OCR activities (Click OCR Text, Hover OCR Text, Get OCR Text, Find OCR Text Position.

note

If you want to use this OCR activity from package UiPath.Abbyy.Activities v1.5.0 in Studio v19.10, please install the UiPath.CoreIPC package, version 2.0.1 or higher."

note

ABBYY FineReader Engine SDK is required. The engine only works with a license distributed by the UiPath sales department. For more information on this, go here.

Properties

Common

• DisplayName - The display name of the activity.

Input

• Image - The image that you want to process. This field supports only Image variables.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Options

• CorrectOrientation - If selected, the page orientation is detected by the engine, and if needed, is corrected automatically. By default, this check box is selected.
• CorrectSkew - Detects whether the page is skewed and automatically corrects it. The drop-down contains three options, Auto - deskews only images that are detected as being skewed, Yes - forces deskew on all pages, No - does not automatically deskew pages. By default, this property is set to Auto.
• CustomRecognitionProfilePath - The full path to a custom built Recognition Profile. This field supports only strings and String variables.
• ExtractWords - If this check box is selected, the on-screen position of each detected word is extracted.
• FineReaderVersion - Specifies which version of the Fine Reader Engine is to be used. The options are FineReaderEngine 11 and FineReaderEngine 12. By default, this property is set to FineReaderEngine 11.
• Language - The language used by the OCR engine to extract the text from the UI element or image. The ABBYY FineReader Engine includes the majority of supported OCR languages by default. They can be used right after a successful installation of the engine. The full language name must be written, such as "english", "japanese", "romanian".
• PredefinedRecognitionProfile - Specifies the Predefined Recognition Profile that is to be used when processing an image. This field supports only strings and String variables. For a list of predefined profiles, view the Predefined Recognition Profiles table.
• Profile - Choose a preprocessing profile for the specified image or UI element to achieve a better OCR read. The following options are available: None - does not apply a preprocessing profile; Screen - preprocessing suitable for remote desktop applications; Scan - preprocessing suitable for scanned files; Legacy - uses the engine's default settings for preprocessing images. The default option is Legacy.
• Scale - The scaling factor of the selected UI element or image. The higher the number is, the more you enlarge the image. This can provide a better OCR read and it is recommended with small images. If you want to scale down, values between 0 and 1 are also accepted. By default, the value is 1.

Output

• Confidence - The resulting confidence score, stored in an Int32 variable. This field supports only Int32 variables.
• Result - The extracted words along with their on-screen position. This field supports only KeyValuePair <rectangle,string> variables.
• Text - The extracted text. This field supports only String variables.

Predefined Recognition Profiles

Recognition Profile	Description
DocumentConversion_Accuracy	For converting documents into editable formats, optimized for accuracy.
DocumentConversion_Speed	For converting documents into editable formats, optimized for speed.
DocumentArchiving_Accuracy	For creating a digital archive, optimized for accuracy.
DocumentArchiving_Speed	For creating a digital archive, optimized for speed.
BookArchiving_Accuracy	For creating an electronic library, optimized for accuracy.
BookArchiving_Speed	For creating an electronic library, optimized for speed.
TextExtraction_Accuracy	For extracting text from documents, optimized for accuracy.
TextExtraction_Speed	For extracting text from documents, optimized for speed.
FieldLevelRecognition	For recognizing short text fragments.
BarcodeRecognition_Accuracy	For extracting barcodes, optimized for accuracy; can also be called under the BarcodeRecognition name.
BarcodeRecognition_Speed	For extracting barcodes, optimized for speed.
HighCompressedImageOnlyPdf	For creating high-compressed PDF files which contain entire documents saved as pictures.
BusinessCardsProcessing	For recognizing business cards.
EngineeringDrawingsProcessing	For recognizing technical drawings, with text arranged in different directions.
Version9Compatibility	Provided for compatibility, sets the processing parameters to the default values of ABBYY FineReader Engine 9.0.