Document Models - Build Model

Service:

Azure AI Services

API Version:

2023-07-31

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

POST {endpoint}/formrecognizer/documentModels:build?api-version=2023-07-31

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string url	Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve konak adı, örneğin: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	İstenen API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
Ocp-Apim-Subscription-Key	True	string	Azure Bilişsel Hizmetler aboneliğinizin gizli anahtarı.

İ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 konumu Azure Blob Depolama. 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 başarıyla kuyruğa alındı. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Hatayla karşılaşıldı.

Güvenlik

Ocp-Apim-Subscription-Key

Azure Bilişsel Hizmetler aboneliğinizin gizli anahtarı.

Type: apiKey
In: header

Örnekler

Build Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:build?api-version=2023-07-31

{
  "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/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

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 bilgileri.
ErrorResponse	Hata yanıtı nesnesi.
InnerError	Ayrıntılı hata.

AzureBlobContentSource

İçeriği Azure Blob Depolama.

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

AzureBlobFileListContentSource

Azure Blob Depolama dosya listesi.

Name	Tür	Description
containerUrl	string	Kapsayıcı URL'lerini Azure Blob Depolama.
fileList	string	Eğitim için belgelerin bir alt kümesini belirten kapsayıcı içindeki bir 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 konumu Azure Blob Depolama. 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 belgeleri hedefle.

Error

Hata bilgileri.

Name	Tür	Description
code	string	Hata kodu.
details	Error[]	Ayrıntılı hataların listesi.
innererror	InnerError	Ayrıntılı hata.
message	string	Hata iletisi.
target	string	Hatanın hedefi.

ErrorResponse

Hata yanıtı nesnesi.

Name	Tür	Description
error	Error	Hata bilgileri.

InnerError

Ayrıntılı hata.

Name	Tür	Description
code	string	Hata kodu.
innererror	InnerError	Ayrıntılı hata.
message	string	Hata iletisi.