Microsoft Azure Form Recognizer Client is a powerful tool that allows users to extract text, key-value pairs, and tables from a variety of documents such as receipts, invoices, and forms. This tool uses advanced machine learning algorithms to accurately analyze and extract data from these documents, making it easy for users to digitize and organize important information quickly and efficiently.
swagger: '2.0'
info:
version: 2.1-preview.3
title: Microsoft Azure Form Recognizer Client
description: Extracts information from forms and images into structured data.
securityDefinitions:
apim_key:
type: apiKey
name: Ocp-Apim-Subscription-Key
in: header
security:
- apim_key: []
x-ms-parameterized-host:
hostTemplate: '{endpoint}/formrecognizer/v2.1-preview.3'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'
schemes:
- https
paths:
/custom/models:
post:
summary: Microsoft Azure Train Custom Model
description: >-
Create and train a custom model. The request must include a source
parameter that is either an externally accessible Azure storage blob
container Uri (preferably a Shared Access Signature Uri) or valid path
to a data folder in a locally mounted drive. When local paths are
specified, they must follow the Linux/Unix path format and be an
absolute path rooted to the input mount configuration setting value
e.g., if '{Mounts:Input}' configuration setting value is '/input' then a
valid source path would be '/input/contosodataset'. All data to be
trained is expected to be under the source folder or sub folders under
it. Models are trained using documents that are of the following content
type - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' or
'image/bmp'. Other type of content is ignored.
operationId: microsoftAzureTraincustommodelasync
consumes:
- application/json
produces:
- application/json
parameters:
- name: trainRequest
in: body
description: Training request parameters.
required: true
schema:
$ref: '#/definitions/TrainRequest'
responses:
'201':
description: Request is queued successfully.
headers:
Location:
type: string
description: >-
Location and ID of the model being trained. The status of model
training is specified in the status property at the model
location.
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Train custom model:
$ref: ./examples/TrainBatch.json
Train custom model with subfolder filter options:
$ref: ./examples/TrainBatchWithSubFolders.json
x-ms-long-running-operation: true
tags:
- Custom
/custom/models/{modelId}:
get:
summary: Microsoft Azure Get Custom Model
description: Get detailed information about a custom model.
operationId: microsoftAzureGetcustommodel
consumes: []
produces:
- application/json
parameters:
- name: modelId
in: path
description: Model identifier.
required: true
type: string
format: uuid
- name: includeKeys
in: query
description: Include list of extracted keys in model information.
required: false
default: false
type: boolean
x-nullable: false
responses:
'200':
description: Success
schema:
$ref: '#/definitions/Model'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get custom model:
$ref: ./examples/GetModel.json
tags:
- Custom
delete:
summary: Microsoft Azure Delete Custom Model
description: >-
Mark model for deletion. Model artifacts will be permanently removed
within a predetermined period.
operationId: microsoftAzureDeletecustommodel
consumes: []
produces:
- application/json
parameters:
- name: modelId
in: path
description: Model identifier.
required: true
type: string
format: uuid
responses:
'204':
description: >-
Successfully marked model for deletion. Model artifacts will be
removed within a predefined time period.
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Delete custom model:
$ref: ./examples/DeleteModel.json
tags:
- Custom
/custom/models/{modelId}/analyze:
post:
summary: Microsoft Azure Analyze Form
description: >-
Extract key-value pairs, tables, and semantic values from a given
document. The input document must be of one of the supported content
types - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' or
'image/bmp'. Alternatively, use 'application/json' type to specify the
location (Uri or local path) of the document to be analyzed.
operationId: microsoftAzureAnalyzewithcustommodel
consumes:
- application/pdf
- application/json
- image/jpeg
- image/png
- image/tiff
- image/bmp
produces:
- application/json
parameters:
- name: modelId
in: path
description: Model identifier.
required: true
type: string
format: uuid
- name: includeTextDetails
in: query
description: Include text lines and element references in the result.
required: false
default: false
type: boolean
x-nullable: false
- $ref: '#/parameters/Pages'
- $ref: '#/parameters/FileStream'
responses:
'202':
description: Request is queued successfully.
headers:
Operation-Location:
type: string
description: >-
URL containing the resultId used to track the progress and
obtain the result of the analyze operation.
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Analyze form with custom model:
$ref: ./examples/AnalyzeBatch.json
x-ms-long-running-operation: true
tags:
- Custom
/custom/models/{modelId}/analyzeResults/{resultId}:
get:
summary: Microsoft Azure Get Analyze Form Result
description: Obtain current status and the result of the analyze form operation.
operationId: microsoftAzureGetanalyzeformresult
consumes: []
produces:
- application/json
parameters:
- name: modelId
in: path
description: Model identifier.
required: true
type: string
format: uuid
- name: resultId
in: path
description: Analyze operation result identifier.
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/AnalyzeOperationResult'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get analyze form result:
$ref: ./examples/AnalyzeOperationResult.json
tags:
- Custom
/custom/models/{modelId}/copy:
post:
summary: Microsoft Azure Copy Custom Model
description: >-
Copy custom model stored in this resource (the source) to user specified
target Form Recognizer resource.
operationId: microsoftAzureCopycustommodel
consumes:
- application/json
produces:
- application/json
parameters:
- name: modelId
in: path
description: Model identifier.
required: true
type: string
format: uuid
- name: copyRequest
in: body
description: Copy request parameters.
required: true
schema:
$ref: '#/definitions/CopyRequest'
responses:
'202':
description: Copy request is queued successfully.
headers:
Operation-Location:
type: string
description: >-
URL containing the resultId used to track the progress and
obtain the result of the copy operation.
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Copy custom model:
$ref: ./examples/CopyModel.json
x-ms-long-running-operation: true
tags:
- Custom
/custom/models/{modelId}/copyResults/{resultId}:
get:
summary: Microsoft Azure Get Custom Model Copy Result
description: Obtain current status and the result of a custom model copy operation.
operationId: microsoftAzureGetcustommodelcopyresult
consumes: []
produces:
- application/json
parameters:
- name: modelId
in: path
description: Model identifier.
required: true
type: string
format: uuid
- name: resultId
in: path
description: Copy operation result identifier.
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/CopyOperationResult'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get copy custom model result:
$ref: ./examples/CopyOperationResult.json
Get copy custom model result with failures:
$ref: ./examples/CopyOperationResultWithErrors.json
tags:
- Custom
/custom/models/copyAuthorization:
post:
summary: Microsoft Azure Generate Copy Authorization
description: >-
Generate authorization to copy a model into the target Form Recognizer
resource.
operationId: microsoftAzureGeneratemodelcopyauthorization
consumes: []
produces:
- application/json
parameters: []
responses:
'201':
description: Copy request is authorized successfully.
headers:
Location:
type: string
description: >-
Location and ID of the model being copied. The status of model
copy is specified in the status property at the model location.
schema:
$ref: '#/definitions/CopyAuthorizationResult'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Copy custom model:
$ref: ./examples/CopyModelAuthorization.json
tags:
- Custom
/custom/models/compose:
post:
tags:
- Form
summary: 'Microsoft Azure Compose Trained With Labels Models Into One Composed Model'
description: >-
Compose request would include list of models ids.<br>It would validate
what all models either trained with labels model or composed
model.<br>It would validate limit of models put together.
operationId: microsoftAzureComposecustommodelsasync
consumes: []
produces:
- application/json
- text/json
parameters:
- name: composeRequest
in: body
description: Compose models
required: true
schema:
$ref: '#/definitions/ComposeRequest'
responses:
'201':
description: Request is queued successfully.
headers:
Location:
type: string
description: >-
Location and ID of the composed model. The status of composed
model is specified in the status property at the model location.
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Compose custom models:
$ref: ./examples/ComposeModels.json
x-ms-long-running-operation: true
/prebuilt/businessCard/analyze:
post:
summary: Microsoft Azure Analyze Business Card
description: >-
Extract field text and semantic values from a given business card
document. The input document must be of one of the supported content
types - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' or
'image/bmp'. Alternatively, use 'application/json' type to specify the
location (Uri) of the document to be analyzed.
operationId: microsoftAzureAnalyzebusinesscardasync
consumes:
- application/pdf
- application/json
- image/jpeg
- image/png
- image/tiff
- image/bmp
produces:
- application/json
parameters:
- name: includeTextDetails
in: query
description: Include text lines and element references in the result.
required: false
default: false
type: boolean
x-nullable: false
- $ref: '#/parameters/Locale'
- $ref: '#/parameters/Pages'
- $ref: '#/parameters/FileStream'
responses:
'202':
description: Request is queued successfully.
headers:
Operation-Location:
type: string
description: >-
URL containing the resultId used to track the progress and
obtain the result of the analyze operation.
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Analyze Business Card:
$ref: ./examples/BusinessCardBatch.json
x-ms-long-running-operation: true
tags:
- Prebuilt
/prebuilt/businessCard/analyzeResults/{resultId}:
get:
summary: Microsoft Azure Get Analyze Business Card Result
description: >-
Track the progress and obtain the result of the analyze business card
operation.
operationId: microsoftAzureGetanalyzebusinesscardresult
consumes: []
produces:
- application/json
parameters:
- name: resultId
in: path
description: Analyze operation result identifier.
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/AnalyzeOperationResult'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get analyze business card result:
$ref: ./examples/BusinessCardBatchResult.json
tags:
- Prebuilt
/prebuilt/invoice/analyze:
post:
summary: Microsoft Azure Analyze Invoice Document
description: >-
Extract field text and semantic values from a given invoice document.
The input document must be of one of the supported content types -
'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' or
'image/bmp'. Alternatively, use 'application/json' type to specify the
location (Uri) of the document to be analyzed.
operationId: microsoftAzureAnalyzeinvoiceasync
consumes:
- application/pdf
- application/json
- image/jpeg
- image/png
- image/tiff
- image/bmp
produces:
- application/json
parameters:
- name: includeTextDetails
in: query
description: Include text lines and element references in the result.
required: false
default: false
type: boolean
x-nullable: false
- $ref: '#/parameters/Locale'
- $ref: '#/parameters/Pages'
- $ref: '#/parameters/FileStream'
responses:
'202':
description: Request is queued successfully.
headers:
Operation-Location:
type: string
description: >-
URL containing the resultId used to track the progress and
obtain the result of the analyze operation.
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Analyze receipt:
$ref: ./examples/InvoiceBatch.json
x-ms-long-running-operation: true
tags:
- Prebuilt
/prebuilt/invoice/analyzeResults/{resultId}:
get:
summary: Microsoft Azure Get Analyze Invoice Result
description: >-
Track the progress and obtain the result of the analyze invoice
operation.
operationId: microsoftAzureGetanalyzeinvoiceresult
consumes: []
produces:
- application/json
parameters:
- name: resultId
in: path
description: Analyze operation result identifier.
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/AnalyzeOperationResult'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get analyze receipt result:
$ref: ./examples/InvoiceBatchResult.json
tags:
- Prebuilt
/prebuilt/idDocument/analyze:
post:
summary: Microsoft Azure Analyze Id Document
description: >-
Extract field text and semantic values from a given ID document. The
input document must be of one of the supported content types -
'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' or
'image/bmp'. Alternatively, use 'application/json' type to specify the
location (Uri) of the document to be analyzed.
operationId: microsoftAzureAnalyzeiddocumentasync
consumes:
- application/pdf
- application/json
- image/jpeg
- image/png
- image/tiff
- image/bmp
produces:
- application/json
parameters:
- name: includeTextDetails
in: query
description: Include text lines and element references in the result.
required: false
default: false
type: boolean
x-nullable: false
- $ref: '#/parameters/Pages'
- $ref: '#/parameters/FileStream'
responses:
'202':
description: Request is queued successfully.
headers:
Operation-Location:
type: string
description: >-
URL containing the resultId used to track the progress and
obtain the result of the analyze operation.
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Analyze ID:
$ref: ./examples/IDDocumentBatch.json
x-ms-long-running-operation: true
tags:
- Prebuilt
/prebuilt/idDocument/analyzeResults/{resultId}:
get:
summary: Microsoft Azure Get Analyze Id Document Result
description: Track the progress and obtain the result of the analyze ID operation.
operationId: microsoftAzureGetanalyzeiddocumentresult
consumes: []
produces:
- application/json
parameters:
- name: resultId
in: path
description: Analyze operation result identifier.
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/AnalyzeOperationResult'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get analyze ID result:
$ref: ./examples/IDDocumentBatchResult.json
tags:
- Prebuilt
/prebuilt/receipt/analyze:
post:
summary: Microsoft Azure Analyze Receipt
description: >-
Extract field text and semantic values from a given receipt document.
The input document must be of one of the supported content types -
'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' or
'image/bmp'. Alternatively, use 'application/json' type to specify the
location (Uri) of the document to be analyzed.
operationId: microsoftAzureAnalyzereceiptasync
consumes:
- application/pdf
- application/json
- image/jpeg
- image/png
- image/tiff
- image/bmp
produces:
- application/json
parameters:
- name: includeTextDetails
in: query
description: Include text lines and element references in the result.
required: false
default: false
type: boolean
x-nullable: false
- $ref: '#/parameters/Locale'
- $ref: '#/parameters/Pages'
- $ref: '#/parameters/FileStream'
responses:
'202':
description: Request is queued successfully.
headers:
Operation-Location:
type: string
description: >-
URL containing the resultId used to track the progress and
obtain the result of the analyze operation.
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Analyze receipt:
$ref: ./examples/ReceiptsBatch.json
x-ms-long-running-operation: true
tags:
- Prebuilt
/prebuilt/receipt/analyzeResults/{resultId}:
get:
summary: Microsoft Azure Get Analyze Receipt Result
description: >-
Track the progress and obtain the result of the analyze receipt
operation.
operationId: microsoftAzureGetanalyzereceiptresult
consumes: []
produces:
- application/json
parameters:
- name: resultId
in: path
description: Analyze operation result identifier.
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/AnalyzeOperationResult'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get analyze receipt result:
$ref: ./examples/ReceiptsBatchResult.json
tags:
- Prebuilt
/layout/analyze:
post:
summary: Microsoft Azure Analyze Layout
description: >-
Extract text and layout information from a given document. The input
document must be of one of the supported content types -
'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' or
'image/bmp'. Alternatively, use 'application/json' type to specify the
location (Uri or local path) of the document to be analyzed.
operationId: microsoftAzureAnalyzelayoutasync
consumes:
- application/pdf
- application/json
- image/jpeg
- image/png
- image/tiff
- image/bmp
produces:
- application/json
parameters:
- $ref: '#/parameters/FileStream'
- $ref: '#/parameters/Pages'
- $ref: '#/parameters/Language'
- $ref: '#/parameters/ReadingOrder'
responses:
'202':
description: Request is queued successfully.
headers:
Operation-Location:
type: string
description: >-
URL containing the resultId used to track the progress and
obtain the result of the analyze operation.
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Analyze layout:
$ref: ./examples/LayoutBatch.json
x-ms-long-running-operation: true
tags:
- Layout
/layout/analyzeResults/{resultId}:
get:
summary: Microsoft Azure Get Analyze Layout Result
description: Track the progress and obtain the result of the analyze layout operation
operationId: microsoftAzureGetanalyzelayoutresult
consumes: []
produces:
- application/json
parameters:
- name: resultId
in: path
description: Analyze operation result identifier.
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/AnalyzeOperationResult'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get analyze layout result:
$ref: ./examples/LayoutBatchResult.json
tags:
- Layout
x-ms-paths:
/custom/models?op=full:
get:
summary: List Custom Models
description: Get information about all custom models
operationId: ListCustomModels
consumes: []
produces:
- application/json
parameters:
- name: op
in: query
description: Specify whether to return summary or full list of models.
required: true
type: string
enum:
- full
responses:
'200':
description: Success
schema:
$ref: '#/definitions/Models'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
itemName: modelList
x-ms-examples:
List custom models:
$ref: ./examples/GetModels.json
/custom/models?op=summary:
get:
summary: Get Custom Models
description: Get information about all custom models
operationId: GetCustomModels
consumes: []
produces:
- application/json
parameters:
- name: op
in: query
description: Specify whether to return summary or full list of models.
required: true
type: string
enum:
- summary
responses:
'200':
description: Success
schema:
$ref: '#/definitions/Models'
default:
description: >-
Response entity accompanying non-successful responses containing
additional details about the error.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Get models summary:
$ref: ./examples/GetModelsSummary.json
definitions:
OperationStatus:
type: string
description: Status of the queued operation.
enum:
- notStarted
- running
- succeeded
- failed
x-ms-enum:
name: OperationStatus
modelAsString: false
x-nullable: false
CopyAuthorizationResult:
description: Request parameter that contains authorization claims for copy operation.
required:
- modelId
- accessToken
- expirationDateTimeTicks
type: object
properties:
modelId:
description: Model identifier.
type: string
accessToken:
description: Token claim used to authorize the request.
type: string
expirationDateTimeTicks:
description: >-
The time when the access token expires. The date is represented as the
number of seconds from 1970-01-01T0:0:0Z UTC until the expiration
time.
type: integer
format: int64
CopyRequest:
description: >-
Request parameter to copy an existing custom model from the source
resource to a target resource referenced by the resource ID.
required:
- targetResourceId
- targetResourceRegion
- copyAuthorization
type: object
properties:
targetResourceId:
description: >-
Azure Resource Id of the target Form Recognizer resource where the
model is copied to.
maxLength: 1024
type: string
pattern: >-
^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.CognitiveServices/accounts/[^/]*$
x-ms-azure-resource: true
targetResourceRegion:
description: >-
Location of the target Azure resource. A valid Azure region name
supported by Cognitive Services.
type: string
pattern: ^[a-z0-9]+$
minLength: 1
maxLength: 24
copyAuthorization:
description: Entity that encodes claims to authorize the copy request.
$ref: '#/definitions/CopyAuthorizationResult'
CopyOperationResult:
description: Status and result of the queued copy operation.
type: object
required:
- status
- createdDateTime
- lastUpdatedDateTime
properties:
status:
description: Operation status.
$ref: '#/definitions/OperationStatus'
createdDateTime:
format: date-time
description: Date and time (UTC) when the copy operation was submitted.
type: string
x-nullable: false
lastUpdatedDateTime:
format: date-time
description: Date and time (UTC) when the status was last updated.
type: string
x-nullable: false
copyResult:
description: Results of the copy operation.
$ref: '#/definitions/CopyResult'
CopyResult:
description: Custom model copy result.
type: object
required:
- modelId
properties:
modelId:
description: Identifier of the target model.
type: string
format: uuid
errors:
description: Errors returned during the copy operation.
type: array
items:
$ref: '#/definitions/ErrorInformation'
AnalyzeOperationResult:
description: Status and result of the queued analyze operation.
type: object
required:
- status
- createdDateTime
- lastUpdatedDateTime
properties:
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/form-recognizer-client-openapi-original.yml