- 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
Analyze form
The Analyze Form activity uses the Form Recognizer Analyze Form API to extract key-value pairs and table data from a specified document (File Path or File URL) using a specified training model (Model Id).
After completing the analyze form operation, the activity outputs the results in an AnalyzeOperationResult object (Response Object) and a Page[] object (Pages). Both of these outputs can be used as input variables in subsequent activities (e.g., conditional logic).
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 the Analyze Form activity inside the Azure Form Recognizer Scope activity.
- Enter values for the Input properties.
- Create and enter the
AnalyzeOperationResultandPage[]variables for the Output properties. - Run the activity.
-
Your input properties are sent to the Analyze Form API.
-
The API returns the
AnalyzeFormResponseandFormPage[]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 | Analyze Form |
| Allowed values | Enter a String or String variable. |
| Notes | N/A |
Timeout
Specifies the amount of time to wait (in milliseconds) for the analyze receipt operation to complete before an error is thrown.
| Attributes | Details |
|---|---|
| Type | Int32 |
| Required | Yes |
| Default value | 30000ms ((30 seconds) not shown) |
| Allowed values | Enter a Int32 or Int32 variable. |
| Notes | N/A |
Input
File Path
The local path to the form document that you want to analyze.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes (if File URL is empty) |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | Supported form document formats:.json,.pdf,.jpg,.png, and.tiff (all other format types are ignored). |
File URL
The URL to the form document that you want to analyze.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes (if File Path is empty) |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | Supported form document formats:.json,.pdf,.jpg,.png, and.tiff (all other format types are ignored). |
Model Id
The identifier of the training model that you want to use to analyze the form.
| 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). |
Options
IncludeTextDetails
If selected, the result includes text lines and element references.
| Attributes | Details |
|---|---|
| Type | Checkbox |
| Required | No |
| Default value | Not Selected |
| Allowed values | Selected or Not Selected |
| 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
Response Object
The operation response as a deserialized object.
| Attributes | Details |
|---|---|
| Type | AnalyzeOperationResult |
| Required | No (required to use the output data in subsequent activities) |
| Default value | Empty |
| Allowed values | Enter a AnalyzeOperationResult variable |
| Notes | To get the JSON string representation, use the ToString method. If the model can't find a field, a null value is returned. |
Pages
The results of the form analysis, including the key-value pairs and table information extracted from the page.
| Attributes | Details |
|---|---|
| Type | Page[] |
| Required | No (required to use the output data in subsequent activities) |
| Default value | Empty |
| Allowed values | Enter a Page[] variable |
| Notes | Each Page object includes KeyValuePairs and Tables properties. |