Microsoft Azure Document Intelligence, formerly known as Form Recognizer, is a powerful tool that allows organizations to extract valuable information from a variety of documents. With its advanced machine learning capabilities, Document Intelligence can accurately analyze and process forms, invoices, receipts, and other types of documents.
swagger: '2.0'
info:
title: Microsoft Azure Document Intelligence (formerly Form Recognizer)
version: 2024-02-29-preview
description: Extracts content, layout, and structured data from documents.
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
schemes:
- https
x-ms-parameterized-host:
hostTemplate: '{endpoint}/documentintelligence'
useSchemePrefix: false
parameters:
- name: endpoint
in: path
description: The Document Intelligence service endpoint.
required: true
type: string
produces:
- application/json
consumes:
- application/json
security:
- ApiKeyAuth: []
- OAuth2Auth:
- https://cognitiveservices.azure.com/.default
securityDefinitions:
ApiKeyAuth:
type: apiKey
name: Ocp-Apim-Subscription-Key
in: header
OAuth2Auth:
type: oauth2
flow: accessCode
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
https://cognitiveservices.azure.com/.default: ''
tokenUrl: https://login.microsoftonline.com/common/oauth2/token
tags:
- name: documentClassifiers
- name: documentClassifiers:build
- name: documentModels
- name: documentModels:authorizeCopy
- name: documentModels:build
- name: documentModels:compose
- name: Info
- name: Operations
paths:
/documentClassifiers:
get:
operationId: microsoftAzureDocumentclassifiersListclassifiers
description: List all document classifiers.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/PagedDocumentClassifierDetails'
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Document Classifiers:
$ref: ./examples/GetDocumentClassifiers.json
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Documentclassifiers
tags:
- documentClassifiers
/documentClassifiers/{classifierId}:
get:
operationId: microsoftAzureDocumentclassifiersGetclassifier
description: Gets detailed document classifier information.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: classifierId
in: path
description: Unique document classifier name.
required: true
type: string
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/DocumentClassifierDetails'
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Document Classifier:
$ref: ./examples/GetDocumentClassifier.json
summary: Microsoft Azure Get Documentclassifiers Classifierid
tags:
- documentClassifiers
delete:
operationId: microsoftAzureDocumentclassifiersDeleteclassifier
description: Deletes document classifier.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: classifierId
in: path
description: Unique document classifier name.
required: true
type: string
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Delete Document Classifier:
$ref: ./examples/DeleteDocumentClassifier.json
summary: Microsoft Azure Delete Documentclassifiers Classifierid
tags:
- documentClassifiers
/documentClassifiers/{classifierId}:analyze:
post:
operationId: microsoftAzureDocumentclassifiersClassifydocumentfromstream
description: Classifies document with document classifier.
consumes:
- application/octet-stream
- application/pdf
- image/jpeg
- image/png
- image/tiff
- image/bmp
- image/heif
- text/html
- >-
application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- >-
application/vnd.openxmlformats-officedocument.presentationml.presentation
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- $ref: '#/parameters/DocumentClassifierAnalyzeRequestParams.classifierId'
- $ref: '#/parameters/DocumentClassifierAnalyzeRequestParams.stringIndexType'
- $ref: '#/parameters/DocumentClassifierAnalyzeRequestParams.split'
- $ref: '#/parameters/AnalyzeFromStreamRequestParams.input'
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
headers:
Operation-Location:
type: string
format: uri
description: The location of an instance of AnalyzeResultOperation
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Classify Document from Url:
$ref: ./examples/ClassifyDocument_Stream.json
x-ms-long-running-operation: true
summary: Microsoft Azure Post Documentclassifiers Classifierid:analyze
tags:
- documentClassifiers
/documentClassifiers/{classifierId}/analyzeResults/{resultId}:
get:
operationId: microsoftAzureDocumentclassifiersGetclassifyresult
description: Gets the result of document classifier.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: classifierId
in: path
description: Unique document classifier name.
required: true
type: string
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
- name: resultId
in: path
description: Analyze operation result ID.
required: true
type: string
format: uuid
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/AnalyzeResultOperation'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Classify Document Result:
$ref: ./examples/GetClassifyDocumentResult.json
summary: Microsoft Azure Get Documentclassifiers Classifierid Analyzeresults Resultid
tags:
- documentClassifiers
/documentClassifiers:build:
post:
operationId: microsoftAzureDocumentclassifiersBuildclassifier
description: Builds a custom document classifier.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: buildRequest
in: body
description: Build request parameters.
required: true
schema:
$ref: '#/definitions/BuildDocumentClassifierRequest'
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
headers:
Operation-Location:
type: string
format: uri
description: >-
The location of an instance of
DocumentClassifierBuildOperationDetails
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Build Document Classifier:
$ref: ./examples/BuildDocumentClassifier.json
x-ms-long-running-operation: true
summary: Microsoft Azure Post Documentclassifiers:build
tags:
- documentClassifiers:build
/documentModels:
get:
operationId: microsoftAzureDocumentmodelsListmodels
description: List all document models
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/PagedDocumentModelDetails'
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Document Models:
$ref: ./examples/GetDocumentModels.json
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Documentmodels
tags:
- documentModels
/documentModels/{modelId}:analyze:
post:
operationId: microsoftAzureDocumentmodelsAnalyzedocumentfromstream
description: Analyzes document with document model.
consumes:
- application/octet-stream
- application/pdf
- image/jpeg
- image/png
- image/tiff
- image/bmp
- image/heif
- text/html
- >-
application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- >-
application/vnd.openxmlformats-officedocument.presentationml.presentation
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.modelId'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.pages'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.locale'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.stringIndexType'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.features'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.queryFields'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.outputContentFormat'
- $ref: '#/parameters/AnalyzeFromStreamRequestParams.input'
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
headers:
Operation-Location:
type: string
format: uri
description: The location of an instance of AnalyzeResultOperation
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Analyze Document from Url:
$ref: ./examples/AnalyzeDocument_Stream.json
x-ms-long-running-operation: true
summary: Microsoft Azure Post Documentmodels Modelid:analyze
tags:
- documentModels
/documentModels/{modelId}:
get:
operationId: microsoftAzureDocumentmodelsGetmodel
description: Gets detailed document model information.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: modelId
in: path
description: Unique document model name.
required: true
type: string
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/DocumentModelDetails'
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Custom Document Model:
$ref: ./examples/GetDocumentModel_Custom.json
Get Prebuilt Document Model:
$ref: ./examples/GetDocumentModel_Prebuilt.json
summary: Microsoft Azure Get Documentmodels Modelid
tags:
- documentModels
delete:
operationId: microsoftAzureDocumentmodelsDeletemodel
description: Deletes document model.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: modelId
in: path
description: Unique document model name.
required: true
type: string
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Delete Document Model:
$ref: ./examples/DeleteDocumentModel.json
summary: Microsoft Azure Delete Documentmodels Modelid
tags:
- documentModels
/documentModels/{modelId}:copyTo:
post:
operationId: microsoftAzureDocumentmodelsCopymodelto
description: Copies document model to the target resource, region, and modelId.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: modelId
in: path
description: Unique document model name.
required: true
type: string
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
- name: copyToRequest
in: body
description: Copy to request parameters.
required: true
schema:
$ref: '#/definitions/CopyAuthorization'
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
headers:
Operation-Location:
type: string
format: uri
description: >-
The location of an instance of
DocumentModelCopyToOperationDetails
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Copy Document Model To:
$ref: ./examples/CopyDocumentModelTo.json
x-ms-long-running-operation: true
summary: Microsoft Azure Post Documentmodels Modelid:copyto
tags:
- documentModels
/documentModels/{modelId}/analyzeResults/{resultId}:
get:
operationId: microsoftAzureDocumentmodelsGetanalyzeresult
description: Gets the result of document analysis.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: modelId
in: path
description: Unique document model name.
required: true
type: string
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
- name: resultId
in: path
description: Analyze operation result ID.
required: true
type: string
format: uuid
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/AnalyzeResultOperation'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Analyze Document Result:
$ref: ./examples/GetAnalyzeDocumentResult.json
summary: Microsoft Azure Get Documentmodels Modelid Analyzeresults Resultid
tags:
- documentModels
/documentModels:authorizeCopy:
post:
operationId: microsoftAzureDocumentmodelsAuthorizemodelcopy
description: >-
Generates authorization to copy a document model to this location
with<br>specified modelId and optional description.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: authorizeCopyRequest
in: body
description: Authorize copy request parameters.
required: true
schema:
$ref: '#/definitions/AuthorizeCopyRequest'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/CopyAuthorization'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Authorize Copy of Document Model:
$ref: ./examples/AuthorizeCopyDocumentModel.json
summary: Microsoft Azure Post Documentmodels:authorizecopy
tags:
- documentModels:authorizeCopy
/documentModels:build:
post:
operationId: microsoftAzureDocumentmodelsBuildmodel
description: Builds a custom document analysis model.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: buildRequest
in: body
description: Build request parameters.
required: true
schema:
$ref: '#/definitions/BuildDocumentModelRequest'
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
headers:
Operation-Location:
type: string
format: uri
description: >-
The location of an instance of
DocumentModelBuildOperationDetails
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Build Document Model:
$ref: ./examples/BuildDocumentModel.json
x-ms-long-running-operation: true
summary: Microsoft Azure Post Documentmodels:build
tags:
- documentModels:build
/documentModels:compose:
post:
operationId: microsoftAzureDocumentmodelsComposemodel
description: >-
Creates a new document model from document types of existing document
models.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: composeRequest
in: body
description: Compose request parameters.
required: true
schema:
$ref: '#/definitions/ComposeDocumentModelRequest'
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
headers:
Operation-Location:
type: string
format: uri
description: >-
The location of an instance of
DocumentModelComposeOperationDetails
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Compose Document Model:
$ref: ./examples/ComposeDocumentModel.json
x-ms-long-running-operation: true
summary: Microsoft Azure Post Documentmodels:compose
tags:
- documentModels:compose
/info:
get:
operationId: microsoftAzureMiscellaneousoperationsGetresourceinfo
description: Return information about the current resource.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/ResourceDetails'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Resource Details:
$ref: ./examples/GetResourceDetails.json
summary: Microsoft Azure Get Info
tags:
- Info
/operations:
get:
operationId: microsoftAzureMiscellaneousoperationsListoperations
description: Lists all operations.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/PagedOperationDetails'
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Operations:
$ref: ./examples/GetOperations.json
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Operations
tags:
- Operations
/operations/{operationId}:
get:
operationId: microsoftAzureMiscellaneousoperationsGetdocumentmodelbuildoperation
description: Gets operation info.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: operationId
in: path
description: Operation ID
required: true
type: string
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/DocumentModelBuildOperationDetails'
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Operation - Document Model Build:
$ref: ./examples/GetOperation_DocumentModelBuild.json
summary: Microsoft Azure Get Operations Operationid
tags:
- Operations
x-ms-paths:
/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument:
post:
operationId: DocumentClassifiers_ClassifyDocument
description: Classifies document with document classifier.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- $ref: '#/parameters/DocumentClassifierAnalyzeRequestParams.classifierId'
- $ref: '#/parameters/DocumentClassifierAnalyzeRequestParams.stringIndexType'
- $ref: '#/parameters/DocumentClassifierAnalyzeRequestParams.split'
- name: classifyRequest
in: body
description: Classify request parameters.
required: true
schema:
$ref: '#/definitions/ClassifyDocumentRequest'
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
headers:
Operation-Location:
type: string
format: uri
description: The location of an instance of AnalyzeResultOperation
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Classify Document from Url:
$ref: ./examples/ClassifyDocument_Url.json
x-ms-long-running-operation: true
/documentModels/{modelId}:analyze?_overload=analyzeDocument:
post:
operationId: DocumentModels_AnalyzeDocument
description: Analyzes document with document model.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.modelId'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.pages'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.locale'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.stringIndexType'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.features'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.queryFields'
- $ref: '#/parameters/DocumentModelAnalyzeRequestParams.outputContentFormat'
- name: analyzeRequest
in: body
description: Analyze request parameters.
required: false
schema:
$ref: '#/definitions/AnalyzeDocumentRequest'
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
headers:
Operation-Location:
type: string
format: uri
description: The location of an instance of AnalyzeResultOperation
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Analyze Document from Base64:
$ref: ./examples/AnalyzeDocument_Base64.json
Analyze Document from Url:
$ref: ./examples/AnalyzeDocument_Url.json
x-ms-long-running-operation: true
/operations/{operationId}?_overload=getDocumentModelComposeOperation:
get:
operationId: MiscellaneousOperations_GetDocumentModelComposeOperation
description: Gets operation info.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: operationId
in: path
description: Operation ID
required: true
type: string
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/DocumentModelComposeOperationDetails'
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Operation - Document Model Compose:
$ref: ./examples/GetOperation_DocumentModelCompose.json
/operations/{operationId}?_overload=getDocumentModelCopyToOperation:
get:
operationId: MiscellaneousOperations_GetDocumentModelCopyToOperation
description: Gets operation info.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: operationId
in: path
description: Operation ID
required: true
type: string
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/DocumentModelCopyToOperationDetails'
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get Operation - Document Model Copy To:
$ref: ./examples/GetOperation_DocumentModelCopyTo.json
/operations/{operationId}?_overload=getDocumentClassifierBuildOperation:
get:
operationId: MiscellaneousOperations_GetDocumentClassifierBuildOperation
description: Gets operation info.
parameters:
- $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: operationId
in: path
description: Operation ID
required: true
type: string
- $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/DocumentClassifierBuildOperationDetails'
headers:
x-ms-client-request-id:
type: string
format: uuid
description: >-
An opaque, globally-unique, client-generated string identifier
for the request.
# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/document-intelligence-formerly-form-recognizer-openapi-original.yml