Document Models - Analyze Document

Dienst:

Azure AI Services

API-Version:

2024-07-31-preview

Analysiert das Dokument mit dem Dokumentmodell.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Der Document Intelligence-Dienstendpunkt.
modelId	path	True	string	Eindeutiger Dokumentmodellname. RegEx-Muster: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.
features	query		DocumentAnalysisFeature[]	Liste der optionalen Analysefeatures.
locale	query		string	Gebietsschemahinweise für die Texterkennung und Dokumentanalyse. Der Wert darf nur den Sprachcode (z. B. "en", "fr") oder BCP 47-Sprachtag (z. B. "en-US") enthalten.
output	query		AnalyzeOutputOption[]	Zusätzliche Ausgaben, die während der Analyse generiert werden sollen.
outputContentFormat	query		ContentFormat	Format des Inhalts auf oberster Ebene des Analyseergebnisses.
pages	query		string	Liste der zu analysierenden 1-basierten Seitenzahlen. Ex. "1-3,5,7-9" RegEx-Muster: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Liste der zu extrahierenden zusätzlichen Felder. Ex. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

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 zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Header Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	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

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Beispielanforderung

HTTP

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

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Beispiel für eine Antwort

Statuscode:

202

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

Analyze Document from Url

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

202

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

Definitionen

Name	Beschreibung
AnalyzeDocumentRequest	Dokumentanalyseparameter.
AnalyzeOutputOption	Zusätzliche Ausgaben, die während der Analyse generiert werden sollen.
ContentFormat	Format des Inhalts im analysierten Ergebnis.
DocumentAnalysisFeature	Dokumentanalysefeatures, die aktiviert werden sollen.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
StringIndexType	Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

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.

AnalyzeOutputOption

Zusätzliche Ausgaben, die während der Analyse generiert werden sollen.

Name	Typ	Beschreibung
figures	string	Generieren Sie zugeschnittene Bilder von erkannten Zahlen.
pdf	string	Generieren Sie durchsuchbare PDF-Ausgabe.

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

Dokumentanalysefeatures, die aktiviert werden sollen.

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 Feindruck zu verarbeiten.
queryFields	string	Aktivieren Sie die Extraktion zusätzlicher Felder über den QueryFields-Abfrageparameter.
styleFont	string	Aktivieren Sie die Erkennung verschiedener Schriftformate.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von 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 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	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	InnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

StringIndexType

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

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