Skip to main content

Analyze Form

Description​

This Activity analyzes the provided Form using pre-build Azure Forms Recognizer Service models.

note

Deploy the Azure Forms Recognizer Resource endpoint. Refer: Azure Forms Resource This Activity requires Azure Forms Recognizer Resource endpoint URL

Properties​

Azure Forms Recognizer Service​

  • Endpoint Url – Specify the deployed endpoint URL of the Azure Forms Recognizer service instance.
  • Access Key – Specify the Access Key corresponding to the deployed service.

Input​

  • Form File – Specify the path to the form file in image or pdf format.

  • Form Type – Specify the type of the form file. The following types are supported:

    Form TypeDescription
    BusinessCardUtilizes Business Card ML model for data recognition and extraction
    IdentityDocumentUtilizes Identity Document ML model for data recognition and extraction
    InvoiceUtilizes Invoice ML model for data recognition and extraction
    ReceiptUtilizes Receipt ML model for data recognition and extraction

Misc​

  • DisplayName – Add a display name to your Activity.
  • Private – Logs the variable and argument values at the Verbose level when unchecked.

Optional​

  • Continue On Error – It Specifies whether the automation should continue even though this Activity fails. This field only supports Boolean values (True, False). The default value is False.
    note

    If this Activity is present inside Try Catch and the value of this property is True, it will ignore errors during the automation execution.

Output​

  • Forms – Returns a list of Forms and their properties detected by the service for provided Form. Form can be Invoice, Receipt, BusinessCard, or IdentityDocument
  • Pages – Returns a list of pages and their child entities detected by the service for provided Form. Refer: FormPage
  • Raw Response - JSON string containing the response received as is from Azure.

Example​

Download Example

Analyze Form