Document Classifiers - Get Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

Ayrıntılı belge sınıflandırıcı bilgilerini alır.

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-02-29-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
classifierId	path	True	string	Benzersiz belge sınıflandırıcı adı. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	Belge Yönetim Bilgileri hizmeti uç noktası.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string uuid	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Yanıtlar

Name	Tür	Description
200 OK	DocumentClassifierDetails	İstek başarılı oldu. Headers x-ms-client-request-id: string
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

Get Document Classifier

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "classifierId": "myClassifier",
  "description": "Classifier 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": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Tanımlar

Name	Description
AzureBlobContentSource	İçeriği Azure Blob Depolama.
AzureBlobFileListContentSource	Azure Blob Depolama dosya listesi.
ClassifierDocumentTypeDetails	Sınıflandırıcı belge türü bilgileri.
ContentSourceKind	İçerik kaynağı türü.
DocumentClassifierDetails	Belge sınıflandırıcı bilgileri.
Error	Hata nesnesi.
ErrorResponse	Hata yanıtı nesnesi.
InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne.
Warning	Hata nesnesi.

AzureBlobContentSource

İçeriği Azure Blob Depolama.

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

AzureBlobFileListContentSource

Azure Blob Depolama dosya listesi.

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

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 bir dosya listesi.
base64	string	Base64 kodlaması ile temsil edilen içerik.
url	string	Belirli bir URL'deki içerik.

DocumentClassifierDetails

Belge sınıflandırıcı bilgileri.

Name	Tür	Description
apiVersion	string	Bu belge sınıflandırıcısını oluşturmak için kullanılan API sürümü.
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ı.
createdDateTime	string	Belge sınıflandırıcısının oluşturulduğu tarih ve saat (UTC).
description	string	Belge sınıflandırıcı açıklaması.
docTypes	<string,  ClassifierDocumentTypeDetails>	Sınıflandırılacak belge türlerinin listesi.
expirationDateTime	string	Belge sınıflandırıcısının süresinin dolacağı tarih ve saat (UTC).
warnings	Warning[]	Sınıflandırıcı oluşturulurken karşılaşılan uyarıların listesi.

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 ayrıntılar dizisi.
innererror	InnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilen 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 insan tarafından okunabilen bir gösterimi.

Warning

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı uyarı kodları kümesinden biri.
message	string	Uyarının insan tarafından okunabilen bir gösterimi.
target	string	Hatanın hedefi.