Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-02-29-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	Belge Yönetim Bilgileri hizmeti uç noktası.
api-version	query	True	string	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	Benzersiz belge modeli adı.
azureBlobFileListSource		AzureBlobFileListContentSource	Eğitim verilerini belirten dosya listesini Azure Blob Depolama. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
azureBlobSource		AzureBlobContentSource	Eğitim verilerini içeren Azure Blob Depolama konum. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
description		string	Belge modeli açıklaması.
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ı. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

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

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

Örnekler

Build Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-02-29-preview

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

Sample Response

Status code:

202

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

Tanımlar

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

AzureBlobContentSource

İçeriği Azure Blob Depolama.

Name	Tür	Description
containerUrl	string	Kapsayıcı URL'sini Azure Blob Depolama.
prefix	string	Blob adı ön eki.

AzureBlobFileListContentSource

Azure Blob Depolama dosya listesi.

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

BuildDocumentModelRequest

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

Name	Tür	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Eğitim verilerini belirten dosya listesini Azure Blob Depolama. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
azureBlobSource	AzureBlobContentSource	Eğitim verilerini içeren Azure Blob Depolama konum. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
buildMode	DocumentBuildMode	Özel belge modeli derleme modu.
description	string	Belge modeli açıklaması.
modelId	string	Benzersiz belge modeli adı.
tags	object	Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

DocumentBuildMode

Özel belge modeli derleme modu.

Name	Tür	Description
neural	string	Çeşitli görsel şablonları olan belgeleri destekleyin.
template	string	Benzer görsel şablonları olan hedef belgeler.

Error

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi.
innererror	InnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilen bir gösterimi.
target	string	Hatanın hedefi.

ErrorResponse

Hata yanıtı nesnesi.

Name	Tür	Description
error	Error	Hata bilgileri.

InnerError

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	InnerError	İç hata.
message	string	Hatanın insan tarafından okunabilen bir gösterimi.