Skip to main content

​
At a glance

  • Availability: Experimental (how to enable).
  • Authentication: API key.
  • Connection: The key from AZURE_DOCUMENT_INTELLIGENCE_KEY is sent as the Ocp-Apim-Subscription-Key header.
  • Provider documentation: Authentication reference.

​
Credentials

Set these per environment. See Connect an integration.

​
Setup

  1. Create a Document Intelligence resource: In the Azure portal, create an Azure AI Document Intelligence (formerly Form Recognizer) resource: https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer. Choose the free F0 pricing tier to test at no cost (500 pages/month; F0 only processes the first 2 pages of each request).
  2. Copy the key and endpoint: Open the resource’s ‘Keys and Endpoint’ blade. Store KEY 1 as AZURE_DOCUMENT_INTELLIGENCE_KEY and the endpoint hostname (e.g. myresource.cognitiveservices.azure.com, without https://) as AZURE_DOCUMENT_INTELLIGENCE_ENDPOINT.
  3. Run an analysis: Set AZURE_DOCUMENT_INTELLIGENCE_ENDPOINT to your resource hostname, then call Analyze Invoice with a urlSource pointing at a sample invoice. The API replies 202 Accepted; copy the result ID (GUID) from the Operation-Location response header.
  4. Fetch the result: Call Get Analyze Result with the same modelId (prebuilt-invoice) and the result ID. Poll until status is ‘succeeded’, then read the extracted fields from analyzeResult.documents.

​
Provider notes

  • Analysis is asynchronous: analyze calls return 202 with no body; the result ID must be read from the Operation-Location response header
  • Analyze results are retained for 24 hours, after which the result ID expires
  • All tools pin api-version 2024-11-30 (GA v4.0); region availability and model versions are listed in the Azure docs
  • Either urlSource or base64Source must be set on analyze calls, never both
Provider API reference.

​
Tools

​
Verify the connection

Call a read tool such as azure-document-intelligence__get_analyze_result with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.