Analyzers - Get Operation Status

Service:

Azure AI Services

API Version:

2024-12-01-preview

Get the status of an analyzer creation operation.

GET {endpoint}/contentunderstanding/analyzers/{analyzerId}/operations/{operationId}?api-version=2024-12-01-preview

URI Parameters

Name	In	Required	Type	Description
analyzerId	path	True	string	The unique identifier of the analyzer. Regex pattern: ^[a-zA-Z0-9._-]{1,64}$
endpoint	path	True	string uri	Content Understanding service endpoint.
operationId	path	True	string	The unique ID of the operation.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK		The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

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 Analyzer Operation Status

Sample request

HTTP

GET {endpoint}/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-12-01-preview

Sample response

Status code:

200

{
  "id": "3b31320d-8bab-4f88-b19c-2322a7f11034",
  "status": "Succeeded",
  "result": {
    "analyzerId": "myAnalyzer",
    "description": "My custom analyzer",
    "tags": {
      "createdBy": "John"
    },
    "status": "creating",
    "createdAt": "2024-10-14T18:46:36.051Z",
    "lastModifiedAt": "2024-10-14T18:46:36.051Z",
    "baseAnalyzerId": "prebuilt-document",
    "config": {
      "locales": null,
      "enableFace": false,
      "enableOcr": true,
      "enableLayout": true,
      "enableBarcode": true,
      "enableFormula": false,
      "returnDetails": true
    },
    "fieldSchema": {
      "name": "MyForm",
      "description": "My custom form",
      "fields": {
        "Company": {
          "type": "string",
          "description": "Name of company."
        }
      },
      "definitions": {}
    },
    "trainingData": {
      "kind": "blob",
      "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
      "prefix": "trainingData",
      "fileListPath": "trainingData/fileList.jsonl"
    }
  }
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Azure.Core.Foundations.Error

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	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.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.