Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

Membangun pengklasifikasi dokumen kustom.

POST {endpoint}/documentintelligence/documentClassifiers: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
classifierId	True	string	Nama pengklasifikasi dokumen unik.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Daftar jenis dokumen yang akan diklasifikasikan.
baseClassifierId		string	Pengklasifikasi dasarId di atasnya untuk melatih pengklasifikasi.
description		string	Deskripsi penggolak 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 Classifier

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

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

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

BuildDocumentClassifierRequest

Minta isi untuk membangun pengklasifikasi dokumen kustom baru.

Nama	Jenis	Deskripsi
baseClassifierId	string	Pengklasifikasi dasarId di atasnya untuk melatih pengklasifikasi.
classifierId	string	Nama pengklasifikasi dokumen unik.
description	string	Deskripsi penggolak dokumen.
docTypes	<string,  ClassifierDocumentTypeDetails>	Daftar jenis dokumen yang akan diklasifikasikan.

ClassifierDocumentTypeDetails

Info jenis dokumen penggolonal.

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

ContentSourceKind

Jenis sumber konten.

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

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.