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
- 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 26, 2024
ML Skill
UiPath.MLServices.Activities.MLSkills
Note: This activity requires Studio
v2019.10 or higher to function properly.
Retrieves ML Skills available in the AI Center service and requests them. Authenticates under the robot which executes the ML Skill.
Depending on the input type, the MLSkills activity expects the following format:
JSON
"this is an example of input"
"{""expected-field"":""this is another example""}""this is an example of input"
"{""expected-field"":""this is another example""}"File
"C:/full/path/to/file.ext""C:/full/path/to/file.ext"Files
"C:/full/path/to/file1.ext,C:/full/path/to/file2.ext,C:/full/path/to/file3.ext""C:/full/path/to/file1.ext,C:/full/path/to/file2.ext,C:/full/path/to/file3.ext"Designer panel
Depending on the chosen Connection mode, you can configure several essential properties directly from the body of the activity.
Connection mode: Robot
Figure 1. The ML Skill activity when the
connection mode is made through a Robot
- Search - Retrieves the list of available ML Skills and allows you to select the one to which you want to send data. This list is populated after connection.
- Item - The input that is sent alongside the ML Skill request.
- JSONResponse - The JSON response returned by the ML Skill request.
Connection mode: Endpoint
Figure 2. The ML Skill activity when the
connection mode is made through an endpoint
- ML Skill URL - The URL of the ML
Skill to used for prediction. For instance, you can type
https://aicentercom/j123/invoicesin the Advanced Editor. Once public, it is visible in the Dataset detail page. - API Key - The API Key selected from the AI Center Resource. Once public, it is visible in the Dataset detail page.
- Test Skill - Test your ML Skill.
- Input type - The input type expected for the ML Skill selected from the drop-down list (JSON, File, or Files)
- Item - The input that is sent alongside the ML Skill request.
- JSONResponse - The JSON response returned by the ML Skill request.
Properties panel
Common
- ContinueOnError - Specifies if the
automation should continue even when the activity throws an error. This field only
supports Boolean values (True, False). The default value is False. As a result, if the
field is blank and an error is thrown, the execution of the project stops. If the value is
set to True, the execution of the project continues regardless of any error.
Note: If this activity is included in Try Catch and the value of the ContinueOnError property is True, no error is caught when the project is executed.
- DelayAfter - Delay time (in milliseconds) after executing the activity. This field supports only
Int32variables. - DelayBefore - Delay time (in milliseconds) before the activity begins performing any operations. This field supports only
Int32variables. - DisplayName - The display name of the activity. This field supports only
Stringvariables. - NumberOfRetries - The maximum number of attempts to execute the ML Skill request. This field supports only
Int32variables. - TimeoutMS - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value
is 30000 milliseconds (30 seconds). This field supports only
Int32variables.
Input
- API Key - The API Key of the ML Skill to be predicted. This field supports only
Stringvariables. - Connection mode - The desired type of
connection (Robot or Endpoint)
- Robot - Deploy the ML Skill inside Robot.
- Endpoint - Deploy the ML Skill outside Robot.
- Item - The input string that is sent alongside the ML Skill request. This field supports only strings and
Stringvariables.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
- Skill URL - The URL of the ML Skill to used for prediction. This field supports only
Stringvariables.
Output
- Headers - The headers returned by the ML Skill request. This field supports only
Stringvariables. - JSONResponse - The JSON response returned by the ML Skill request. This field supports only
Stringvariables. - StatusCode - The Status Code returned by the ML Skill request. This field supports only
Int32variables.
