Miscellaneous - List Operations

服務:

Azure AI Services

API 版本:

2022-08-31

清單 所有作業。

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus2.api.cognitive.microsoft.com) 。
api-version	query	True	ApiVersion	要求的 API 版本。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

回應

名稱	類型	Description
200 OK	GetOperationsResponse	正常。
Other Status Codes	ErrorResponse	發生錯誤。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

GetOperations

範例要求

HTTP

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

範例回覆

狀態碼:

200

{
  "value": [
    {
      "operationId": "{operationId}",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}",
      "apiVersion": "2022-08-31"
    }
  ],
  "nextLink": "{nextLinkUrl}"
}

定義

名稱	Description
ApiVersion	API 版本。
Error	錯誤資訊。
ErrorResponse	錯誤回應物件。
GetOperationsResponse	列出 Operations 回應物件。
InnerError	詳細的錯誤。
OperationKind	作業類型。
OperationStatus	作業狀態。
OperationSummary	作業資訊。

ApiVersion

API 版本。

名稱	類型	Description
2022-08-31	string

Error

錯誤資訊。

名稱	類型	Description
code	string	錯誤碼。
details	Error[]	詳細錯誤清單。
innererror	InnerError	詳細的錯誤。
message	string	錯誤訊息。
target	string	錯誤的目標。

ErrorResponse

錯誤回應物件。

名稱	類型	Description
error	Error	錯誤資訊。

GetOperationsResponse

列出 Operations 回應物件。

名稱	類型	Description
nextLink	string	連結至下一頁的作業。
value	OperationSummary[]	作業清單。

InnerError

詳細的錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	InnerError	詳細的錯誤。
message	string	錯誤訊息。

OperationKind

作業類型。

名稱	類型	Description
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

作業狀態。

名稱	類型	Description
canceled	string
failed	string
notStarted	string
running	string
succeeded	string

OperationSummary

作業資訊。

名稱	類型	Description
apiVersion	string	用來建立此作業的 API 版本。
createdDateTime	string	建立作業時的日期和時間 (UTC) 。
kind	OperationKind	作業類型。
lastUpdatedDateTime	string	上次更新狀態的日期和時間 (UTC) 。
operationId	string	作業識別碼
percentCompleted	integer	作業進度 (0-100) 。
resourceLocation	string	此作業的目標資源URL。
status	OperationStatus	作業狀態。
tags	object	與檔模型相關聯的索引鍵/值標籤屬性清單。