Document Classifiers - Classify Document From Stream

Service:

Azure AI Services

API Version:

2024-02-29-preview

Belge sınıflandırıcı ile belgeyi sınıflandırır.

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

With optional parameters:

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?api-version=2024-02-29-preview&stringIndexType={stringIndexType}&split={split}

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ü.
split	query		SplitMode	Belge bölme modu.
stringIndexType	query		StringIndexType	Dize uzaklığını ve uzunluğunu hesaplamak için kullanılan yöntem.

İstek Gövdesi

Media Types: "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Name	Tür	Description
input	string	İçerik girişi.

Yanıtlar

Name	Tür	Description
202 Accepted		İstek işleme için 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

Classify Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/classifierId:analyze?api-version=2024-02-29-preview&stringIndexType=textElements

"{binaryFile}"

Sample Response

Status code:

202

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
Error	Hata nesnesi.
ErrorResponse	Hata yanıtı nesnesi.
InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne.
SplitMode	Belge bölme modu.
StringIndexType	Dize uzaklığını ve uzunluğunu hesaplamak için kullanılan yöntem.

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.

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.