Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Analysiert Das Dokument mit dem Dokumentmodell.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview

With optional parameters:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Der Document Intelligence-Dienstendpunkt.
modelId	path	True	string	Eindeutiger Name des Dokumentmodells. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
features	query		DocumentAnalysisFeature[]	Liste der optionalen Analysefeatures.
locale	query		string	Gebietsschemahinweis für die Texterkennung und Dokumentanalyse. Der Wert darf nur den Sprachcode (z. B. „en“, „fr“) oder das BCP-47-Sprachtag (z. B. „en-US“) enthalten.
outputContentFormat	query		ContentFormat	Format des Inhalts der obersten Ebene des Analyseergebnisses.
pages	query		string	Liste der zu analysierenden 1-basierten Seitenzahlen. Ex. 1-3,5,7-9 Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Liste der zu extrahierenden zusätzlichen Felder. Ex. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Methode, die zum Berechnen von Zeichenfolgenoffset und -länge verwendet wird.

Anforderungstext

Name	Typ	Beschreibung
base64Source	string	Base64-Codierung des zu analysierenden Dokuments. Entweder urlSource oder base64Source muss angegeben werden.
urlSource	string	Zu analysierende Dokument-URL. Entweder urlSource oder base64Source muss angegeben werden.

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

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "urlSource": "http://host.com/doc.pdf"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview

Definitionen

Name	Beschreibung
AnalyzeDocumentRequest	Dokumentanalyseparameter.
ContentFormat	Format des Inhalts im analysierten Ergebnis.
DocumentAnalysisFeature	Liste der optionalen Analysefeatures.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
StringIndexType	Methode, die zum Berechnen von Zeichenfolgenoffset und -länge verwendet wird.

AnalyzeDocumentRequest

Dokumentanalyseparameter.

Name	Typ	Beschreibung
base64Source	string	Base64-Codierung des zu analysierenden Dokuments. Entweder urlSource oder base64Source muss angegeben werden.
urlSource	string	Zu analysierende Dokument-URL. Entweder urlSource oder base64Source muss angegeben werden.

ContentFormat

Format des Inhalts im analysierten Ergebnis.

Name	Typ	Beschreibung
markdown	string	Markdowndarstellung des Dokumentinhalts mit Abschnittsüberschriften, Tabellen usw.
text	string	Nur-Text-Darstellung des Dokumentinhalts ohne Formatierung.

DocumentAnalysisFeature

Liste der optionalen Analysefeatures.

Name	Typ	Beschreibung
barcodes	string	Aktivieren Sie die Erkennung von Barcodes im Dokument.
formulas	string	Aktivieren Sie die Erkennung mathematischer Ausdrücke im Dokument.
keyValuePairs	string	Aktivieren Sie die Erkennung allgemeiner Schlüsselwertpaare (Formularfelder) im Dokument.
languages	string	Aktivieren Sie die Erkennung der Textinhaltssprache.
ocrHighResolution	string	Führen Sie OCR mit einer höheren Auflösung aus, um Dokumente mit Kleingedrucktem zu verarbeiten.
queryFields	string	Aktivieren Sie die Extraktion zusätzlicher Felder über den Abfrageparameter queryFields.
styleFont	string	Aktivieren Sie die Erkennung verschiedener Schriftstile.

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.

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.