activities

latest

false

Overview
- About the Document Understanding activities
Document Processing Contracts
- Release notes
- About the Document Processing Contracts
- Classes
  - Box Class
  - IPersistedActivity interface
  - PrettyBoxConverter Class
  - IClassifierActivity Interface
  - IClassifierCapabilitiesProvider Interface
  - ClassifierDocumentType Class
  - ClassifierResult Class
  - ClassifierCodeActivity Class
  - ClassifierNativeActivity Class
  - ClassifierAsyncCodeActivity Class
  - ClassifierDocumentTypeCapability Class
  - ContentValidationData Class
  - EvaluatedBusinessRulesForFieldValue Class
  - EvaluatedBusinessRuleDetails Class
  - ExtractorAsyncCodeActivity Class
  - ExtractorCodeActivity Class
  - ExtractorDocumentType Class
  - ExtractorDocumentTypeCapabilities Class
  - ExtractorFieldCapability Class
  - ExtractorNativeActivity Class
  - ExtractorResult Class
  - FieldValue Class
  - FieldValueResult Class
  - ICapabilitiesProvider Interface
  - IExtractorActivity Interface
  - ExtractorPayload Class
  - DocumentActionPriority Enum
  - DocumentActionData Class
  - DocumentActionStatus Enum
  - DocumentActionType Enum
  - DocumentClassificationActionData Class
  - DocumentValidationActionData Class
  - UserData Class
  - Document Class
  - DocumentSplittingResult Class
  - DomExtensions Class
  - Page Class
  - PageSection Class
  - Polygon Class
  - PolygonConverter Class
  - Metadata Class
  - WordGroup Class
  - Word Class
  - ProcessingSource Enum
  - ResultsTableCell Class
  - ResultsTableValue Class
  - ResultsTableColumnInfo Class
  - ResultsTable Class
  - Rotation Enum
  - Rule Class
  - RuleResult Class
  - RuleSet Class
  - RuleSetResult Class
  - SectionType Enum
  - WordGroupType Enum
  - IDocumentTextProjection Interface
  - ClassificationResult Class
  - ExtractionResult Class
  - ResultsDocument Class
  - ResultsDocumentBounds Class
  - ResultsDataPoint Class
  - ResultsValue Class
  - ResultsContentReference Class
  - ResultsValueTokens Class
  - ResultsDerivedField Class
  - ResultsDataSource Enum
  - ResultConstants Class
  - SimpleFieldValue Class
  - TableFieldValue Class
  - DocumentGroup Class
  - DocumentTaxonomy Class
  - DocumentType Class
  - Field Class
  - FieldType Enum
  - FieldValueDetails Class
  - LanguageInfo Class
  - MetadataEntry Class
  - TextType Enum
  - TypeField Class
  - ITrackingActivity Interface
  - ITrainableActivity Interface
  - ITrainableClassifierActivity Interface
  - ITrainableExtractorActivity Interface
  - TrainableClassifierAsyncCodeActivity Class
  - TrainableClassifierCodeActivity Class
  - TrainableClassifierNativeActivity Class
  - TrainableExtractorAsyncCodeActivity Class
  - TrainableExtractorCodeActivity Class
  - TrainableExtractorNativeActivity Class
  - BasicDataPoint Class - preview
  - ExtractionResultHandler Class - preview
Document Understanding ML
- Release notes
Document Understanding OCR Local Server
- Release notes
- About the Document Understanding OCR Local Server package
- Project Compatibility
Document Understanding
- Release notes
- About the Document Understanding activity package
- Project compatibility
- Document data
  - Methods
- Configuring external connection
- Activities
  - Set PDF Password
  - Merge PDFs
  - Get PDF Page Count
  - Extract PDF Text
  - Extract PDF Images
  - Extract PDF Page Range
  - Extract Document Data
  - Create Validation Task and Wait
  - Wait for Validation Task and Resume
  - Create Validation Task
  - Classify Document
  - Create Classification Validation Task
  - Create Classification Validation Task and Wait
  - Wait for Classification Validation Task and Resume
- Document Understanding Activities how-to guides
  - Create Pre-Hire in Workday Based on CV
  - Generative extractor - Good practices
  - Generative classifier - Good practices
Intelligent OCR
- Release notes
- About the IntelligentOCR activity package
- Project compatibility
- Activities
  - Load Taxonomy
  - Digitize Document
  - Classify Document Scope
  - Keyword Based Classifier
  - Document Understanding Project Classifier
  - Intelligent Keyword Classifier
  - Present Classification Station
    - Using the Classification Station
  - Create Document Classification Action
  - Create Document Validation Artifacts
  - Retrieve Document Validation Artifacts
  - Wait For Document Classification Action And Resume
  - Train Classifiers Scope
  - Keyword Based Classifier Trainer
  - Intelligent Keyword Classifier Trainer
  - Data Extraction Scope
  - Document Understanding Project Extractor
  - Document Understanding Project Extractor Trainer
  - RegEx Based Extractor
  - Form Extractor
  - Intelligent Form Extractor
  - Present Validation Station
    - Classic Validation Station
    - Compact Validation Station
  - Redact Document
  - Create Document Validation Action
  - Wait For Document Validation Action And Resume
  - Train Extractors Scope
  - Export Extraction Results
  - Machine Learning Extractor
  - Machine Learning Extractor Trainer
  - Machine Learning Classifier
  - Machine Learning Classifier Trainer
  - Generative Classifier
  - Generative Extractor
- Configuring Authentication
- IntelligentOCR how-to guides
  - Validating documents with App actions
  - Manual validation for digitize documents
  - Anchor-based data extraction using Intelligent Form Extractor
  - Validation station
  - Generative activities - Good practices
  - Generative extractor - Good practices
  - Generative classifier - Good practices
ML Services
- Release notes
- About the ML Services activity package
- Project compatibility
- Activities
  - ML Skill
  - Upload File
  - Create Labeling Task
OCR
- Release notes
- About the OCR activity package
- Project compatibility
- Activities
  - UiPath Screen OCR
  - UiPath Document OCR
  - UiPath Chinese, Japanese, Korean OCR
  - UiPath Extended Languages OCR
OCR Contracts
- Release notes
- About the OCR Contracts
- Project compatibility
- Classes
  - IOCRActivity Interface
  - OCRAsyncCodeActivity Class
  - OCRCodeActivity Class
  - OCRNativeActivity Class
  - Character Class
  - OCRResult Class
  - Word Class
  - FontStyles Enum
  - OCRRotation Enum
  - OCRCapabilities Class
  - OCRScrapeBase Class
  - OCRScrapeFactory Class
  - ScrapeControlBase Class
  - ScrapeEngineUsages Enum
  - ScrapeEngineBase
  - ScrapeEngineFactory Class
  - ScrapeEngineProvider Class
OmniPage
- Release notes
- About the OmniPage activity package
- Project compatibility
- Activities
  - OmniPage OCR
- OmniPage how-to guides
  - Using OmniPage with an extended language
PDF
- Release notes
- About the PDF activity package
- Project compatibility
- Activities
  - Get PDF Page Count
  - Read PDF Text
  - Read PDF With OCR
  - Read XPS Text
  - Read XPS With OCR
  - Export PDF Page As Image
  - Extract Images From PDF
  - Extract PDF Page Range
  - Join PDF Files
  - Manage PDF Password
- PDF how-to guides
  - Read PDF files
  - Read XPS files
[Unlisted] Abbyy
- Release notes
- About the Abbyy activity package
- Project compatibility
- Activities
  - Abbyy OCR
  - Abbyy Cloud OCR
  - FlexiCapture Classifier
  - FlexiCapture Extractor
  - FlexiCapture Scope
  - Classify Document
  - Process Document
  - Validate Document
  - Export Document
  - Get Field
  - Get Table
  - Prepare Validation Station Data
[Unlisted] Abbyy Embedded
- Release notes
- About the Abbyy Embedded activity package
- Project compatibility
- Activities
  - Abbyy Screen OCR
  - Abbyy Document OCR

Document Understanding Activities

Last updated Apr 1, 2026

UiPath Screen OCR

UiPath.OCR.Activities.UiPathScreenOCR

Description

Extracts a string and associated information about the textual content of images. The UiPath Screen OCR activity is optimized for usage on screen images. The activity can be used in any UI Automation scenario in which an OCR engine is needed.

Note: UiPath Screen OCR is available as a cloud service as well as part of the on-premises Linux Computer Vision.

Supported list of characters

The UiPath Screen OCR activity only supports the following list of characters:

! \ " # ¥ € £ $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ \ ] _ a b c d e f g h i j k l m n o p q r s t u v w x y z { | } ~

Project compatibility

Windows-Legacy | Windows

Configuration

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 Screen OCR (not required for the Preview period).
Endpoint - The endpoint for UiPath Screen OCR. The default project settings value is https://ocr.uipath.com.
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).

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 False.
Important: To use local server mode, you need to install the UiPath.ComputerVision.LocalServer package version 21.6 or higher.
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.

On this page

Description
Supported list of characters
Project compatibility
Configuration

Was this page helpful?

PREVIOUSActivities

NEXTUiPath Document OCR