Document Classifiers - Classify Document

Služba:

Azure AI Services

Verze rozhraní API:

2024-11-30

Klasifikuje dokument pomocí klasifikátoru dokumentu.

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

S volitelnými parametry:

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&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 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Jedinečný název klasifikátoru dokumentu
endpoint	path	True	string (uri)	Koncový bod služby Document Intelligence
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
pages	query		string pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$	1 čísla stránek, která se mají analyzovat. Ex. "1-3,5,7-9"
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

Name	Typ	Description
base64Source	string (byte)	Kódování Base64 dokumentu ke klasifikaci Musí být zadána adresa URLSource nebo base64Source.
urlSource	string (uri)	Adresa URL dokumentu, která se má klasifikovat. Musí být zadána adresa URLSource nebo base64Source.

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?_overload=classifyDocument&api-version=2024-11-30&stringIndexType=textElements

{
  "urlSource": "http://host.com/doc.pdf"
}

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
ClassifyDocumentRequest	Parametry klasifikace dokumentů
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

ClassifyDocumentRequest

Objekt

Parametry klasifikace dokumentů

Name	Typ	Description
base64Source	string (byte)	Kódování Base64 dokumentu ke klasifikaci Musí být zadána adresa URLSource nebo base64Source.
urlSource	string (uri)	Adresa URL dokumentu, která se má klasifikovat. Musí být zadána adresa URLSource nebo base64Source.

DocumentIntelligenceError

Objekt

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

Objekt odpovědi na chybu

Name	Typ	Description
error	DocumentIntelligenceError	Informace o chybě

DocumentIntelligenceInnerError

Objekt

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

Výčet

Chování rozdělení souboru

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

StringIndexType

Výčet

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

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