Analyzers - Get Operation Status

服務:

Azure AI Services

API 版本:

2024-12-01-preview

取得分析器建立作業的狀態。

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

URI 參數

名稱	位於	必要	類型	Description
analyzerId	path	True	string	分析器的唯一標識碼。 Regex 模式: ^[a-zA-Z0-9._-]{1,64}$
endpoint	path	True	string uri	Content Understanding 服務端點。
operationId	path	True	string	作業的唯一標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK		要求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: accessCode
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize
權杖 URL: https://login.microsoftonline.com/common/oauth2/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Get Analyzer Operation Status

範例要求

HTTP

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

範例回覆

狀態碼:

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"
    }
  }
}

定義

名稱	Description
Azure.Core.Foundations.Error	error 物件。
Azure.Core.Foundations.ErrorResponse	包含錯誤詳細數據的回應。
Azure.Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

Azure.Core.Foundations.Error

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。