Subscribe

UiPath Activities

The UiPath Activities Guide

21.6 UiPath Document OCR -Preview

Release Date: 24 June 2021 | Version: 3.1.0-preview

UiPath.OCR.Activities.UiPathDocumentOCR

Extracts a string and associated information about the textual content of document images. The UiPath Document OCR activity is optimized for usage on scanned documents and images of documents. 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.

Properties

Common

  • DisplayName - The display name of the activity.

Input

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

Logon

  • ApiKey - The API key used to provide you access to the UiPath Document OCR (not required for the Preview period).
  • Endpoint - The endpoint for UiPath Document OCR. This field supports only String variables. For more information, see Document Understanding Public Endpoints.

📘

Note:

More information about AI Center configuration can be found here.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  • UseLocalServer - Determines if a local server should be used. This field only supports Boolean values (True, False). The default value is none.

🚧

Warning!

To use local server mode, you need to install the UiPath.DocumentUnderstanding.OCR.LocalServer package.

Output

  • Result - Provides the extracted words along with their on-screen position. This field supports only KeyValuePair<Rectangle,String> variables.
  • Text - Provides the extracted text. This field supports only String variables.

Updated 2 months ago


21.6 UiPath Document OCR -Preview


Release Date: 24 June 2021 | Version: 3.1.0-preview

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.