Document Models - Analyze Document
Analysiert Das Dokument mit dem Dokumentmodell.
POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?api-version=2023-07-31
POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?pages={pages}&locale={locale}&stringIndexType={stringIndexType}&api-version=2023-07-31&features={features}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com |
model
|
path | True |
string |
Eindeutiger Name des Dokumentmodells. RegEx-Muster: |
api-version
|
query | True |
string |
Api-Version angefordert. |
features
|
query |
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. |
|
pages
|
query |
string |
Liste der zu analysierenden 1-basierten Seitenzahlen. Ex. 1-3,5,7-9 RegEx-Muster: |
|
string
|
query |
Methode, die zum Berechnen von Zeichenfolgenoffset und -länge verwendet wird. |
Anforderungsheader
Media Types: "application/json", "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 | Erforderlich | Typ | Beschreibung |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Der geheime Schlüssel für Ihr Azure Cognitive Services-Abonnement. |
Anforderungstext
Media Types: "application/json", "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 |
---|---|---|
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 wird erfolgreich in die Warteschlange gestellt. Header Operation-Location: string |
|
Other Status Codes |
Fehler aufgetreten. |
Sicherheit
Ocp-Apim-Subscription-Key
Der geheime Schlüssel für Ihr Azure Cognitive Services-Abonnement.
Typ:
apiKey
In:
header
Beispiele
Analyze Document from Base64 |
Analyze Document from Url |
Analyze Document from Base64
Beispielanforderung
POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31
{
"base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}
Beispiel für eine Antwort
Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31
Analyze Document from Url
Beispielanforderung
POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31
{
"urlSource": "http://host.com/doc.pdf"
}
Beispiel für eine Antwort
Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31
Definitionen
Name | Beschreibung |
---|---|
Analyze |
Dokumentanalyseparameter. |
Document |
Liste der optionalen Analysefeatures. |
Error |
Fehlerinformationen. |
Error |
Fehlerantwortobjekt. |
Inner |
Detaillierter Fehler. |
String |
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. |
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. |
styleFont |
string |
Aktivieren Sie die Erkennung verschiedener Schriftstile. |
Error
Fehlerinformationen.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode |
details |
Error[] |
Liste der detaillierten Fehler. |
innererror |
Detaillierter Fehler. |
|
message |
string |
Fehlermeldung. |
target |
string |
Ziel des Fehlers. |
ErrorResponse
Fehlerantwortobjekt.
Name | Typ | Beschreibung |
---|---|---|
error |
Fehlerinformationen. |
InnerError
Detaillierter Fehler.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode |
innererror |
Detaillierter Fehler. |
|
message |
string |
Fehlermeldung. |
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. |