Miscellaneous Operations - List Operations

參考

Service:: Azure AI Services

API Version:: 2024-02-29-preview

清單所有作業。

GET {endpoint}/documentintelligence/operations?api-version=2024-02-29-preview

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	Document Intelligence 服務端點。
api-version	query	True	string	用於此作業的 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	要求的不透明、全域唯一、用戶端產生的字串標識碼。

回應

名稱	類型	Description
200 OK	PagedOperationDetails	要求成功。 Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	非預期的錯誤回應。

名稱

類型

Description

200 OK

PagedOperationDetails

要求成功。

Headers

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

非預期的錯誤回應。

安全性

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

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

範例

Get Operations

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?api-version=2024-02-29-preview

Sample Response

Status code:: 200

{
  "value": [
    {
      "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
      "apiVersion": "2024-02-29-preview"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?nextLink=nextLinkData"
}

定義

名稱	Description
AzureBlobContentSource	Azure Blob 儲存體內容。
AzureBlobFileListContentSource	Azure Blob 儲存體中的檔案清單。
ClassifierDocumentTypeDetails	分類器檔類型資訊。
ContentSourceKind	內容類型。
DocumentBuildMode	自訂檔案模型建置模式。
DocumentClassifierBuildOperationDetails	取得 Operation 回應物件。
DocumentClassifierDetails	檔分類器資訊。
DocumentFieldSchema	使用 JSON 架構樣式語法的欄位語意架構描述。
DocumentFieldType	域值的語意數據類型。
DocumentModelBuildOperationDetails	取得 Operation 回應物件。
DocumentModelComposeOperationDetails	取得 Operation 回應物件。
DocumentModelCopyToOperationDetails	取得 Operation 回應物件。
DocumentModelDetails	檔模型資訊。
DocumentTypeDetails	檔類型資訊。
Error	錯誤物件。
ErrorResponse	錯誤回應物件。
InnerError	物件，包含有關錯誤的更特定資訊。
OperationKind	作業類型。
OperationStatus	作業狀態。
PagedOperationDetails	OperationDetails 專案的分頁集合
Warning	error 物件。

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。
sourceKind	ContentSourceKind	定型數據源的類型。

ContentSourceKind

內容類型。

名稱	類型	Description
azureBlob	string	Azure Blob 儲存體容器內路徑中的檔案。
azureBlobFileList	string	指定 Azure Blob 儲存體容器中個別檔案的檔案清單。
base64	string	透過Base64編碼表示的內容。
url	string	特定 URL 的內容。

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	作業狀態。 notStarted、running、completed 或 failed
tags	object	與檔模型相關聯的索引鍵/值標籤屬性清單。

DocumentClassifierDetails

檔分類器資訊。

名稱	類型	Description
apiVersion	string	用來建立此文件分類器的 API 版本。
baseClassifierId	string	分類器定型的基底分類器標識碼。
classifierId	string	唯一的檔分類器名稱。
createdDateTime	string	檔分類器建立時的日期和時間 (UTC) 。
description	string	檔分類器描述。
docTypes	<string, ClassifierDocumentTypeDetails>	要分類的檔案類型清單。
expirationDateTime	string	檔分類器到期的日期和時間 (UTC) 。
warnings	Warning[]	建置分類器時遇到的警告清單。

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}) 格式。
selectionGroup	string	選取字串值的陣列。
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	作業狀態。 notStarted、running、completed 或 failed
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	作業狀態。 notStarted、running、completed 或 failed
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	作業狀態。 notStarted、running、completed 或 failed
tags	object	與檔模型相關聯的索引鍵/值標籤屬性清單。

DocumentModelDetails

檔模型資訊。

名稱	類型	Description
apiVersion	string	用來建立此檔模型的 API 版本。
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob 儲存體指定定型資料的檔案清單。必須指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource	包含定型數據 Azure Blob 儲存體位置。必須指定 azureBlobSource 或 azureBlobFileListSource。
buildMode	DocumentBuildMode	自訂檔案模型建置模式。
createdDateTime	string	建立檔模型時的日期和時間 (UTC) 。
description	string	檔模型描述。
docTypes	<string, DocumentTypeDetails>	支援的檔案類型。
expirationDateTime	string	檔模型到期時的日期和時間 (UTC) 。
modelId	string	唯一的檔模型名稱。
tags	object	與檔模型相關聯的索引鍵/值標籤屬性清單。
warnings	Warning[]	建置模型時遇到的警告清單。

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	人類看得懂的錯誤表示法。

OperationKind

作業類型。

名稱	類型	Description
documentClassifierBuild	string	建置新的自定義分類器模型。
documentModelBuild	string	建置新的自定義檔模型。
documentModelCompose	string	從現有的模型撰寫新的自定義檔模型。
documentModelCopyTo	string	將現有的檔模型複製到可能不同的資源、區域或訂用帳戶。

OperationStatus

作業狀態。

名稱	類型	Description
canceled	string	作業已取消。
completed	string	作業已完成。
failed	string	作業失敗。
notStarted	string	作業尚未啟動。
running	string	作業正在進行中。
succeeded	string	此作業已成功。

PagedOperationDetails

OperationDetails 專案的分頁集合

名稱	類型	Description
nextLink	string	專案下一頁的連結
value	OperationDetails[]: DocumentClassifierBuildOperationDetails[] DocumentModelBuildOperationDetails[] DocumentModelComposeOperationDetails[] DocumentModelCopyToOperationDetails[]	此頁面上的 OperationDetails 專案

Warning

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的警告碼。
message	string	人類可讀的警告表示法。
target	string	錯誤的目標。

共用方式為

Miscellaneous Operations - List Operations

URI 參數

要求標頭

回應

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

Scopes

範例

Get Operations

Sample Request

Sample Response

定義

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentBuildMode

DocumentClassifierBuildOperationDetails

DocumentClassifierDetails

DocumentFieldSchema

DocumentFieldType

DocumentModelBuildOperationDetails

DocumentModelComposeOperationDetails

DocumentModelCopyToOperationDetails

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

OperationKind

OperationStatus

PagedOperationDetails

Warning

其他資源