UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Get Model Info

The Get Model Info activity uses the Form Recognizer Get Custom Model API to retrieve information about a specified model (Model Id).

After completing the get model operation, the activity outputs the model information in a ModelInfo object (Model Info), the extracted keys in a KeyResult object (Model Keys), and the model train results in a TrainResult object (Train Result).

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Azure Form Recognizer Scope activity to your project.
  3. Add an activity or run an external process that outputs the model identifier (e.g., Train Model).
  4. Add the Get Model Info activity inside the Azure Form Recognizer Scope activity.
  5. Enter values for the Input properties.
  6. Create and enter ModelInfo, KeyResult, and TrainResult variables for the Output properties.
  7. Run the activity.
    • Your input properties are sent to the Get Custom Model API.
    • The API returns the ModelInfo,KeyResult, andTrainResult` values to your output property variables.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Get Model Info

Allowed values

Enter a String or String variable.

Notes

N/A


Input

Model Id

The identifier of the training model that you want to get information from.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • To get the Model Id value, add an activity or run an external process that outputs the model identifier (e.g., Train Model).

Misc

Private

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

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Options

Include Keys

If selected, the result includes a list of extracted keys in the model information.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Output

Model Info

The model information.

Attributes
Details

Type

ModelInfo

Required

No (required to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a ModelInfo variable

Notes

  • For more information about the Model Info, see the response schema section in the Get Custom Model API documentation.

Model Keys

The keys extracted from the model.

Attributes
Details

Type

KeyResult

Required

No (required to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a KeyResult variable

Notes

  • To output the Model Keys value, make sure the Include Keys option is selected.

Train Result

The result of the training

Attributes
Details

Type

TrainResult

Required

No (required to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a TrainResult variable

Notes

  • To output the Train Result value, make sure the Include Keys option is selected.

Updated 15 days ago


Get Model Info


Suggested Edits are limited on API Reference Pages

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