Document Classifiers - Classify Document

Tjänst:

Azure AI Services

API-version:

2024-11-30

Klassificerar dokument med dokumentklassificerare.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
classifierId	path	True	string	Unikt namn på dokumentklassificerare. Reguljärt uttrycksmönster: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	Slutpunkten för document intelligence-tjänsten.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.
pages	query		string	1-baserade sidnummer att analysera. Ex. "1-3,5,7-9" Reguljärt uttrycksmönster: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
split	query		SplitMode	Dokumentdelningsläge.
stringIndexType	query		StringIndexType	Metod som används för att beräkna strängförskjutning och längd.

Begärandetext

Name	Typ	Description
base64Source	string	Base64-kodning av dokumentet som ska klassificeras. Antingen urlSource eller base64Source måste anges.
urlSource	string	Dokument-URL som ska klassificeras. Antingen urlSource eller base64Source måste anges.

Svar

Name	Typ	Description
202 Accepted		Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts. Sidhuvuden Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Ett oväntat felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

Classify Document from Url

Exempelbegäran

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"
}

Exempelsvar

Statuskod:

202

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

Definitioner

Name	Description
ClassifyDocumentRequest	Parametrar för dokumentklassificering.
DocumentIntelligenceError	Felobjektet.
DocumentIntelligenceErrorResponse	Felsvarsobjekt.
DocumentIntelligenceInnerError	Ett objekt som innehåller mer specifik information om felet.
SplitMode	Beteende för fildelning.
StringIndexType	Metod som används för att beräkna strängförskjutning och längd.

ClassifyDocumentRequest

Parametrar för dokumentklassificering.

Name	Typ	Description
base64Source	string	Base64-kodning av dokumentet som ska klassificeras. Antingen urlSource eller base64Source måste anges.
urlSource	string	Dokument-URL som ska klassificeras. Antingen urlSource eller base64Source måste anges.

DocumentIntelligenceError

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	DocumentIntelligenceError[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	DocumentIntelligenceInnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

DocumentIntelligenceErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	DocumentIntelligenceError	Felinformation.

DocumentIntelligenceInnerError

Ett objekt som innehåller mer specifik information om felet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	DocumentIntelligenceInnerError	Inre fel.
message	string	En mänsklig läsbar representation av felet.

SplitMode

Beteende för fildelning.

Name	Typ	Description
auto	string	Dela automatiskt upp filen i dokument.
none	string	Behandla hela filen som ett enda dokument.
perPage	string	Behandla varje sida i filen som ett separat dokument.

StringIndexType

Metod som används för att beräkna strängförskjutning och längd.

Name	Typ	Description
textElements	string	Användarupplevt visningstecken, eller grapheme-kluster, som definieras av Unicode 8.0.0.
unicodeCodePoint	string	Teckenenhet som representeras av en enda unicode-kodpunkt. Används av Python 3.
utf16CodeUnit	string	Teckenenhet som representeras av en 16-bitars Unicode-kodenhet. Används av JavaScript, Java och .NET.