Miscellaneous - Get Operation

服務:

Azure AI Services

API 版本:

2022-08-31

取得作業資訊。

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

URI 參數

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

要求標頭

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

回應

名稱	類型	Description
200 OK	OperationDetails: DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	正常。
Other Status Codes	ErrorResponse	發生錯誤。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

GetOperation

範例要求

HTTP

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

範例回覆

狀態碼:

200

{
  "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}",
  "result": {
    "modelId": "{customModelId}",
    "description": "{customModelDescription}",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2022-08-31"
  }
}

定義

名稱	Description
ApiVersion	API 版本。
DocumentBuildMode	自訂檔案模型建置模式。
DocumentFieldSchema	使用 JSON 架構樣式語法的欄位語意架構描述。
DocumentFieldType	域值的語意數據類型。
DocumentModelBuildOperationDetails	取得 Operation 回應物件。
DocumentModelComposeOperationDetails	取得 Operation 回應物件。
DocumentModelCopyToOperationDetails	取得 Operation 回應物件。
DocumentModelDetails	檔模型資訊。
DocumentTypeDetails	檔類型資訊。
Error	錯誤資訊。
ErrorResponse	錯誤回應物件。
InnerError	詳細的錯誤。
OperationStatus	作業狀態。

ApiVersion

API 版本。

名稱	類型	Description
2022-08-31	string

DocumentBuildMode

自訂檔案模型建置模式。

名稱	類型	Description
neural	string
template	string

DocumentFieldSchema

使用 JSON 架構樣式語法的欄位語意架構描述。

名稱	類型	Description
description	string	欄位描述。
example	string	範例欄位內容。
items	DocumentFieldSchema	每個數位型態架構。
properties	<string,  DocumentFieldSchema>	物件欄位的具名子欄位。
type	DocumentFieldType	域值的語意數據類型。

DocumentFieldType

域值的語意數據類型。

名稱	類型	Description
address	string
array	string
countryRegion	string
currency	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
signature	string
string	string
time	string

DocumentModelBuildOperationDetails

取得 Operation 回應物件。

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

DocumentModelComposeOperationDetails

取得 Operation 回應物件。

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

DocumentModelCopyToOperationDetails

取得 Operation 回應物件。

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

DocumentModelDetails

檔模型資訊。

名稱	類型	Description
apiVersion	string	用來建立此檔模型的 API 版本。
createdDateTime	string	建立檔模型時的日期和時間 (UTC) 。
description	string	檔模型描述。
docTypes	<string,  DocumentTypeDetails>	支援的檔案類型。
modelId	string	唯一的檔模型名稱。
tags	object	與檔模型相關聯的索引鍵/值標籤屬性清單。

DocumentTypeDetails

檔類型資訊。

名稱	類型	Description
buildMode	DocumentBuildMode	自訂檔案模型建置模式。
description	string	檔模型描述。
fieldConfidence	object	每個欄位的估計信賴度。
fieldSchema	<string,  DocumentFieldSchema>	使用 JSON 架構樣式語法的檔語意架構描述。

Error

錯誤資訊。

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

ErrorResponse

錯誤回應物件。

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

InnerError

詳細的錯誤。

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

OperationStatus

作業狀態。

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