Document Classifiers - Classify Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Klassificerar dokumentet med dokumentklassificeraren.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
classifierId	path	True	string	Unikt dokumentklassificerarenamn. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	Slutpunkten för dokumentinformationstjänsten.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
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. UrlSource eller base64Source måste anges.
urlSource	string	Dokument-URL som ska klassificeras. 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. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

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

Exempel

Classify Document from Url

Sample Request

HTTP

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

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

Definitioner

Name	Description
ClassifyDocumentRequest	Parametrar för dokumentklassificering.
Error	Felobjektet.
ErrorResponse	Felsvarsobjekt.
InnerError	Ett objekt som innehåller mer specifik information om felet.
SplitMode	Dokumentdelningsläge.
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. UrlSource eller base64Source måste anges.
urlSource	string	Dokument-URL som ska klassificeras. UrlSource eller base64Source måste anges.

Error

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	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.

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

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

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

SplitMode

Dokumentdelningsläge.

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, enligt definitionen i 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.