UiPath Activities

The UiPath Activities Guide

Machine Learning Extractor

UiPath.DocumentUnderstanding.ML.Activities.MachineLearningExtractor

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:

The UiPath.DocumentUnderstanding.ML.Activities package is an improved version of the obsolete UiPath.MachineLearningExtractor.Activities package. Avoid any possible errors caused by the name difference by removing any prior installation of this package and replacing it with the new one.

Properties

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

  • Endpoint - The endpoint hosting the machine learning model.
  • RetryOnFailure - Automatically retries the machine learning model execution, to eliminate transient network errors. If checked, the activity retries the execution.

Note:

Some limitations are in place for the Community package versions:

  • The size of the documents is limited at 2 pages and 4MB in total.
  • Community endpoints are rate-limited per IP address at 50 requests per hour. If the rate-limit is reached, an 429 - Too Many Requests error is displayed, and the IP address is blocked for 1 hour.

Click here for information about the Document Understanding Endpoints.

Using the Machine Learning Extractor

Here are the steps that you need to follow for using the Machine Learning Extractor activity:

  1. Use the Taxonomy Manager Wizard to define your document type, with the fields you are targeting for data extraction.
  2. Drag a Machine Learning Extractor in a Data Extraction Scope activity.
  3. In the Machine Learning Extractor wizard that automatically opens, add the Endpoint information.
  4. Select the check box for the Update activity arguments if you wish to also use the entered values as input arguments for the activity, more precisely for the Endpoint.
  5. Click the Get Capabilities button. The wizard closes after this operation.
  6. Select the Configure Extractors option of the Data Extraction Scope. A wizard is displayed.
  1. The Machine Learning Extractor is now ready for configuration. Expand the document type that you want to apply it for, and start selecting the fields you want to attempt extraction for, by checking the check boxes next to the appropriate fields and by selecting, from the available drop-down list, the correct data you wish to map to each field. The drop-down list contains all fields that the Machine Learning Extractor, using the endpoint entered in the Machine Learning Extractor wizard, declares as extraction capability.
  2. Selecting one of the options from a drop-down list automatically confirms that field.
  1. Select the Save button once all fields are configured properly.

Note:

You cannot choose the same option for two distinct fields.

Updated about a month ago


Machine Learning Extractor


Suggested Edits are limited on API Reference Pages

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