Document Classifiers - Build Classifier

Hizmet:

Azure AI Services

API Sürümü:

2024-11-30

Özel bir belge sınıflandırıcısı oluşturur.

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-11-30

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (uri)	Belge Yönetim Bilgileri hizmet uç noktası.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
classifierId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Benzersiz belge sınıflandırıcı adı.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Sınıflandırılacak belge türlerinin listesi.
allowOverwrite		boolean	Aynı ada sahip mevcut bir sınıflandırıcının üzerine yazmaya izin verin.
baseClassifierId		string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Sınıflandırıcının eğitildiği temel classifierId değeri.
description		string maxLength: 4096	Belge sınıflandırıcı açıklaması.

Yanıtlar

Name	Tür	Description
202 Accepted		İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı. Üst Bilgiler Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

Ocp-Apim-Subscription-Key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize
Belirteç URL'si: https://login.microsoftonline.com/common/oauth2/token

Kapsamlar

Name	Description
https://cognitiveservices.azure.com/.default

Örnekler

Build Document Classifier

Örnek isteği

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

Örnek yanıt

Durum kodu:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30

Tanımlar

Name	Description
AzureBlobContentSource	Azure Blob Depolama içeriği.
AzureBlobFileListContentSource	Azure Blob Depolama'daki dosya listesi.
BuildDocumentClassifierRequest	Yeni bir özel belge sınıflandırıcısı oluşturmak için istek gövdesi.
ClassifierDocumentTypeDetails	Sınıflandırıcı belge türü bilgileri.
ContentSourceKind	İçerik kaynağı türü.
DocumentIntelligenceError	Hata nesnesi.
DocumentIntelligenceErrorResponse	Hata yanıtı nesnesi.
DocumentIntelligenceInnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne.

AzureBlobContentSource

Object

Azure Blob Depolama içeriği.

Name	Tür	Description
containerUrl	string (uri)	Azure Blob Depolama kapsayıcı URL'si.
prefix	string	Blob adı ön eki.

AzureBlobFileListContentSource

Object

Azure Blob Depolama'daki dosya listesi.

Name	Tür	Description
containerUrl	string (uri)	Azure Blob Depolama kapsayıcı URL'si.
fileList	string	Belgelerin alt kümesini belirten kapsayıcı içindeki bir JSONL dosyasının yolu.

BuildDocumentClassifierRequest

Object

Yeni bir özel belge sınıflandırıcısı oluşturmak için istek gövdesi.

Name	Tür	Default value	Description
allowOverwrite	boolean	False	Aynı ada sahip mevcut bir sınıflandırıcının üzerine yazmaya izin verin.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Sınıflandırıcının eğitildiği temel classifierId değeri.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Benzersiz belge sınıflandırıcı adı.
description	string maxLength: 4096		Belge sınıflandırıcı açıklaması.
docTypes	<string,  ClassifierDocumentTypeDetails>		Sınıflandırılacak belge türlerinin listesi.

ClassifierDocumentTypeDetails

Object

Sınıflandırıcı belge türü bilgileri.

Name	Tür	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Sınıflandırıcı belge türü için eğitim verilerini belirten Azure Blob Depolama dosya listesi. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
azureBlobSource	AzureBlobContentSource	Sınıflandırıcı belge türü için eğitim verilerini içeren Azure Blob Depolama konumu. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
sourceKind	ContentSourceKind	Eğitim veri kaynağının türü.

ContentSourceKind

Listeleme

İçerik kaynağı türü.

Değer	Description
url	Belirli bir URL'deki içerik.
base64	Base64 kodlaması ile temsil edilen içerik.
azureBlob	Azure Blob Depolama kapsayıcısı içindeki bir yoldaki dosyalar.
azureBlobFileList	Azure Blob Depolama kapsayıcısında tek tek dosyaları belirten dosya listesi.

DocumentIntelligenceError

Object

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	DocumentIntelligenceError[]	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
innererror	DocumentIntelligenceInnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

DocumentIntelligenceErrorResponse

Object

Hata yanıtı nesnesi.

Name	Tür	Description
error	DocumentIntelligenceError	Hata bilgileri.

DocumentIntelligenceInnerError

Object

Hata hakkında daha ayrıntılı bilgi içeren bir nesne.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
innererror	DocumentIntelligenceInnerError	İç hata.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.