Skip to main content

UiPath Document OCR

UiPath.OCR.Activities.UiPathDocumentOCR

Description​

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.

You can use the UiPath Document OCR activity to extract information from any document that has handwritten text, printed text, signatures, and check boxes.

Project compatibility​

Windows-Legacy | Windows

Properties​

Properties panel​

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. Visit API Key for more information about retrieving the API Key.
  • Endpoint - The endpoint for UiPath Document OCR. This field supports only String variables. For more information, visit Document Understanding Public Endpoints.
  • Timeout (milliseconds) - Specifies the amount of time (in milliseconds) to wait for a response from the server before an error is thrown. The default value is 100000 milliseconds (100 seconds).
    note

    Visit OCR Services for more information about Document Understanding configuration.

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.
    important

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

  • UseSeparateOcrProcess - If set to true, new OCR processes are created depending on the configured scheduler. The parameter is ignoored if local server is used and the processes will be used.

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.