Document Classifiers - Classify Document From Stream

Service:

Azure AI Services

API Version:

2024-02-29-preview

Klassifiziert dokument mit Dokumentklassifizierung.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
classifierId	path	True	string	Eindeutiger Dokumentklassifizierungsname. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	Der Document Intelligence-Dienstendpunkt.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
split	query		SplitMode	Dokumentaufteilungsmodus.
stringIndexType	query		StringIndexType	Methode, die zum Berechnen von Zeichenfolgenoffset und -länge verwendet wird.

Anforderungstext

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	Beschreibung
input	string	Eingabeinhalt.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wurde für die Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Eine unerwartete Fehlerantwort.

Sicherheit

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	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

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

Definitionen

Name	Beschreibung
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
SplitMode	Dokumentaufteilungsmodus.
StringIndexType	Methode, die zum Berechnen von Zeichenfolgenoffset und -länge verwendet wird.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
innererror	InnerError	Innerer Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

SplitMode

Dokumentaufteilungsmodus.

Name	Typ	Beschreibung
auto	string	Automatisches Aufteilen der Datei in Dokumente.
none	string	Behandeln Sie die gesamte Datei als einzelnes Dokument.
perPage	string	Behandeln Sie jede Seite in der Datei als separates Dokument.

StringIndexType

Methode, die zum Berechnen von Zeichenfolgenoffset und -länge verwendet wird.

Name	Typ	Beschreibung
textElements	string	Vom Benutzer wahrgenommenes Anzeigezeichen oder Graphemcluster, wie in Unicode 8.0.0 definiert.
unicodeCodePoint	string	Zeicheneinheit, die durch einen einzelnen Unicode-Codepunkt dargestellt wird. Wird von Python 3 verwendet.
utf16CodeUnit	string	Zeicheneinheit, die durch eine 16-Bit-Unicode-Codeeinheit dargestellt wird. Wird von JavaScript, Java und .NET verwendet.