Microsoft Azure

Azure Ai: Document Intelligence

Extracts content, layout, and structured data from documents.

AI & machine learning#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Extracts content, layout, and structured data from documents.

Endpoints 27

  • GETDocumentClassifiers_ListClassifiers/documentClassifiers?api-version=stringList all document classifiers.
  • GETDocumentClassifiers_GetClassifier/documentClassifiers/:classifierId?api-version=stringGets detailed document classifier information.
  • DELETEDocumentClassifiers_DeleteClassifier/documentClassifiers/:classifierId?api-version=stringDeletes document classifier.
  • POSTDocumentClassifiers_ClassifyDocumentFromStream/documentClassifiers/:classifierId:analyze?api-version=string&stringIndexType=textElements&split=none&pages=stringClassifies document with document classifier.
  • POSTDocumentClassifiers_CopyClassifierTo/documentClassifiers/:classifierId:copyTo?api-version=stringCopies document classifier to the target resource, region, and classifierId.
  • GETDocumentClassifiers_GetClassifyResult/documentClassifiers/:classifierId/analyzeResults/:resultId?api-version=stringGets the result of document classifier.
  • POSTDocumentClassifiers_AuthorizeClassifierCopy/documentClassifiers:authorizeCopy?api-version=stringGenerates authorization to copy a document classifier to this location with specified classifierId and optional description.
  • POSTDocumentClassifiers_BuildClassifier/documentClassifiers:build?api-version=stringBuilds a custom document classifier.
  • GETDocumentModels_ListModels/documentModels?api-version=stringList all document models
  • POSTDocumentModels_AnalyzeDocumentFromStream/documentModels/:modelId:analyze?api-version=string&pages=string&locale=string&stringIndexType=textElements&features=ocrHighResolution&queryFields=string&outputContentFormat=text&output=pdfAnalyzes document with document model.
  • POSTDocumentModels_AnalyzeBatchDocuments/documentModels/:modelId:analyzeBatch?api-version=string&pages=string&locale=string&stringIndexType=textElements&features=ocrHighResolution&queryFields=string&outputContentFormat=text&output=pdfAnalyzes batch documents with document model.
  • GETDocumentModels_GetModel/documentModels/:modelId?api-version=stringGets detailed document model information.
  • DELETEDocumentModels_DeleteModel/documentModels/:modelId?api-version=stringDeletes document model.
  • POSTDocumentModels_CopyModelTo/documentModels/:modelId:copyTo?api-version=stringCopies document model to the target resource, region, and modelId.
  • GETDocumentModels_ListAnalyzeBatchResults/documentModels/:modelId/analyzeBatchResults?api-version=stringList batch document analysis results.
  • GETDocumentModels_GetAnalyzeBatchResult/documentModels/:modelId/analyzeBatchResults/:resultId?api-version=stringGets the result of batch document analysis.
  • DELETEDocumentModels_DeleteAnalyzeBatchResult/documentModels/:modelId/analyzeBatchResults/:resultId?api-version=stringMark the batch document analysis result for deletion.
  • GETDocumentModels_GetAnalyzeResult/documentModels/:modelId/analyzeResults/:resultId?api-version=stringGets the result of document analysis.
  • DELETEDocumentModels_DeleteAnalyzeResult/documentModels/:modelId/analyzeResults/:resultId?api-version=stringMark the result of document analysis for deletion.
  • GETDocumentModels_GetAnalyzeResultFigure/documentModels/:modelId/analyzeResults/:resultId/figures/:figureId?api-version=stringGets the generated cropped image of specified figure from document analysis.
  • GETDocumentModels_GetAnalyzeResultPdf/documentModels/:modelId/analyzeResults/:resultId/pdf?api-version=stringGets the generated searchable PDF output from document analysis.
  • POSTDocumentModels_AuthorizeModelCopy/documentModels:authorizeCopy?api-version=stringGenerates authorization to copy a document model to this location with specified modelId and optional description.
  • POSTDocumentModels_BuildModel/documentModels:build?api-version=stringBuilds a custom document analysis model.
  • POSTDocumentModels_ComposeModel/documentModels:compose?api-version=stringCreates a new document model from document types of existing document models.
  • GETMiscellaneousOperations_GetResourceDetails/info?api-version=stringReturn information about the current resource.
  • GETMiscellaneousOperations_ListOperations/operations?api-version=stringLists all operations.
  • GETMiscellaneousOperations_GetDocumentModelBuildOperation/operations/:operationId?api-version=stringGets operation info.

API details

Authentication
An API key in the Ocp-Apim-Subscription-Key header
OAuth 2.0 (authorization code flow) with 1 scope
Operations
27 operations on 23 pathsGET 13POST 10DELETE 4
Response formats
application/json
Description format
Swagger 2.0, API version 2024-11-30

How to test the Azure Ai: Document Intelligence in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Ai: Document Intelligence collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Ocp-Apim-Subscription-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “DocumentClassifiers_ListClassifiers” (GET /documentClassifiers?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Ai: Document Intelligence?

Extracts content, layout, and structured data from documents. It is listed under AI & machine learning and has 27 endpoints.

Who publishes the Azure Ai: Document Intelligence?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Ai: Document Intelligence?

It accepts 2 methods: an API key in the Ocp-Apim-Subscription-Key header; OAuth 2.0 (authorization code flow) with 1 scope.

How many endpoints does the Azure Ai: Document Intelligence have?

27 operations on 23 paths (13 GET, 10 POST, 4 DELETE).

Is forking the Azure Ai: Document Intelligence free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.