Document Models - Build Model

Service:

Azure AI Services

API Version:

2023-07-31

Membangun model analisis dokumen khusus.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string url	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Versi API yang diminta.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string	Kunci rahasia untuk langganan Azure Cognitive Services Anda.

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 berhasil diantrekan. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Terjadi kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Kunci rahasia untuk langganan Azure Cognitive Services Anda.

Type: apiKey
In: header

Contoh

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

Definisi

Nama	Deskripsi
AzureBlobContentSource	Azure Blob Storage konten.
AzureBlobFileListContentSource	Daftar file dalam Azure Blob Storage.
BuildDocumentModelRequest	Minta isi untuk membangun model dokumen kustom baru.
DocumentBuildMode	Mode build model dokumen kustom.
Error	Info kesalahan.
ErrorResponse	Objek respons kesalahan.
InnerError	Kesalahan terperinci.

AzureBlobContentSource

Azure Blob Storage konten.

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

AzureBlobFileListContentSource

Daftar file dalam 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 untuk pelatihan.

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

Info kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
details	Error[]	Daftar kesalahan terperinci.
innererror	InnerError	Kesalahan terperinci.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Info kesalahan.

InnerError

Kesalahan terperinci.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
innererror	InnerError	Kesalahan terperinci.
message	string	Pesan kesalahan.