# Abbyy Document OCR

> `UiPath.AbbyyEmbedded.Activities.AbbyyDocumentOCR`

`UiPath.AbbyyEmbedded.Activities.AbbyyDocumentOCR`

:::important
The UiPath.AbbyyEmbedded.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](https://docs.uipath.com/overview/other/latest/overview/deprecation-timeline#deprecated-features-or-capabilities) for more details.
:::

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

Extracts a string and associated information about the textual content of document images using Abbyy OCR Engine. The activity can be used in any document scenario in which an OCR engine is needed, for instance, the **Digitize Document** activity or the **Read PDF With OCR** activity.

:::note
Abbyy Document OCR requires your Robot to be connected to an Orchestrator instance that has ABBYY FRE12 units available.This activity is only compatible with Orchestrator 20.10 or above
:::

## 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**

* **CustomRecognitionProfilePath** - Specifies the full path to a custom built Recognition Profile. This field supports only strings and `String` variables.
* **EnginePack** - Provides the embedded engine that needs to be used from the two available options. The **Basic** EnginePack contains support for most of the languages except those with CJK characters. The **CJK** EnginePack contains support for Chinese, Japanese, and Korean language
* **ExtractWords** - If selected, the on-screen position of each detected word is extracted.
* **Language** - The language used by the OCR engine to extract the text from the UI element or image. The language name must be fully written, such as "English", "Japanese", "Romanian". The default value is `"English"`. If you want to use one of the following languages **ChinesePRC**, **ChineseTaiwan**, **Japanese**, **Korean**, and **KoreanHangul** you need to install a separate bundle package available in the **Manage Packages** menu.
* **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 text extracted by the OCR engine along with their on-screen position, stored in a `KeyValuePair<Rectangle,String>`. This field supports only `KeyValuePair<Rectangle,String>`.
* **Text** - The text extracted by the OCR engine, stored in a String variable. This field supports only `String` variables.

| **Supported Languages** |
| --- |
| Abkhaz |
| Adyghe |
| Afrikaans |
| Agul |
| Albanian |
| Altaic |
| Arabic |
| ArmenianEastern |
| ArmenianGrabar |
| ArmenianWestern |
| Awar |
| Aymara |
| AzeriCyrillic |
| AzeriLatin |
| Bashkir |
| Basque |
| Belarusian |
| Bemba |
| Blackfoot |
| Breton |
| Bugotu |
| Bulgarian |
| Burmese |
| Buryat |
| Catalan |
| Chamorro |
| Chechen |
| Chukcha |
| Chuvash |
| Corsican |
| CrimeanTatar |
| Croatian |
| Crow |
| Czech |
| Danish |
| Dargwa |
| Digits |
| Dungan |
| Dutch |
| DutchBelgian |
| English |
| EskimoCyrillic |
| EskimoLatin |
| Esperanto |
| Estonian |
| Even |
| Evenki |
| Faeroese |
| Farsi |
| Fijian |
| Finnish |
| French |
| Frisian |
| Friulian |
| GaelicScottish |
| Gagauz |
| Galician |
| Ganda |
| German |
| GermanLuxembourg |
| GermanNewSpelling |
| Greek |
| Guarani |
| Hani |
| Hausa |
| Hawaiian |
| Hebrew |
| Hungarian |
| Icelandic |
| Ido |
| Indonesian |
| Ingush |
| Interlingua |
| Irish |
| Italian |
| Kabardian |
| Kalmyk |
| KarachayBalkar |
| Karakalpak |
| Kasub |
| Kawa |
| Kazakh |
| Khakas |
| Khanty |
| Kikuyu |
| Kirgiz |
| Kongo |
| Koryak |
| Kpelle |
| Kumyk |
| Kurdish |
| Lak |
| Lappish |
| Latvian |
| Lezgin |
| Lithuanian |
| Luba |
| Macedonian |
| Malagasy |
| Malay |
| Malinke |
| Maltese |
| Mansi |
| Maori |
| Mari |
| Maya |
| Miao |
| Minankabaw |
| Mohawk |
| Mongol |
| Mordvin |
| Nahuatl |
| Nenets |
| Nivkh |
| Nogay |
| NorwegianBokmal |
| NorwegianNynorsk |
| Nyanja |
| Occidental |
| Ojibway |
| Ossetic |
| Papiamento |
| PidginEnglish |
| Polish |
| PortugueseStandard |
| PortugueseBrazilian |
| Provencal |
| Quechua |
| RhaetoRomanic |
| Romanian |
| RomanianMoldavia |
| Romany |
| Ruanda |
| Rundi |
| Russian |
| RussianWithAccent |
| Samoan |
| Selkup |
| Serbian |
| SerbianCyrillic |
| SerbianLatin |
| Shona |
| Sioux |
| Slovak |
| Slovenian |
| Somali |
| Sorbian |
| Sotho |
| Spanish |
| Sunda |
| Swahili |
| Swazi |
| Swedish |
| Tabassaran |
| Tagalog |
| Tahitian |
| Tajik |
| Tatar |
| Thai |
| Tinpo |
| Tongan |
| Tswana |
| Tun |
| Turkish |
| Turkmen |
| TurkmenLatin |
| Tuvin |
| Udmurt |
| UighurCyrillic |
| UighurLatin |
| Ukrainian |
| UzbekCyrillic |
| UzbekLatin |
| Vietnamese |
| Visayan |
| Welsh |
| Wolof |
| Xhosa |
| Yakut |
| Yiddish |
| Zapotec |
| Zulu |

| **CJK Languages Bundle** |
| --- |
| ChinesePRC |
| ChineseTaiwan |
| Japanese |
| Korean |
| KoreanHangul |