Miscellaneous - Get Operation

參考

Service:: Azure AI Services

API Version:: 2023-07-31

取得作業資訊。

GET {endpoint}/formrecognizer/operations/{operationId}?api-version=2023-07-31

URI 參數

名稱位於必要類型 Description

名稱	位於	必要	類型	Description
endpoint	path	True	string url	支援的認知服務端點 (通訊協定和主機名，例如： https://westus2.api.cognitive.microsoft.com) 。
operationId	path	True	string uuid	唯一作業標識碼。 Regex pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`
api-version	query	True	string	要求的 API 版本。

endpoint

path

True

string

url

支援的認知服務端點 (通訊協定和主機名，例如： https://westus2.api.cognitive.microsoft.com) 。

operationId

path

True

string

uuid

唯一作業標識碼。

Regex pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

api-version

query

True

string

要求的 API 版本。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	Azure 認知服務訂用帳戶的秘密密鑰。

回應

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

安全性

Ocp-Apim-Subscription-Key

Azure 認知服務訂用帳戶的秘密密鑰。

Type: apiKey
In: header

範例

Get Operation

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Sample Response

Status code:: 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": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2023-07-31"
  }
}

定義

名稱	Description
AzureBlobContentSource	Azure Blob 儲存體內容。
AzureBlobFileListContentSource	Azure Blob 儲存體中的檔案清單。
ClassifierDocumentTypeDetails	分類器檔類型資訊。
DocumentBuildMode	自訂檔案模型建置模式。
DocumentClassifierBuildOperationDetails	取得 Operation 回應物件。
DocumentClassifierDetails	檔分類器資訊。
DocumentFieldSchema	使用 JSON 架構樣式語法的欄位語意架構描述。
DocumentFieldType	域值的語意數據類型。
DocumentModelBuildOperationDetails	取得 Operation 回應物件。
DocumentModelComposeOperationDetails	取得 Operation 回應物件。
DocumentModelCopyToOperationDetails	取得 Operation 回應物件。
DocumentModelDetails	檔模型資訊。
DocumentTypeDetails	檔類型資訊。
Error	錯誤資訊。
ErrorResponse	錯誤回應物件。
InnerError	詳細的錯誤。
OperationStatus	作業狀態。

AzureBlobContentSource

Azure Blob 儲存體內容。

名稱	類型	Description
containerUrl	string	Azure Blob 儲存體容器 URL。
prefix	string	Blob 名稱前置詞。

AzureBlobFileListContentSource

Azure Blob 儲存體中的檔案清單。

名稱	類型	Description
containerUrl	string	Azure Blob 儲存體容器 URL。
fileList	string	容器中 JSONL 檔案的路徑，指定用於定型的檔案子集。

ClassifierDocumentTypeDetails

分類器檔類型資訊。

名稱	類型	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob 儲存體檔案清單，指定分類器檔類型的定型數據。必須指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource	Azure Blob 儲存體位置，其中包含分類器檔類型的定型數據。必須指定 azureBlobSource 或 azureBlobFileListSource。

DocumentBuildMode

自訂檔案模型建置模式。

名稱	類型	Description
neural	string	支援具有各種視覺範本的檔。
template	string	以類似視覺效果範本為目標的檔。

DocumentClassifierBuildOperationDetails

取得 Operation 回應物件。

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

DocumentClassifierDetails

檔分類器資訊。

名稱	類型	Description
apiVersion	string	用來建立此文件分類器的 API 版本。
classifierId	string	唯一的檔分類器名稱。
createdDateTime	string	建立文件分類器的日期和時間 (UTC) 。
description	string	檔分類器描述。
docTypes	<string, ClassifierDocumentTypeDetails>	要分類的檔案類型清單。
expirationDateTime	string	檔分類器到期時的日期和時間 (UTC) 。

DocumentFieldSchema

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

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

DocumentFieldType

域值的語意數據類型。

名稱	類型	Description
address	string	剖析的位址。
array	string	相同類型的子欄位清單。
boolean	string	布爾值，標準化為 true 或 false。
countryRegion	string	國家/地區，標準化為 ISO 3166-1 alpha-3 格式 (，例如美國) 。
currency	string	具有選擇性貨幣符號和單位的貨幣金額。
date	string	日期，標準化為 ISO 8601 (YYYY-MM-DD) 格式。
integer	string	整數數位，標準化為64位帶正負號的整數。
number	string	浮點數，標準化為雙精確度浮點數。
object	string	可能不同類型的子欄位具名清單。
phoneNumber	string	電話號碼，標準化為 E.164 (+{CountryCode}{SubscriberNumber}) 格式。
selectionMark	string	是否已選取欄位？
signature	string	簽章是否存在？
string	string	純文字。
time	string	標準化為 ISO 8601 (hh：mm：ss) 格式的時間。

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>	支援的檔案類型。
expirationDateTime	string	檔模型到期時的日期和時間 (UTC) 。
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	此作業已成功。

共用方式為

Miscellaneous - Get Operation

URI 參數

要求標頭

回應

安全性

Ocp-Apim-Subscription-Key

範例

Get Operation

Sample Request

Sample Response

定義

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

DocumentBuildMode

DocumentClassifierBuildOperationDetails

DocumentClassifierDetails

DocumentFieldSchema

DocumentFieldType

DocumentModelBuildOperationDetails

DocumentModelComposeOperationDetails

DocumentModelCopyToOperationDetails

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

OperationStatus

其他資源