# Machine Learning Extractor

> `UiPath.DocumentUnderstanding.ML.Activities.MachineLearningExtractor`

`UiPath.DocumentUnderstanding.ML.Activities.MachineLearningExtractor`

## Description

Enables data extraction from documents using [machine learning models](https://docs.uipath.com/document-understanding/automation-cloud/latest/user-guide/out-of-the-box-pre-trained-ml-packages) provided by UiPath®. This activity can be used only within the [Data Extraction Scope](https://docs.uipath.com/activities/other/latest/document-understanding/data-extraction-scope) activity.

:::note
You cannot use this activity with modern projects. Visit [Automations in Document Understanding](https://docs.uipath.com/document-understanding/automation-cloud/latest/user-guide/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](https://docs.uipath.com/document-understanding/docs/api-key) 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](https://docs.uipath.com/document-understanding/docs/public-endpoints), 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](https://docs.uipath.com/activities/other/latest/document-understanding/machine-learning-extractor-trainer#machine-learning-extractor-trainer) activity. The default value is `False`. An upcoming deprecation is announced for this option. [Here](https://docs.uipath.com/overview-guide/docs/deprecation-timeline#activities) 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](https://docs.uipath.com/activities/other/latest/document-understanding/machine-learning-extractor#machine-learning-extractor).

This activity can be used with [Forms AI](https://docs.uipath.com/document-understanding/automation-cloud/latest/classic-user-guide/forms-ai), on Automation Cloud<sup>TM</sup>.