Document Classifiers - Build Classifier

Layanan:

Azure AI Services

Versi API:

2024-11-30

Membangun pengklasifikasi dokumen kustom.

POST {endpoint}/documentintelligence/documentClassifiers: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
classifierId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nama pengklasifikasi dokumen unik.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Daftar jenis dokumen yang akan diklasifikasikan.
allowOverwrite		boolean	Izinkan menimpa pengklasifikasi yang ada dengan nama yang sama.
baseClassifierId		string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Base classifierId di atasnya untuk melatih pengklasifikasi.
description		string maxLength: 4096	Deskripsi klasifikasi 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 Classifier

Permintaan sampel

HTTP

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

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "fileList": "formB.jsonl"
      }
    }
  }
}

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.
BuildDocumentClassifierRequest	Minta isi untuk membangun pengklasifikasi dokumen kustom baru.
ClassifierDocumentTypeDetails	Info jenis dokumen penggolonal.
ContentSourceKind	Jenis sumber konten.
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.

BuildDocumentClassifierRequest

Objek

Minta isi untuk membangun pengklasifikasi dokumen kustom baru.

Nama	Jenis	Nilai default	Deskripsi
allowOverwrite	boolean	False	Izinkan menimpa pengklasifikasi yang ada dengan nama yang sama.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Base classifierId di atasnya untuk melatih pengklasifikasi.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Nama pengklasifikasi dokumen unik.
description	string maxLength: 4096		Deskripsi klasifikasi dokumen.
docTypes	<string,  ClassifierDocumentTypeDetails>		Daftar jenis dokumen yang akan diklasifikasikan.

ClassifierDocumentTypeDetails

Objek

Info jenis dokumen penggolonal.

Nama	Jenis	Deskripsi
azureBlobFileListSource	AzureBlobFileListContentSource	Daftar file Azure Blob Storage yang menentukan data pelatihan untuk jenis dokumen pengklasifikasi. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
azureBlobSource	AzureBlobContentSource	Lokasi Azure Blob Storage yang berisi data pelatihan untuk jenis dokumen pengklasifikasi. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
sourceKind	ContentSourceKind	Jenis sumber data pelatihan.

ContentSourceKind

Enumeration

Jenis sumber konten.

Nilai	Deskripsi
url	Konten di URL tertentu.
base64	Konten yang diwakili melalui pengodean Base64.
azureBlob	File di jalur dalam kontainer Azure Blob Storage.
azureBlobFileList	Daftar file yang menentukan file individual dalam kontainer Azure Blob Storage.

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.