Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

URI Parametreleri

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

İstek Gövdesi

Name	Gerekli	Tür	Description
classifierId	True	string	Benzersiz belge sınıflandırıcı adı.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Sınıflandırılacak belge türlerinin listesi.
baseClassifierId		string	Sınıflandırıcının eğitildiği temel classifierId değeri.
description		string	Belge sınıflandırıcı açıklaması.

Yanıtlar

Name	Tür	Description
202 Accepted		İstek işlenmek üzere kabul edildi, ancak işleme henüz tamamlanmadı. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

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

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

Örnekler

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

Tanımlar

Name	Description
AzureBlobContentSource	İçeriği Azure Blob Depolama.
AzureBlobFileListContentSource	Azure Blob Depolama 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ü.
Error	Hata nesnesi.
ErrorResponse	Hata yanıtı nesnesi.
InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne.

AzureBlobContentSource

İçeriği Azure Blob Depolama.

Name	Tür	Description
containerUrl	string	Kapsayıcı URL'lerini Azure Blob Depolama.
prefix	string	Blob adı ön eki.

AzureBlobFileListContentSource

Azure Blob Depolama dosya listesi.

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

BuildDocumentClassifierRequest

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

Name	Tür	Description
baseClassifierId	string	Sınıflandırıcının eğitildiği temel classifierId değeri.
classifierId	string	Benzersiz belge sınıflandırıcı adı.
description	string	Belge sınıflandırıcı açıklaması.
docTypes	<string,  ClassifierDocumentTypeDetails>	Sınıflandırılacak belge türlerinin listesi.

ClassifierDocumentTypeDetails

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 konum. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
sourceKind	ContentSourceKind	Eğitim veri kaynağının türü.

ContentSourceKind

İçerik kaynağı türü.

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

Error

Hata nesnesi.

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

ErrorResponse

Hata yanıtı nesnesi.

Name	Tür	Description
error	Error	Hata bilgileri.

InnerError

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	InnerError	İç hata.
message	string	Hatanın insanlar tarafından okunabilir bir gösterimi.