Document Models - Build Model

服務:

Azure AI Services

API 版本:

2024-11-30

建置自定義檔分析模型。

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-11-30

URI 參數

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

要求本文

名稱	必要	類型	Description
buildMode	True	DocumentBuildMode	自訂檔案模型建置模式。
modelId	True	string	唯一的檔模型名稱。
allowOverwrite		boolean	允許以相同名稱覆寫現有的模型。
azureBlobFileListSource		AzureBlobFileListContentSource	指定定型數據的 Azure Blob 記憶體檔案清單。 必須指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource		AzureBlobContentSource	包含定型數據的 Azure Blob 記憶體位置。 必須指定 azureBlobSource 或 azureBlobFileListSource。
description		string	檔模型描述。
maxTrainingHours		number	用於模型定型的 V100 對等 GPU 時數上限。 Default=0.5。
tags		object	與檔模型相關聯的索引鍵/值標籤屬性清單。

回應

名稱	類型	Description
202 Accepted		要求已接受進行處理，但尚未完成處理。 標題 Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	未預期的錯誤回應。

安全性

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

範例

Build Document Model

範例要求

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-11-30

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "buildMode": "template",
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

範例回覆

狀態碼:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30

定義

名稱	Description
AzureBlobContentSource	Azure Blob 記憶體內容。
AzureBlobFileListContentSource	Azure Blob 記憶體中的檔案清單。
BuildDocumentModelRequest	要求本文以建置新的自定義檔模型。
DocumentBuildMode	自訂檔案模型建置模式。
DocumentIntelligenceError	error 物件。
DocumentIntelligenceErrorResponse	錯誤回應物件。
DocumentIntelligenceInnerError	物件，包含有關錯誤的更特定資訊。

AzureBlobContentSource

Azure Blob 記憶體內容。

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

AzureBlobFileListContentSource

Azure Blob 記憶體中的檔案清單。

名稱	類型	Description
containerUrl	string	Azure Blob 記憶體容器 URL。
fileList	string	指定文件子集之容器內的 JSONL 檔案路徑。

BuildDocumentModelRequest

要求本文以建置新的自定義檔模型。

名稱	類型	預設值	Description
allowOverwrite	boolean	False	允許以相同名稱覆寫現有的模型。
azureBlobFileListSource	AzureBlobFileListContentSource		指定定型數據的 Azure Blob 記憶體檔案清單。 必須指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource		包含定型數據的 Azure Blob 記憶體位置。 必須指定 azureBlobSource 或 azureBlobFileListSource。
buildMode	DocumentBuildMode		自訂檔案模型建置模式。
description	string		檔模型描述。
maxTrainingHours	number	0.5	用於模型定型的 V100 對等 GPU 時數上限。 Default=0.5。
modelId	string		唯一的檔模型名稱。
tags	object		與檔模型相關聯的索引鍵/值標籤屬性清單。

DocumentBuildMode

自訂檔案模型建置模式。

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

DocumentIntelligenceError

error 物件。

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

DocumentIntelligenceErrorResponse

錯誤回應物件。

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

DocumentIntelligenceInnerError

物件，包含有關錯誤的更特定資訊。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	DocumentIntelligenceInnerError	內部錯誤。
message	string	錯誤的人類可讀取表示法。