- Release notes
- Overview
- Getting started
- Marketplace Vendors
- Marketplace Customers
- Publishing Guidelines
- Publishing Guidelines for Ready-to-go Automations
- Publishing Guidelines for Solution Accelerators
- Publishing Guidelines for Integration Service Connectors
- Publishing Guidelines for Process Mining app templates
- Security & IP Protection
- Other UiPath Listings
- Node-RED
- Setup
- Teams
- Microsoft Teams scope
- Create team
- Create team from group
- Get team
- Get teams
- Channels
- Create channel
- Delete channel
- Get channel
- Get channels
- Update channel
- Chats
- Get chat
- Get chats
- Get chat members
- Messages
- Get message
- Get messages
- Get message replies
- Reply to message
- Send message
- Events
- Create event
- Delete event
- Get event
- Get events
- Users
- Get user presence
- How it works
- Technical references
- Get started
- About
- Setup
- Technical references
- Azure Form Recognizer scope
- Activities
- Analyze form
- Analyze form async
- Get analyze form result
- Analyze receipt
- Analyze receipt async
- Get analyze receipt result
- Analyze layout
- Analyze layout async
- Get analyze layout result
- Train model
- Get models
- Get model keys
- Get model info
- Delete model
- Connectors
- How to create activities
- Build Your Integration
Marketplace user guide
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 (that is, the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the Azure Form Recognizer Scope activity to your project.
- Add an activity or run an external process that outputs the model identifier (e.g., Train Model, Get Models).
- Add the Get Model Keys activity inside the Azure Form Recognizer Scope activity.
- Enter values for the Input properties.
- Create and enter a
ModelCluster[]variable for the Output property. - 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.
