activities
latest
false
- Overview
- Document Processing Contracts
- Release notes
- About the Document Processing Contracts
- Box Class
- IPersistedActivity interface
- PrettyBoxConverter Class
- IClassifierActivity Interface
- IClassifierCapabilitiesProvider Interface
- ClassifierDocumentType Class
- ClassifierResult Class
- ClassifierCodeActivity Class
- ClassifierNativeActivity Class
- ClassifierAsyncCodeActivity Class
- ClassifierDocumentTypeCapability Class
- ExtractorAsyncCodeActivity Class
- ExtractorCodeActivity Class
- ExtractorDocumentType Class
- ExtractorDocumentTypeCapabilities Class
- ExtractorFieldCapability Class
- ExtractorNativeActivity Class
- ExtractorResult 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
- 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
- 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
- Document Understanding Digitizer
- Document Understanding ML
- 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
- 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
- Intelligent OCR
- Release notes
- About the IntelligentOCR activity package
- Project compatibility
- Configuring Authentication
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Document Understanding Project Classifier
- Intelligent Keyword Classifier
- Create Document Classification Action
- 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
- RegEx Based Extractor
- Form Extractor
- Intelligent Form Extractor
- Present Validation Station
- Create Document Validation Action
- Wait For Document Validation Action And Resume
- Train Extractors Scope
- Export Extraction Results
- ML Services
- OCR
- OCR Contracts
- Release notes
- About the OCR Contracts
- Project compatibility
- 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
- PDF
- [Unlisted] Abbyy
- [Unlisted] Abbyy Embedded
Document Understanding Activities
Last updated Nov 21, 2024
About the Document Understanding OCR Local Server package
The UiPath.DocumentUnderstanding.OCR.LocalServer package contains no activities, but once installed in a project, it enables you to use UiPath Document OCR running locally on the robot machine.
You can install the package via Manager Packages in Studio. Visit Install a Package for instructions on how to install a package.
Once this package is installed, the UiPath Document OCR activity can be configured via the UseLocalServer property to use this local server. This allows you to run UiPath Document OCR right on the robot as part of a Studio workflow without calling out to an API or a service.
Note: The UiPath.DocumentUnderstanding.OCR.LocalServer.Activities package is compatible with UiPath.OCR.Activites version 3.1.0-preview
and higher.
Key features
- Ease of use - You don't need to be concerned about having an Automation Cloud account, an API Key, a URL, or about the internet network connection
- It does not require additional infrastructure - You do not depend on AI Center, on an On-Prem server, or some additional hardware to provision, so you can use Document Understanding directly on the machine that is installed on, without requiring other external resources
- It allows you to scale your automation by adding robots - When the OCR runs server-side you have to scale the server, so you add more CPUs, more GPUs, more nodes, etc., whereas if the OCR runs in the robot you just add more robots and process more documents. This is particularly important because the OCR is very often the resource bottleneck in document processing workflows as it is the most compute-intensive step, much more than the document extraction itself because the document extraction works on the output of the OCR which is just text, whereas the OCR operates on the pixels of the image.
Differences compared to service deployment
Check the following differences between local server and service deployment:
- LocalServer speed depends on Robot machine capabilities.
- There may be small differences between OCR results using UseLocalServer and results using the cloud endpoint (https://du.uipath.com/ocr) or On-Premises docker based deployments.
Hardware requirements
Check the following list of hardware requirements for local server:
- LocalServer requires CPU supporting AVX2 instruction set. Some virtualization platforms allow disabling it, so make sure, if you run LocalServer on virtualized environments, that the AVX2 instruction set is enabled.
- We recommend using LocalServer on machines with CPUs with at least 4 cores.
