- 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 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 (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).
- Add the Get Model Info activity inside the Azure Form Recognizer Scope activity.
- Enter values for the Input properties.
- Create and enter
ModelInfo,KeyResult, andTrainResultvariables for the Output properties. - 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. |