Get Analyze Form Result

The Get Analyze Form Result activity uses the Form Recognizer Get Analyze Form Result API to asynchronously retrieve the results of previously run form analysis operation (Result Location and Model Id).

After completing the operation, the activity outputs the operation status in a String (Operation Status), and the results in an AnalyzeOperationResult object (Response Object) and a Page[] object (Pages). All 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 (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 an activity or run an external process that outputs the result location (e.g., ).
5. Add the Get Analyze Form Result activity inside the Azure Form Recognizer Scope activity.
6. Enter values for the Input properties.
7. Create and enter String, AnalyzeOperationResult, and Page[] variables for the Output properties.

8. Run the activity.

   • Your input properties are sent to the Get Analyze Form Result API.
   • The API returns the status String, AnalyzeFormResponse, and Page[] 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 Analyze Form Results
Allowed values	Enter a String or String variable.
Notes	N/A

Input

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).

Result Location

The URL containing the Result ID used to track the progress and obtain the result of the operation.

Attributes	Details
Type	String
Required	No (required to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter a String variable
Notes	To get the Result Location, add an activity or run an external process that outputs the result location (e.g., ). For more information, see Operation-Location in the Analyze Form API documentation.

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

Operation Status

The status of the operation.

Attributes	Details
Type	String
Required	No (required to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter a String variable
Notes	There are four possible statuses: notStarted: The analysis operation has not started. running: The analysis operation is in progress. failed: The analysis operation failed. succeeded: The analysis operation succeeded. If the status is succeeded, the response JSON includes the form understanding and text recognition results.

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. For more information about the object, including the data fields, see the response section of the Get Analyze Form Result API documentation.

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.