marketplace
latest
false
Marketplace User Guide
Last updated Sep 5, 2024

Get Model Keys

The Get Model Keys activity uses the Form Recognizer Get Keys API to retrieve the keys that were extracted during the training of a specified model (Model Id).

After completing the get keys operation, the activity outputs the extracted keys in a ModelCluster[] object (Model Keys) that you can use as an input variable in subsequent activities.

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, Get Models).
  4. Add the Get Model Keys activity inside the Azure Form Recognizer Scope activity.
  5. Enter values for the Input properties.
  6. Create and enter a ModelCluster[] variable for the Output property.
  7. Run the activity.

    • Your input properties are sent to the Get Keys API.
    • The API returns the ModelCluster[] 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 Model Keys

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 keys 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, Get Models).

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 Keys

An array of cluster objects that contain the keys extracted from the specified model.

Attributes

Details

Type

ModelCluster[]

Required

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

Default value

Empty

Allowed values

Enter a ModelCluster[] variable

Notes

The ModelCluster object only contains the extracted Keys values (not key-value pairs). To get the key-value pairs, use the Analyze Form activity.

Example

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guides.



  • How It Works
  • Properties
  • Common
  • Input
  • Misc
  • Output
  • Example

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.