Content Analyzers - Analyze

Dienst:

Azure AI Services

API-Version:

2025-05-01-preview

Extrahieren von Inhalten und Feldern aus der Eingabe.

POST {endpoint}/contentunderstanding/analyzers/{analyzerId}:analyze?api-version=2025-05-01-preview

Mit optionalen Parametern:

POST {endpoint}/contentunderstanding/analyzers/{analyzerId}:analyze?api-version=2025-05-01-preview&stringEncoding={stringEncoding}&processingLocation={processingLocation}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
analyzerId	path	True	string pattern: ^[a-zA-Z0-9._-]{1,64}$	Der eindeutige Bezeichner des Analyzers.
endpoint	path	True	string (uri)	Inhaltsverständnis-Dienstendpunkt.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
processingLocation	query		ProcessingLocation	Der Ort, an dem die Daten verarbeitet werden können.
stringEncoding	query		StringEncoding	Das Codierungsformat für Inhaltsbereiche in der Antwort.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Anforderungstext

Name	Typ	Beschreibung
data	string (byte)	Base64-codierter Binärinhalt des primären Eingangs, der analysiert werden soll. Es sollte nur eine URL oder Daten angegeben werden.
inputs	AnalyzeInput[]	Zusätzliche Eingaben zur Analyse. Wird nur in Analysetools mit mode=pro unterstützt.
url	string (uri)	Die URL der primären Eingabe, die analysiert werden soll. Es sollte nur eine URL oder Daten 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 x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

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

Analyze URL

Beispielanforderung

HTTP

POST {endpoint}/contentunderstanding/analyzers/myAnalyzer:analyze?api-version=2025-05-01-preview

{
  "url": "https://host.com/doc.pdf"
}

Beispiel für eine Antwort

Statuscode:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzerResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2025-05-01-preview

{
  "id": "3b31320d-8bab-4f88-b19c-2322a7f11034",
  "status": "NotStarted"
}

Definitionen

Name	Beschreibung
AnalyzeInput	Zusätzliche Eingabe zur Analyse.
AnalyzeRequest	Analysieren der Vorgangsanforderung.
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
ProcessingLocation	Der Ort, an dem die Daten verarbeitet werden können.
StringEncoding	Die Zeichenfolgencodierung, die für Inhaltsbereiche verwendet wird.

AnalyzeInput

Objekt

Zusätzliche Eingabe zur Analyse.

Name	Typ	Beschreibung
data	string (byte)	Base64-codierter Binärinhalt der zu analysierenden Eingabe. Es sollte nur eine URL oder Daten angegeben werden.
name	string	Der Name der Eingabe.
url	string (uri)	Die URL der zu analysierenden Eingabe. Es sollte nur eine URL oder Daten angegeben werden.

AnalyzeRequest

Objekt

Analysieren der Vorgangsanforderung.

Name	Typ	Beschreibung
data	string (byte)	Base64-codierter Binärinhalt des primären Eingangs, der analysiert werden soll. Es sollte nur eine URL oder Daten angegeben werden.
inputs	AnalyzeInput[]	Zusätzliche Eingaben zur Analyse. Wird nur in Analysetools mit mode=pro unterstützt.
url	string (uri)	Die URL der primären Eingabe, die analysiert werden soll. Es sollte nur eine URL oder Daten angegeben werden.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

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

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

ProcessingLocation

Enumeration

Der Ort, an dem die Daten verarbeitet werden können.

Wert	Beschreibung
dataZone	Daten können in derselben Datenzone wie die Ressource verarbeitet werden.
geography	Daten können in derselben Geografie wie die Ressource verarbeitet werden.
global	Daten können in jedem Azure-Rechenzentrum weltweit verarbeitet werden.

StringEncoding

Enumeration

Die Zeichenfolgencodierung, die für Inhaltsbereiche verwendet wird.

Wert	Beschreibung
codePoint	Unicode-Codepunkt-Codierung (UTF-32), die von Sprachen wie Python usw. verwendet wird.
utf16	UTF-16-Codierung, die von Sprachen wie C#, JavaScript, Java usw. verwendet wird.
utf8	UTF-8-Codierung, die von Sprachen wie Go, Rust, Ruby, PHP usw. verwendet wird.