Document Classifiers - Classify Document
Belge sınıflandırıcı ile belgeyi sınıflandırır.
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-02-29-preview
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-02-29-preview&stringIndexType={stringIndexType}&split={split}
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
classifier
|
path | True |
string |
Benzersiz belge sınıflandırıcı adı. Regex pattern: |
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ü. |
split
|
query |
Belge bölme modu. |
||
string
|
query |
Dize uzaklığını ve uzunluğunu hesaplamak için kullanılan yöntem. |
İstek Gövdesi
Name | Tür | Description |
---|---|---|
base64Source |
string |
Sınıflandırmak için belgenin Base64 kodlaması. urlSource veya base64Source belirtilmelidir. |
urlSource |
string |
Sınıflandırmak için belge URL'si. urlSource veya base64Source belirtilmelidir. |
Yanıtlar
Name | Tür | Description |
---|---|---|
202 Accepted |
İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı. Headers
|
|
Other Status Codes |
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
Classify Document from Url
Sample Request
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/classifierId:analyze?_overload=classifyDocument&api-version=2024-02-29-preview&stringIndexType=textElements
{
"urlSource": "http://host.com/doc.pdf"
}
Sample Response
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview
Tanımlar
Name | Description |
---|---|
Classify |
Belge sınıflandırma parametreleri. |
Error |
Hata nesnesi. |
Error |
Hata yanıtı nesnesi. |
Inner |
Hata hakkında daha ayrıntılı bilgi içeren bir nesne. |
Split |
Belge bölme modu. |
String |
Dize uzaklığını ve uzunluğunu hesaplamak için kullanılan yöntem. |
ClassifyDocumentRequest
Belge sınıflandırma parametreleri.
Name | Tür | Description |
---|---|---|
base64Source |
string |
Sınıflandırmak için belgenin Base64 kodlaması. urlSource veya base64Source belirtilmelidir. |
urlSource |
string |
Sınıflandırmak için belge URL'si. urlSource veya base64Source belirtilmelidir. |
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 |
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 |
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 |
İç hata. |
|
message |
string |
Hatanın insan tarafından okunabilen bir gösterimi. |
SplitMode
Belge bölme modu.
Name | Tür | Description |
---|---|---|
auto |
string |
Dosyayı otomatik olarak belgelere bölün. |
none |
string |
Dosyanın tamamını tek bir belge olarak değerlendirin. |
perPage |
string |
Dosyadaki her sayfayı ayrı bir belge olarak değerlendirin. |
StringIndexType
Dize uzaklığını ve uzunluğunu hesaplamak için kullanılan yöntem.
Name | Tür | Description |
---|---|---|
textElements |
string |
Kullanıcı tarafından algılanan görüntüleme karakteri veya Unicode 8.0.0 tarafından tanımlanan grapheme kümesi. |
unicodeCodePoint |
string |
Tek bir unicode kod noktasıyla temsil edilen karakter birimi. Python 3 tarafından kullanılır. |
utf16CodeUnit |
string |
16 bit Unicode kod birimiyle temsil edilen karakter birimi. JavaScript, Java ve .NET tarafından kullanılır. |