activities
latest
false
UiPath logo, featuring letters U and I in white
Document Understanding Activities
Last updated Nov 21, 2024

Machine Learning Extractor

UiPath.DocumentUnderstanding.ML.Activities.MachineLearningExtractor

Description

Enables data extraction from documents using machine learning models provided by UiPath®. This activity can be used only within the Data Extraction Scope activity.

Note: You cannot use this activity with modern projects. Visit Automations in Document Understanding to check the methods you can use for your modern projects.

Project compatibility

Windows - Legacy | Windows

Configuration

Properties panel

Common

  • DisplayName - The display name of the activity.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Server

  • ApiKey - The API key used to provide you access to the Machine Learning Extractor. The API Key field is automatically pre-populated if defined in local project settings or in the Document Understanding framework. If you want to add the API Key manually, here you can find information about retrieving the API Key.
  • Endpoint - The endpoint hosting the machine learning model. The used extraction algorithm can be either from the ML Models List, available here, or it can be generated from Forms AI.
  • RetryOnFailure - Automatically retries the machine learning model execution, to eliminate transient network errors. If checked, the activity retries the execution.
  • 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).
  • MLSkill - Provides the MLSkills list available in the AI Fabric service.
  • UseServerSideOCR - If not selected, the machine learning service uses the OCR results received from digitization. If selected, the document is reprocessed using the internally configured OCR. Using this option is incompatible with the Machine Learning Extractor Trainer activity. The default value is False. An upcoming deprecation is announced for this option. Here you can find more details about it.
    Note: The UseServerSideOCR option is available starting with UiPath.DocumentUnderstanding.ML.Activities v1.1.0. Previous package versions execute OCR server-side.

Learn More

To learn more about Machine Learning Extractor, please visit the Document Understanding Guide here.

This activity can be used with Forms AI, on Automation CloudTM.

  • Description
  • Project compatibility
  • Configuration
  • Learn More

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.