Document Models - Compose Model

Layanan:

Azure AI Services

Versi API:

2024-11-30

Membuat model dokumen baru dari tipe dokumen model dokumen yang sudah ada.

POST {endpoint}/documentintelligence/documentModels:compose?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
classifierId	True	string	Pengklasifikasi kustom untuk membagi dan mengklasifikasikan file input.
docTypes	True	<string,  DocumentTypeDetails>	Pemetaan kamus yang didukung docTypes ke model dokumen yang sesuai.
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nama model dokumen unik.
description		string maxLength: 4096	Deskripsi model dokumen.
split		SplitMode	Perilaku pemisahan file.
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

Compose Document Model

Permintaan sampel

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-11-30

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "classifierId": "customClassifier",
  "docTypes": {
    "formA": {
      "modelId": "model1"
    },
    "formB": {
      "modelId": "model2"
    }
  }
}

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
ComposeDocumentModelRequest	Minta isi untuk membuat model dokumen yang disusam dari model dokumen komponen.
DocumentAnalysisFeature	Fitur analisis dokumen untuk diaktifkan.
DocumentBuildMode	Mode build model dokumen kustom.
DocumentFieldSchema	Deskripsi skema semantik bidang menggunakan sintaks gaya Skema JSON.
DocumentFieldType	Jenis data semantik dari nilai bidang.
DocumentIntelligenceError	Objek kesalahan.
DocumentIntelligenceErrorResponse	Objek respons kesalahan.
DocumentIntelligenceInnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan.
DocumentTypeDetails	Info jenis dokumen.
SplitMode	Perilaku pemisahan file.

ComposeDocumentModelRequest

Objek

Minta isi untuk membuat model dokumen yang disusam dari model dokumen komponen.

Nama	Jenis	Nilai default	Deskripsi
classifierId	string		Pengklasifikasi kustom untuk membagi dan mengklasifikasikan file input.
description	string maxLength: 4096		Deskripsi model dokumen.
docTypes	<string,  DocumentTypeDetails>		Pemetaan kamus yang didukung docTypes ke model dokumen yang sesuai.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Nama model dokumen unik.
split	SplitMode	none	Perilaku pemisahan file.
tags	object		Daftar atribut tag nilai kunci yang terkait dengan model dokumen.

DocumentAnalysisFeature

Enumeration

Fitur analisis dokumen untuk diaktifkan.

Nilai	Deskripsi
barcodes	Aktifkan deteksi kode batang dalam dokumen.
formulas	Aktifkan deteksi ekspresi matematika dalam dokumen.
keyValuePairs	Aktifkan deteksi pasangan nilai kunci umum (bidang formulir) dalam dokumen.
languages	Aktifkan deteksi bahasa konten teks.
ocrHighResolution	Lakukan OCR pada resolusi yang lebih tinggi untuk menangani dokumen dengan cetakan halus.
queryFields	Aktifkan ekstraksi bidang tambahan melalui parameter kueri queryFields.
styleFont	Aktifkan pengenalan berbagai gaya font.

DocumentBuildMode

Enumeration

Mode build model dokumen kustom.

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

DocumentFieldSchema

Objek

Deskripsi skema semantik bidang menggunakan sintaks gaya Skema JSON.

Nama	Jenis	Deskripsi
description	string maxLength: 4096	Deskripsi bidang.
example	string	Contoh konten bidang.
items	DocumentFieldSchema	Skema jenis bidang dari setiap elemen array.
properties	<string,  DocumentFieldSchema>	Sub-bidang bernama bidang objek.
type	DocumentFieldType	Jenis data semantik dari nilai bidang.

DocumentFieldType

Enumeration

Jenis data semantik dari nilai bidang.

Nilai	Deskripsi
address	Alamat yang diurai.
array	Daftar subbidang dengan jenis yang sama.
boolean	Nilai Boolean, dinormalisasi ke true atau false.
countryRegion	Negara/wilayah, dinormalisasi ke format ISO 3166-1 alpha-3 (misalnya AS).
currency	Jumlah mata uang dengan simbol dan unit mata uang opsional.
date	Tanggal, dinormalisasi ke format ISO 8601 (YYYY-MM-DD).
integer	Bilangan bulat, dinormalisasi menjadi bilangan bulat bertanda 64-bit.
number	Angka titik mengambang, dinormalisasi menjadi titik mengambang presisi ganda.
object	Daftar subbidang bernama dari jenis yang berpotensi berbeda.
phoneNumber	Nomor telepon, dinormalisasi ke format E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	Array nilai string yang dipilih.
selectionMark	Apakah bidang dipilih?
signature	Apakah tanda tangan ada?
string	Teks biasa.
time	Waktu, dinormalisasi ke format ISO 8601 (hh:mm:ss).

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.

DocumentTypeDetails

Objek

Info jenis dokumen.

Nama	Jenis	Deskripsi
buildMode	DocumentBuildMode	Mode build model dokumen kustom.
confidenceThreshold	number (float)	Hanya lakukan analisis jika keyakinan docType di atas ambang batas.
description	string maxLength: 4096	Deskripsi model dokumen.
features	DocumentAnalysisFeature[]	Daftar fitur analisis opsional.
fieldConfidence	object	Estimasi kepercayaan diri untuk setiap bidang.
fieldSchema	<string,  DocumentFieldSchema>	Deskripsi skema semantik dokumen menggunakan sintaks gaya Skema JSON.
maxDocumentsToAnalyze	integer (int32)	Jumlah maksimum dokumen dari jenis yang ditentukan untuk dianalisis. Default=all.
modelId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Model dokumen yang digunakan untuk menganalisis dokumen dengan jenis tertentu.
queryFields	string[]	Daftar bidang tambahan yang akan diekstrak. Bekas. "NumberOfGuests,StoreNumber"

SplitMode

Enumeration

Perilaku pemisahan file.

Nilai	Deskripsi
auto	Pisahkan file secara otomatis menjadi dokumen.
none	Perlakukan seluruh file sebagai satu dokumen.
perPage	Perlakukan setiap halaman dalam file sebagai dokumen terpisah.