Document Models - Build Model

Layanan:

Azure AI Services

Versi API:

2024-11-30

Membangun model analisis dokumen kustom.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Titik akhir layanan Kecerdasan Dokumen.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
buildMode	True	DocumentBuildMode	Mode build model dokumen kustom.
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nama model dokumen unik.
allowOverwrite		boolean	Izinkan menimpa model yang ada dengan nama yang sama.
azureBlobFileListSource		AzureBlobFileListContentSource	Daftar file Azure Blob Storage yang menentukan data pelatihan. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
azureBlobSource		AzureBlobContentSource	Lokasi Azure Blob Storage yang berisi data pelatihan. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
description		string maxLength: 4096	Deskripsi model dokumen.
maxTrainingHours		number (float)	Jumlah maksimum jam GPU setara V100 yang digunakan untuk pelatihan model. Default=0.5.
tags		object	Daftar atribut tag nilai kunci yang terkait dengan model dokumen.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai. Header Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Respons kesalahan tak terduga.

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Build Document Model

Permintaan sampel

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

Respon sampel

Kode status:

202

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

Definisi

Nama	Deskripsi
AzureBlobContentSource	Konten Azure Blob Storage.
AzureBlobFileListContentSource	Daftar file di Azure Blob Storage.
BuildDocumentModelRequest	Minta isi untuk membangun model dokumen kustom baru.
DocumentBuildMode	Mode build model dokumen kustom.
DocumentIntelligenceError	Objek kesalahan.
DocumentIntelligenceErrorResponse	Objek respons kesalahan.
DocumentIntelligenceInnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan.

AzureBlobContentSource

Objek

Konten Azure Blob Storage.

Nama	Jenis	Deskripsi
containerUrl	string (uri)	URL kontainer Azure Blob Storage.
prefix	string	Awalan nama blob.

AzureBlobFileListContentSource

Objek

Daftar file di Azure Blob Storage.

Nama	Jenis	Deskripsi
containerUrl	string (uri)	URL kontainer Azure Blob Storage.
fileList	string	Jalur ke file JSONL dalam kontainer yang menentukan subset dokumen.

BuildDocumentModelRequest

Objek

Minta isi untuk membangun model dokumen kustom baru.

Nama	Jenis	Nilai default	Deskripsi
allowOverwrite	boolean	False	Izinkan menimpa model yang ada dengan nama yang sama.
azureBlobFileListSource	AzureBlobFileListContentSource		Daftar file Azure Blob Storage yang menentukan data pelatihan. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
azureBlobSource	AzureBlobContentSource		Lokasi Azure Blob Storage yang berisi data pelatihan. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
buildMode	DocumentBuildMode		Mode build model dokumen kustom.
description	string maxLength: 4096		Deskripsi model dokumen.
maxTrainingHours	number (float)	0.5	Jumlah maksimum jam GPU setara V100 yang digunakan untuk pelatihan model. Default=0.5.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Nama model dokumen unik.
tags	object		Daftar atribut tag nilai kunci yang terkait dengan model dokumen.

DocumentBuildMode

Enumeration

Mode build model dokumen kustom.

Nilai	Deskripsi
neural	Mendukung dokumen dengan templat visual yang beragam.
template	Dokumen target dengan templat visual serupa.

DocumentIntelligenceError

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	DocumentIntelligenceError[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	DocumentIntelligenceInnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

DocumentIntelligenceErrorResponse

Objek

Objek respons kesalahan.

Nama	Jenis	Deskripsi
error	DocumentIntelligenceError	Info kesalahan.

DocumentIntelligenceInnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	DocumentIntelligenceInnerError	Kesalahan dalam.
message	string	Representasi kesalahan yang dapat dibaca manusia.