Document Models - Build Model

Hizmet:

Azure AI Services

API Sürümü:

2024-11-30

Özel bir belge çözümleme modeli oluşturur.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (uri)	Belge Yönetim Bilgileri hizmet uç noktası.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
buildMode	True	DocumentBuildMode	Özel belge modeli derleme modu.
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Benzersiz belge modeli adı.
allowOverwrite		boolean	Aynı ada sahip mevcut bir modelin üzerine yazmaya izin verin.
azureBlobFileListSource		AzureBlobFileListContentSource	Eğitim verilerini belirten Azure Blob Depolama dosya listesi. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
azureBlobSource		AzureBlobContentSource	Eğitim verilerini içeren Azure Blob Depolama konumu. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
description		string maxLength: 4096	Belge modeli açıklaması.
maxTrainingHours		number (float)	Model eğitimi için kullanılacak en fazla V100 eşdeğer GPU saati sayısı. Varsayılan=0,5.
tags		object	Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

Yanıtlar

Name	Tür	Description
202 Accepted		İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı. Üst Bilgiler Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

Ocp-Apim-Subscription-Key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize
Belirteç URL'si: https://login.microsoftonline.com/common/oauth2/token

Kapsamlar

Name	Description
https://cognitiveservices.azure.com/.default

Örnekler

Build Document Model

Örnek isteği

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"
  }
}

Örnek yanıt

Durum kodu:

202

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

Tanımlar

Name	Description
AzureBlobContentSource	Azure Blob Depolama içeriği.
AzureBlobFileListContentSource	Azure Blob Depolama'daki dosya listesi.
BuildDocumentModelRequest	Yeni bir özel belge modeli oluşturmak için istek gövdesi.
DocumentBuildMode	Özel belge modeli derleme modu.
DocumentIntelligenceError	Hata nesnesi.
DocumentIntelligenceErrorResponse	Hata yanıtı nesnesi.
DocumentIntelligenceInnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne.

AzureBlobContentSource

Object

Azure Blob Depolama içeriği.

Name	Tür	Description
containerUrl	string (uri)	Azure Blob Depolama kapsayıcı URL'si.
prefix	string	Blob adı ön eki.

AzureBlobFileListContentSource

Object

Azure Blob Depolama'daki dosya listesi.

Name	Tür	Description
containerUrl	string (uri)	Azure Blob Depolama kapsayıcı URL'si.
fileList	string	Belgelerin alt kümesini belirten kapsayıcı içindeki bir JSONL dosyasının yolu.

BuildDocumentModelRequest

Object

Yeni bir özel belge modeli oluşturmak için istek gövdesi.

Name	Tür	Default value	Description
allowOverwrite	boolean	False	Aynı ada sahip mevcut bir modelin üzerine yazmaya izin verin.
azureBlobFileListSource	AzureBlobFileListContentSource		Eğitim verilerini belirten Azure Blob Depolama dosya listesi. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
azureBlobSource	AzureBlobContentSource		Eğitim verilerini içeren Azure Blob Depolama konumu. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
buildMode	DocumentBuildMode		Özel belge modeli derleme modu.
description	string maxLength: 4096		Belge modeli açıklaması.
maxTrainingHours	number (float)	0.5	Model eğitimi için kullanılacak en fazla V100 eşdeğer GPU saati sayısı. Varsayılan=0,5.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Benzersiz belge modeli adı.
tags	object		Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

DocumentBuildMode

Listeleme

Özel belge modeli derleme modu.

Değer	Description
template	Benzer görsel şablonlara sahip belgeleri hedefle.
neural	Çeşitli görsel şablonları olan belgeleri destekleyin.

DocumentIntelligenceError

Object

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	DocumentIntelligenceError[]	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
innererror	DocumentIntelligenceInnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

DocumentIntelligenceErrorResponse

Object

Hata yanıtı nesnesi.

Name	Tür	Description
error	DocumentIntelligenceError	Hata bilgileri.

DocumentIntelligenceInnerError

Object

Hata hakkında daha ayrıntılı bilgi içeren bir nesne.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
innererror	DocumentIntelligenceInnerError	İç hata.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.