Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Membangun model analisis dokumen khusus.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir layanan Inteligensi Dokumen.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
buildMode	True	DocumentBuildMode	Mode build model dokumen kustom.
modelId	True	string	Nama model dokumen unik.
azureBlobFileListSource		AzureBlobFileListContentSource	Azure Blob Storage daftar file yang menentukan data pelatihan. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
azureBlobSource		AzureBlobContentSource	Azure Blob Storage lokasi yang berisi data pelatihan. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
description		string	Deskripsi model dokumen.
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. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Respons kesalahan yang tidak terduga.

Keamanan

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

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

Contoh

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

Definisi

Nama	Deskripsi
AzureBlobContentSource	Azure Blob Storage konten.
AzureBlobFileListContentSource	Daftar file di Azure Blob Storage.
BuildDocumentModelRequest	Minta isi untuk membangun model dokumen kustom baru.
DocumentBuildMode	Mode build model dokumen kustom.
Error	Objek kesalahan.
ErrorResponse	Objek respons kesalahan.
InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut.

AzureBlobContentSource

Azure Blob Storage konten.

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

AzureBlobFileListContentSource

Daftar file di Azure Blob Storage.

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

BuildDocumentModelRequest

Minta isi untuk membangun model dokumen kustom baru.

Nama	Jenis	Deskripsi
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage daftar file yang menentukan data pelatihan. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage lokasi yang berisi data pelatihan. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
buildMode	DocumentBuildMode	Mode build model dokumen kustom.
description	string	Deskripsi model dokumen.
modelId	string	Nama model dokumen unik.
tags	object	Daftar atribut tag nilai kunci yang terkait dengan model dokumen.

DocumentBuildMode

Mode build model dokumen kustom.

Nama	Jenis	Deskripsi
neural	string	Dokumen dukungan dengan templat visual yang beragam.
template	string	Menargetkan dokumen dengan templat visual serupa.

Error

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	InnerError	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.

ErrorResponse

Objek respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Info kesalahan.

InnerError

Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut.

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