Get Models

The Get Models activity uses the Form Recognizer Get Models API to retrieve the training models that have been created for the Azure resource specified in the Azure Form Recognizer Scope activity.

After completing the get models operation, the activity outputs the details of each retrieved model in a ModelInfo[] (Model Info Array) object that you can use as an input variable in subsequent activities (e.g., ModelInfo(0).ModelId.ToString in the Get Model Keys activity).

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 the Get Models activity inside the Azure Form Recognizer Scope activity.
4. Create and enter a ModelInfo[] variable for the Output property.

5. Run the activity.

   • Your request is sent to the Get Models API.
   • The API returns the ModelInfo[] value to your output property variable.
     
     

     

     
     

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 Models
Allowed values	Enter a String or String variable.
Notes	N/A

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

Output

Model Info Array

An array of the models and information found in the Azure resource.

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	The variable you create for this property can be used as an input variable in subsequent activities (e.g., ModelInfo(0).ModelId.ToString in the Get Model Keys activity). Each ModelInfo object includes multiple properties that you can use in other activities.