Document Classifiers - Classify Document

Dienst:: Azure AI Services

API-Version:: 2024-11-30

Klassifiziert das Dokument mit dokumentklassifizierer.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
classifierId	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Eindeutiger Dokumentklassifizierername.
endpoint	path	True	string (uri)	Der Document Intelligence-Dienstendpunkt.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
pages	query		string pattern: ^(\d+(-\d+)?)(,\s(\d+(-\d+)?))$	Zu analysierende 1-basierte Seitenzahlen. Ex. "1-3,5,7-9"
split	query		SplitMode	Dokumentteilungsmodus.
stringIndexType	query		StringIndexType	Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

Anforderungstext

Name	Typ	Beschreibung
base64Source	string (byte)	Base64-Codierung des zu klassifizierenden Dokuments. Entweder urlSource oder base64Source muss angegeben werden.
urlSource	string (uri)	Dokument-URL, die klassifiziert werden soll. Entweder urlSource oder base64Source muss angegeben werden.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Header Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

202 Accepted

Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Header

Operation-Location: string
Retry-After: integer

Other Status Codes

DocumentIntelligenceErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

Classify Document from Url

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 202

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

Definitionen

Name	Beschreibung
ClassifyDocumentRequest	Dokumentklassifizierungsparameter.
DocumentIntelligenceError	Das Fehlerobjekt.
DocumentIntelligenceErrorResponse	Fehlerantwortobjekt.
DocumentIntelligenceInnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
SplitMode	Verhalten beim Teilen von Dateien.
StringIndexType	Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

ClassifyDocumentRequest

Objekt

Dokumentklassifizierungsparameter.

Name	Typ	Beschreibung
base64Source	string (byte)	Base64-Codierung des zu klassifizierenden Dokuments. Entweder urlSource oder base64Source muss angegeben werden.
urlSource	string (uri)	Dokument-URL, die klassifiziert werden soll. Entweder urlSource oder base64Source muss angegeben werden.

DocumentIntelligenceError

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	DocumentIntelligenceError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	DocumentIntelligenceInnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

DocumentIntelligenceErrorResponse

Objekt

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	DocumentIntelligenceError	Fehlerinformationen.

DocumentIntelligenceInnerError

Objekt

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

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	DocumentIntelligenceInnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

SplitMode

Enumeration

Verhalten beim Teilen von Dateien.

Wert	Beschreibung
auto	Datei automatisch in Dokumente aufteilen.
none	Behandeln Sie die gesamte Datei als einzelnes Dokument.
perPage	Behandeln Sie jede Seite in der Datei als separates Dokument.

StringIndexType

Enumeration

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

Wert	Beschreibung
textElements	Vom Benutzer wahrgenommenes Anzeigezeichen oder Graphemecluster, wie durch Unicode 8.0.0 definiert.
unicodeCodePoint	Zeicheneinheit dargestellt durch einen einzelnen Unicode-Codepunkt. Wird von Python 3 verwendet.
utf16CodeUnit	Zeicheneinheit dargestellt durch eine 16-Bit-Unicode-Codeeinheit. Wird von JavaScript, Java und .NET verwendet.