Document Classifiers - List Classifiers

Service:

Azure AI Services

API Version:

2024-02-29-preview

Mencantumkan semua pengklasifikasi dokumen.

GET {endpoint}/documentintelligence/documentClassifiers?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.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string uuid	Pengidentifikasi string yang buram, unik secara global, dan dihasilkan klien untuk permintaan tersebut.

Respons

Nama	Jenis	Deskripsi
200 OK	PagedDocumentClassifierDetails	Permintaan telah berhasil. Headers x-ms-client-request-id: string
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

Get Document Classifiers

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "classifierId": "classifier1",
      "description": "Classifier1 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-02-29-preview",
      "docTypes": {
        "formA": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formADocs/"
          }
        },
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        }
      }
    },
    {
      "classifierId": "classifier2",
      "description": "Classifier2 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-02-29-preview",
      "docTypes": {
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        },
        "formC": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formCDocs/"
          }
        }
      }
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?nextLink=nextLinkData"
}

Definisi

Nama	Deskripsi
AzureBlobContentSource	Azure Blob Storage konten.
AzureBlobFileListContentSource	Daftar file di Azure Blob Storage.
ClassifierDocumentTypeDetails	Info jenis dokumen penggolonal.
ContentSourceKind	Jenis sumber konten.
DocumentClassifierDetails	Info klasifikasi dokumen.
Error	Objek kesalahan.
ErrorResponse	Objek respons kesalahan.
InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut.
PagedDocumentClassifierDetails	Kumpulan halaman item DocumentClassifierDetails
Warning	Objek kesalahan.

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.

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.

DocumentClassifierDetails

Info klasifikasi dokumen.

Nama	Jenis	Deskripsi
apiVersion	string	Versi API yang digunakan untuk membuat pengklasifikasi dokumen ini.
baseClassifierId	string	ClassifierId dasar di atas pengklasifikasi dilatih.
classifierId	string	Nama pengklasifikasi dokumen unik.
createdDateTime	string	Tanggal dan waktu (UTC) saat pengklasifikasi dokumen dibuat.
description	string	Deskripsi penggolak dokumen.
docTypes	<string,  ClassifierDocumentTypeDetails>	Daftar jenis dokumen yang akan diklasifikasikan.
expirationDateTime	string	Tanggal dan waktu (UTC) saat pengklasifikasi dokumen akan kedaluwarsa.
warnings	Warning[]	Daftar peringatan yang ditemui saat membangun pengklasifikasi.

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.

PagedDocumentClassifierDetails

Kumpulan halaman item DocumentClassifierDetails

Nama	Jenis	Deskripsi
nextLink	string	Tautan ke halaman item berikutnya
value	DocumentClassifierDetails[]	Item DocumentClassifierDetails di halaman ini

Warning

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode peringatan yang ditentukan server.
message	string	Representasi peringatan yang dapat dibaca manusia.
target	string	Target kesalahan.