Configure Document Automation with Microsoft Azure Form Recognizer

Send an API request to connect Document Automation with the extraction service.

Note: You will need the following information:
  • Authorization token. See Authentication API
  • Microsoft Azure Form Recognizer endpoint
  • Microsoft Azure Form Recognizer API key
  • Microsoft Azure Blob storage URI
When working with API URL trusted list for Standard Forms:
  • Add only form recognizer services API URL to the trusted list at Bot Runner end.
  • Add the following URLs to the trusted list at the Control Room end:
Note: To obtain a Microsoft Azure API Key, reach out to your CSM. Raise a support case with the account name or tenant name, validity period (usually till expiry of license), and region (refer to Azure Products By Region) for standard forms in description through Apeople page. For any issue, reach out to CSM or AE.

For supported regions, see Microsoft Azure AI Document Intelligence product at Azure Products by Region.

For Document Automation Cloud

Request

PUT <Cloud Host Url>/cognitive/v3/formrecognizer/config
Headers: X-Authorization - <IQBot Admin User Auth token >
Request body:

{    
"formRecognizerApi": "https://<Cognitive Service Endpoint>",    
"formRecognizerKey": "<Cognitive Service apiKey>",    
"blobStorageSas": "https://<storage URL>" 
}

For Document Automation On-Premises

Request

PUT <On-Premises Machine ip_address or localhost:port>/cognitive/v3/formrecognizer/config
Headers: X-Authorization - <IQBot Admin User Auth token >
Request body:

{    
"formRecognizerApi": "https://<Cognitive Service Endpoint>",    
"formRecognizerKey": "<Cognitive Service apiKey>",    
"blobStorageSas": "https://<storage URL>" 
}

Next steps

Log in as the Learning instance creator user to Create a custom extraction model using Standard Forms.