Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2023-07-31

Membangun pengklasifikasi dokumen kustom.

POST {endpoint}/formrecognizer/documentClassifiers: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
classifierId	True	string	Nama pengklasifikasi dokumen unik.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Daftar jenis dokumen yang akan diklasifikasikan.
description		string	Deskripsi penggolak 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 Classifier

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers:build?api-version=2023-07-31

{
  "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/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

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.
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 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 untuk pelatihan.

BuildDocumentClassifierRequest

Minta isi untuk membangun pengklasifikasi dokumen kustom baru.

Nama	Jenis	Deskripsi
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.

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.