Share via

Miscellaneous Operations - List Operations

  • Reference
Service:
Azure AI Services
API Version:
2024-11-30

Lists all operations.

GET {endpoint}/documentintelligence/operations?api-version=2024-11-30

URI Parameters

Name In Required Type Description
endpoint
 path True

string

uri

The Document Intelligence service endpoint.
api-version
 query True

string

The API version to use for this operation.

Request Header

Name Required Type Description
x-ms-client-request-id

string

uuid

An opaque, globally-unique, client-generated string identifier for the request.

Responses

Name Type Description
200 OK

PagedDocumentIntelligenceOperationDetails

The request has succeeded.

Headers

x-ms-client-request-id: string
Other Status Codes

DocumentIntelligenceErrorResponse

An unexpected error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

Name Description
https://cognitiveservices.azure.com/.default

Examples

Get Operations

Sample request

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?api-version=2024-11-30

Sample response

Status code:
200 
{
  "value": [
    {
      "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
      "apiVersion": "2024-11-30"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?nextLink=nextLinkData"
}

Definitions

Name Description
AzureBlobContentSource

Azure Blob Storage content.
AzureBlobFileListContentSource

File list in Azure Blob Storage.
ClassifierDocumentTypeDetails

Classifier document type info.
ContentSourceKind

Type of content source.
DocumentAnalysisFeature

Document analysis features to enable.
DocumentBuildMode

Custom document model build mode.
DocumentClassifierBuildOperationDetails

Get Operation response object.
DocumentClassifierCopyToOperationDetails

Get Operation response object.
DocumentClassifierDetails

Document classifier info.
DocumentFieldSchema

Description of the field semantic schema using a JSON Schema style syntax.
DocumentFieldType

Semantic data type of the field value.
DocumentIntelligenceError

The error object.
DocumentIntelligenceErrorResponse

Error response object.
DocumentIntelligenceInnerError

An object containing more specific information about the error.
DocumentIntelligenceOperationStatus

Operation status.
DocumentIntelligenceWarning

The error object.
DocumentModelBuildOperationDetails

Get Operation response object.
DocumentModelComposeOperationDetails

Get Operation response object.
DocumentModelCopyToOperationDetails

Get Operation response object.
DocumentModelDetails

Document model info.
DocumentTypeDetails

Document type info.
OperationKind

Type of operation.
PagedDocumentIntelligenceOperationDetails

Paged collection of DocumentIntelligenceOperationDetails items
SplitMode

File splitting behavior.

AzureBlobContentSource

Object

Azure Blob Storage content.

Name Type Description
containerUrl

string

Azure Blob Storage container URL.
prefix

string

Blob name prefix.

AzureBlobFileListContentSource

Object

File list in Azure Blob Storage.

Name Type Description
containerUrl

string

Azure Blob Storage container URL.
fileList

string

Path to a JSONL file within the container specifying a subset of documents.

ClassifierDocumentTypeDetails

Object

Classifier document type info.

Name Type Description
azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob Storage file list specifying the training data for a classifier document type. Either azureBlobSource or azureBlobFileListSource must be specified.
azureBlobSource

AzureBlobContentSource

Azure Blob Storage location containing the training data for a classifier document type. Either azureBlobSource or azureBlobFileListSource must be specified.
sourceKind

ContentSourceKind

Type of training data source.

ContentSourceKind

Enumeration

Type of content source.

Value Description
azureBlob

Files in a path within an Azure Blob Storage container.
azureBlobFileList

A file list specifying individual files in an Azure Blob Storage container.
base64

Content represented via Base64 encoding.
url

Content at a specific URL.

DocumentAnalysisFeature

Enumeration

Document analysis features to enable.

Value Description
barcodes

Enable the detection of barcodes in the document.
formulas

Enable the detection of mathematical expressions in the document.
keyValuePairs

Enable the detection of general key value pairs (form fields) in the document.
languages

Enable the detection of the text content language.
ocrHighResolution

Perform OCR at a higher resolution to handle documents with fine print.
queryFields

Enable the extraction of additional fields via the queryFields query parameter.
styleFont

Enable the recognition of various font styles.

DocumentBuildMode

Enumeration

Custom document model build mode.

Value Description
neural

Support documents with diverse visual templates.
template

Target documents with similar visual templates.

DocumentClassifierBuildOperationDetails

Object

Get Operation response object.

Name Type Description
apiVersion

string

API version used to create this operation.
createdDateTime

string

Date and time (UTC) when the operation was created.
error

DocumentIntelligenceError

Encountered error.
kind string:

documentClassifierBuild

Type of operation.
lastUpdatedDateTime

string

Date and time (UTC) when the status was last updated.
operationId

string

Operation ID
percentCompleted

integer

Operation progress (0-100).
resourceLocation

string

URL of the resource targeted by this operation.
result

DocumentClassifierDetails

Operation result upon success.
status

DocumentIntelligenceOperationStatus

Operation status. notStarted, running, completed, or failed
tags

object

List of key-value tag attributes associated with the document model.

DocumentClassifierCopyToOperationDetails

Object

Get Operation response object.

Name Type Description
apiVersion

string

API version used to create this operation.
createdDateTime

string

Date and time (UTC) when the operation was created.
error

DocumentIntelligenceError

Encountered error.
kind string:

documentClassifierCopyTo

Type of operation.
lastUpdatedDateTime

string

Date and time (UTC) when the status was last updated.
operationId

string

Operation ID
percentCompleted

integer

Operation progress (0-100).
resourceLocation

string

URL of the resource targeted by this operation.
result

DocumentClassifierDetails

Operation result upon success.
status

DocumentIntelligenceOperationStatus

Operation status. notStarted, running, completed, or failed
tags

object

List of key-value tag attributes associated with the document model.

DocumentClassifierDetails

Object

Document classifier info.

Name Type Description
apiVersion

string

API version used to create this document classifier.
baseClassifierId

string

Base classifierId on top of which the classifier was trained.
classifierId

string

Unique document classifier name.
createdDateTime

string

Date and time (UTC) when the document classifier was created.
description

string

Document classifier description.
docTypes

<string,  ClassifierDocumentTypeDetails>

List of document types to classify against.
expirationDateTime

string

Date and time (UTC) when the document classifier will expire.
modifiedDateTime

string

Date and time (UTC) when the document model was last modified.
warnings

DocumentIntelligenceWarning[]

List of warnings encountered while building the classifier.

DocumentFieldSchema

Object

Description of the field semantic schema using a JSON Schema style syntax.

Name Type Description
description

string

Field description.
example

string

Example field content.
items

DocumentFieldSchema

Field type schema of each array element.
properties

<string,  DocumentFieldSchema>

Named sub-fields of the object field.
type

DocumentFieldType

Semantic data type of the field value.

DocumentFieldType

Enumeration

Semantic data type of the field value.

Value Description
address

Parsed address.
array

List of subfields of the same type.
boolean

Boolean value, normalized to true or false.
countryRegion

Country/region, normalized to ISO 3166-1 alpha-3 format (ex. USA).
currency

Currency amount with optional currency symbol and unit.
date

Date, normalized to ISO 8601 (YYYY-MM-DD) format.
integer

Integer number, normalized to 64-bit signed integer.
number

Floating point number, normalized to double precision floating point.
object

Named list of subfields of potentially different types.
phoneNumber

Phone number, normalized to E.164 (+{CountryCode}{SubscriberNumber}) format.
selectionGroup

Array of selected string values.
selectionMark

Is field selected?
signature

Is signature present?
string

Plain text.
time

Time, normalized to ISO 8601 (hh:mm:ss) format.

DocumentIntelligenceError

Object

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.
details

DocumentIntelligenceError[]

An array of details about specific errors that led to this reported error.
innererror

DocumentIntelligenceInnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

DocumentIntelligenceErrorResponse

Object

Error response object.

Name Type Description
error

DocumentIntelligenceError

Error info.

DocumentIntelligenceInnerError

Object

An object containing more specific information about the error.

Name Type Description
code

string

One of a server-defined set of error codes.
innererror

DocumentIntelligenceInnerError

Inner error.
message

string

A human-readable representation of the error.

DocumentIntelligenceOperationStatus

Enumeration

Operation status.

Value Description
canceled

The operation has been canceled.
failed

The operation has failed.
notStarted

The operation has not started yet.
running

The operation is in progress.
skipped

The operation has been skipped.
succeeded

The operation has succeeded.

DocumentIntelligenceWarning

Object

The error object.

Name Type Description
code

string

One of a server-defined set of warning codes.
message

string

A human-readable representation of the warning.
target

string

The target of the error.

DocumentModelBuildOperationDetails

Object

Get Operation response object.

Name Type Description
apiVersion

string

API version used to create this operation.
createdDateTime

string

Date and time (UTC) when the operation was created.
error

DocumentIntelligenceError

Encountered error.
kind string:

documentModelBuild

Type of operation.
lastUpdatedDateTime

string

Date and time (UTC) when the status was last updated.
operationId

string

Operation ID
percentCompleted

integer

Operation progress (0-100).
resourceLocation

string

URL of the resource targeted by this operation.
result

DocumentModelDetails

Operation result upon success.
status

DocumentIntelligenceOperationStatus

Operation status. notStarted, running, completed, or failed
tags

object

List of key-value tag attributes associated with the document model.

DocumentModelComposeOperationDetails

Object

Get Operation response object.

Name Type Description
apiVersion

string

API version used to create this operation.
createdDateTime

string

Date and time (UTC) when the operation was created.
error

DocumentIntelligenceError

Encountered error.
kind string:

documentModelCompose

Type of operation.
lastUpdatedDateTime

string

Date and time (UTC) when the status was last updated.
operationId

string

Operation ID
percentCompleted

integer

Operation progress (0-100).
resourceLocation

string

URL of the resource targeted by this operation.
result

DocumentModelDetails

Operation result upon success.
status

DocumentIntelligenceOperationStatus

Operation status. notStarted, running, completed, or failed
tags

object

List of key-value tag attributes associated with the document model.

DocumentModelCopyToOperationDetails

Object

Get Operation response object.

Name Type Description
apiVersion

string

API version used to create this operation.
createdDateTime

string

Date and time (UTC) when the operation was created.
error

DocumentIntelligenceError

Encountered error.
kind string:

documentModelCopyTo

Type of operation.
lastUpdatedDateTime

string

Date and time (UTC) when the status was last updated.
operationId

string

Operation ID
percentCompleted

integer

Operation progress (0-100).
resourceLocation

string

URL of the resource targeted by this operation.
result

DocumentModelDetails

Operation result upon success.
status

DocumentIntelligenceOperationStatus

Operation status. notStarted, running, completed, or failed
tags

object

List of key-value tag attributes associated with the document model.

DocumentModelDetails

Object

Document model info.

Name Type Default value Description
apiVersion

string

API version used to create this document model.
azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob Storage file list specifying the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
azureBlobSource

AzureBlobContentSource

Azure Blob Storage location containing the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
buildMode

DocumentBuildMode

Custom document model build mode.
classifierId

string

For composed models, the custom classifier to split and classify the input file.
createdDateTime

string

Date and time (UTC) when the document model was created.
description

string

Document model description.
docTypes

<string,  DocumentTypeDetails>

Supported document types.
expirationDateTime

string

Date and time (UTC) when the document model will expire.
modelId

string

Unique document model name.
modifiedDateTime

string

Date and time (UTC) when the document model was last modified.
split

SplitMode

none

For composed models, the file splitting behavior.
tags

object

List of key-value tag attributes associated with the document model.
trainingHours

number

Number of V100-equivalent GPU hours consumed for model training.
warnings

DocumentIntelligenceWarning[]

List of warnings encountered while building the model.

DocumentTypeDetails

Object

Document type info.

Name Type Description
buildMode

DocumentBuildMode

Custom document model build mode.
confidenceThreshold

number

Only perform analysis if docType confidence is above threshold.
description

string

Document model description.
features

DocumentAnalysisFeature[]

List of optional analysis features.
fieldConfidence

object

Estimated confidence for each field.
fieldSchema

<string,  DocumentFieldSchema>

Description of the document semantic schema using a JSON Schema style syntax.
maxDocumentsToAnalyze

integer

Maximum number of documents of specified type to analyze. Default=all.
modelId

string

Document model to use for analyzing documents with specified type.
queryFields

string[]

List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber"

OperationKind

Enumeration

Type of operation.

Value Description
documentClassifierBuild

Build a new custom classifier model.
documentClassifierCopyTo

Copy an existing document classifier to potentially a different resource, region, or subscription.
documentModelBuild

Build a new custom document model.
documentModelCompose

Compose a new custom document model from existing models.
documentModelCopyTo

Copy an existing document model to potentially a different resource, region, or subscription.

PagedDocumentIntelligenceOperationDetails

Object

Paged collection of DocumentIntelligenceOperationDetails items

Name Type Description
nextLink

string

The link to the next page of items
value DocumentIntelligenceOperationDetails[]:

The DocumentIntelligenceOperationDetails items on this page

SplitMode

Enumeration

File splitting behavior.

Value Description
auto

Automatically split file into documents.
none

Treat the entire file as a single document.
perPage

Treat each page in the file as a separate document.