UiPath Integrations

Overview

Azure Form Recognizer is a cognitive service that uses machine learning technology to identify and extract key-value pairs and table data from form documents. It then outputs structured data that includes the relationships in the original file.

The Azure Form Recognizer activities give you the ability to automate interactions with the Azure Form Recognizer service. Using the Form Recognizer APIs, this activities package provides you with the following capabilities:

  • Analyze forms and receipts to extract key-value pairs and tables
  • Get, create, and delete custom models

If you're ready to start using the Azure Form Recognizer activities, see the Get Started section below. To learn more about the package, keep reading to see How it works and the Technical References.

How it works

Each Azure Form Recognizer activity calls a Form Recognizer API using the request parameters that you enter in the activity's input properties. If the call is successful, the activity returns the relevant values to your output property variables for use in other activities.

To successfully call the Form Recognizer API, the activities must include an authentication header in the request. This header includes a subscription key that validates your subscription to the Azure Form Recognizer service (for more information, see Create a Form Recognizer Azure Resource in the Setup guide).

To include an authentication header, the activities rely on the Azure Form Recognizer Scope activity to provide the subscription key value.

When you build your automation project, you first add the Azure Form Recognizer Scope activity and enter your subscription key and API endpoint values. You then add the Azure Form Recognizer activities inside the scope activity. When you run your project, the activities get the subscription key and endpoint values from the scope activity and then call the applicable Form Recognizer API.

Note

The authentication method used by the Azure Form Recognizer Scope activity is different when compared to other Microsoft integrations (e.g., Teams and Office 365).

Currently, the Azure Form Recognizer activities authenticate with a single-service subscription key only. Authentication using an InteractiveToken or IntegratedWindowsAuthentication is not supported.

Technical References

For a complete list of the Form Recognizer APIs used by each activity and links to the relevant API documentation, see the Technical References page.

You don't need to be familiar with the Form Recognizer APIs to use the activities. The Technical References are for informational purposes only.

Get Started

Before you build your first project, complete the steps in the Setup guide.

After you complete the setup steps, see the Quickstart guide. This guide provides step-by-step instructions to help you create a working sample of the different activities so that you can verify the connection to your registered app and get familiar with the input/output properties.

To learn more about the Azure Form Recognizer activities (including example property inputs/outputs), see the Activities page for a complete list of activities and links to the detail pages.

Updated about a month ago


About


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.