Document Classifiers - Classify Document From Stream

Služba:

Azure AI Services

Verze rozhraní API:

2024-11-30

Klasifikuje dokument pomocí klasifikátoru dokumentu.

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

S volitelnými parametry:

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?api-version=2024-11-30&stringIndexType={stringIndexType}&split={split}&pages={pages}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
classifierId	path	True	string	Jedinečný název klasifikátoru dokumentu Vzor regulárního výrazu: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	Koncový bod služby Document Intelligence
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
pages	query		string	1 čísla stránek, která se mají analyzovat. Ex. "1-3,5,7-9" Vzor regulárního výrazu: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
split	query		SplitMode	Režim rozdělení dokumentu
stringIndexType	query		StringIndexType	Metoda použitá k výpočtu posunu a délky řetězce

Text požadavku

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	Typ	Description
input	string	Vstupní obsah

Odpovědi

Name	Typ	Description
202 Accepted		Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Hlavičky Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

Classify Document from Url

Ukázkový požadavek

HTTP

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

"{binaryFile}"

Ukázková odpověď

Stavový kód:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Definice

Name	Description
DocumentIntelligenceError	Objekt chyby.
DocumentIntelligenceErrorResponse	Objekt odpovědi na chybu
DocumentIntelligenceInnerError	Objekt obsahující konkrétnější informace o chybě.
SplitMode	Chování rozdělení souboru
StringIndexType	Metoda použitá k výpočtu posunu a délky řetězce

DocumentIntelligenceError

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	DocumentIntelligenceError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	DocumentIntelligenceInnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

DocumentIntelligenceErrorResponse

Objekt odpovědi na chybu

Name	Typ	Description
error	DocumentIntelligenceError	Informace o chybě

DocumentIntelligenceInnerError

Objekt obsahující konkrétnější informace o chybě.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	DocumentIntelligenceInnerError	Vnitřní chyba.
message	string	Čitelné znázornění chyby člověkem.

SplitMode

Chování rozdělení souboru

Name	Typ	Description
auto	string	Automaticky rozdělte soubor na dokumenty.
none	string	Považovat celý soubor za jeden dokument.
perPage	string	Každou stránku v souboru můžete považovat za samostatný dokument.

StringIndexType

Metoda použitá k výpočtu posunu a délky řetězce

Name	Typ	Description
textElements	string	Uživatelem vnímaný znak zobrazení nebo cluster grapheme definovaný kódem Unicode 8.0.0.
unicodeCodePoint	string	Znaková jednotka reprezentovaná jedním bodem kódu Unicode. Používá python 3.
utf16CodeUnit	string	Znaková jednotka reprezentovaná 16bitovou jednotkou kódu Unicode Používá se v JavaScriptu, Javě a .NET.