Freigeben über


Azure AI Document Intelligence (Formularerkennung)

Extrahiert Text (gedruckte und handschriftliche OCR) und zusätzliche Informationen (Tabellen, Kontrollkästchen, Felder/Schlüsselwertpaare) aus PDF-Dateien, Bildern oder Microsoft Office-Dokumenten und -Formularen in strukturierte Daten basierend auf vordefinierten Modellen (Layout, Rechnung, Beleg, ID, Visitenkarte) oder benutzerdefiniertem Modell, das von einer Reihe repräsentativer Schulungsformulare mithilfe von KI-gestütztem Dokumentverständnis erstellt wurde.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Norm Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     - US Department of Defense (DoD)
Power Apps - Nicht verfügbar
Power Automate Norm Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Department of Defense (DoD)
Kontakt
Name Microsoft
URL https://aka.ms/formrecognizer
Email formrecog_contact@microsoft.com
Connectormetadaten
Herausgeber Microsoft
Webseite https://aka.ms/formrecognizer
Datenschutzrichtlinie https://aka.ms/form-recognizer/privacy
Kategorien Künstliche Intelligenz; Business Intelligence

Der Azure AI Document Intelligence-Connector (früher Form Recognizer) stellt eine Integration in Azure AI Document Intelligence bereit. Es ermöglicht das Analysieren und Extrahieren von Informationen aus Formularen, Rechnungen, Belegen, Visitenkarten, ID-Dokumenten und mehreren anderen Dokumenttypen.

Voraussetzungen

Um diese Integration zu verwenden, benötigen Sie eine Azure AI Document Intelligence-Ressource im Azure-Portal. Erstellen einer Ressourcenverknüpfung. Sie erhalten einen Endpunkt und einen Schlüssel für die Authentifizierung Ihrer Anwendungen. Um eine Verbindung herzustellen, geben Sie den Kontoschlüssel, die Website-URL an, und wählen Sie " Verbindung erstellen" aus. Weitere Informationen zu Betriebskosten für Ihre Verbindung finden Sie hier.

So erhalten Sie Anmeldeinformationen

  1. Öffnen Sie die Document Intelligence-Ressource im Azure-Portal (siehe Voraussetzungen).
  2. Auswählen von Schlüsseln und Endpunkt unter Ressourcenverwaltung
  3. Kopieren Sie Endpunkt und Schlüssel , und verwenden Sie sie, um eine neue Verbindung zu erstellen.

Erste Schritte mit Ihrem Connector

Am einfachsten können Sie den Dokumentintelligenzkonnektor ausprobieren, um alle vorgefertigten Modelle (vorkonfigurierte Rechnung, vorkonfiguriertes Layout usw.) zu verwenden. Stellen Sie PDF oder Bild Ihres Dokuments bereit. Analysieren Sie den Verbindervorgang basierend auf Dem Dokumenttyp, und prüfen Sie erkannte Felder. Vollständige Liste der Modelle und unterstützten Features hier.

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

API-Schlüssel Bereitstellen des Ressourcennamens für Dokument intellignce und des API-Schlüssels. Alle Regionen Freigabefähig
Verwaltete Logic Apps-Identität Erstellen einer Verbindung mit einer verwalteten LogicApps-Identität NUR LOGICAPPS Freigabefähig
Microsoft Entra ID-integriert Verwenden der Microsoft Entra-ID für den Zugriff Alle Regionen Nicht teilbar
Standard [VERALTET] Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt. Alle Regionen Nicht teilbar

API-Schlüssel

Auth-ID: keyBasedAuth

Anwendbar: Alle Regionen

Bereitstellen des Ressourcennamens für Dokument intellignce und des API-Schlüssels.

Dies ist eine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird auch die Verbindung freigegeben. Weitere Informationen finden Sie in der Übersicht über Connectors für Canvas-Apps – Power Apps | Microsoft-Dokumente

Name Typ Description Erforderlich
Kontoschlüssel securestring Dokumentintelligenzkontoschlüssel Richtig
Endpunkt-URL Schnur Document Intelligence-Endpunkt-URL (Beispiel: https://your-documentintelligence-resource.cognitiveservices.azure.com/) Richtig

Verwaltete Identität von Logik-Apps

Auth-ID: managedIdentityAuth

Anwendbar: NUR LOGICAPPS

Erstellen einer Verbindung mit einer verwalteten LogicApps-Identität

Dies ist eine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird auch die Verbindung freigegeben. Weitere Informationen finden Sie in der Übersicht über Connectors für Canvas-Apps – Power Apps | Microsoft-Dokumente

Name Typ Description Erforderlich
LogicApps Managed Identity managedIdentity Anmelden mit einer verwalteten Logik-App-Identität Richtig
Endpunkt-URL Schnur Document Intelligence-Endpunkt-URL (Beispiel: https://your-documentintelligence-resource.cognitiveservices.azure.com/) Richtig

Microsoft Entra ID Integriert

Authentifizierungs-ID: oauth

Anwendbar: Alle Regionen

Verwenden der Microsoft Entra-ID für den Zugriff

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
Endpunkt-URL Schnur Document Intelligence-Endpunkt-URL (Beispiel: https://your-documentintelligence-resource.cognitiveservices.azure.com/) Richtig

Standard [VERALTET]

Anwendbar: Alle Regionen

Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
Kontoschlüssel securestring Dokumentintelligenzkontoschlüssel Richtig
Endpunkt-URL Schnur Document Intelligence-Endpunkt-URL (Beispiel: https://your-documentintelligence-resource.cognitiveservices.azure.com/) Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 1200 60 Sekunden

Aktionen

Analyse-ID-Dokument (veraltet) [VERALTET]

Extrahieren Von Feldtext und semantischen Werten aus einem bestimmten ID-Dokument (veraltet).

Analysebestätigung (veraltet) [VERALTET]

Extrahieren Von Feldtext und semantischen Werten aus einem bestimmten Belegdokument (veraltet).

Analyselayout (veraltet) [VERALTET]

Extrahieren von Text- und Layoutinformationen aus einem bestimmten Dokument (veraltet).

Analysieren des Dokuments für vordefinierte oder benutzerdefinierte Modelle (v3.x-API)

Extrahieren Sie Schlüsselwertpaare, Tabellen und semantische Werte aus einem bestimmten Dokument (v3.x API).

Analysieren des Dokuments für vordefinierte oder benutzerdefinierte Modelle (v4.x-API)

Extrahieren Sie Schlüsselwertpaare, Tabellen und semantische Werte aus einem bestimmten Dokument (v4.x API).

Benutzerdefiniertes Formular analysieren (veraltet) [VERALTET]

Extrahieren Sie Schlüsselwertpaare, Tabellen und semantische Werte aus einem bestimmten Dokument (veraltet).

Klassifizieren des Dokuments mit Dokumentklassifizierer (v3.1-API)

Klassifizieren des Dokuments mit Dokumentklassifizierer (v3.1-API).

Klassifizieren des Dokuments mit Dokumentklassifizierer (v4.x-API)

Klassifizieren des Dokuments mit Dokumentklassifizierer (v4.x-API).

Rechnung analysieren (veraltet) [VERALTET]

Extrahieren Sie Feldtext und semantische Werte aus einem bestimmten Rechnungsdokument (veraltet).

Visitenkarte analysieren (veraltet) [VERALTET]

Extrahieren von Feldtext und semantischen Werten aus einem bestimmten Visitenkartendokument (veraltet).

Analyse-ID-Dokument (veraltet) [VERALTET]

Extrahieren Von Feldtext und semantischen Werten aus einem bestimmten ID-Dokument (veraltet).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Textdetails einschließen
includeTextDetails boolean

Fügen Sie Textzeilen und Elementverweise in das Ergebnis ein. Standard: True (nur für FR-Connector).

Seiten
pages string

Die Seitenauswahl für mehrseitige PDF- und TIFF-Dokumente, um Rechnungsinformationen aus einzelnen Seiten und einen Seitenbereich (z. B. Seite 2 und Seiten 5-7) zu extrahieren, indem Sie die Seitenzahlen und Bereiche eingeben, die durch Kommas getrennt sind (z. B. "2, 5-7"). Wenn nicht festgelegt, werden alle Seiten verarbeitet.

Inhalt der Dokument-/Bilddatei
inputFileContent binary

Eine ZU analysierende PDF-Dokument- oder Bilddatei (JPG oder PNG).

Dokument-/Bild-URL
inputFileUrl string

URL-Pfad für eingabedatei. Alternative zu Dokument-/Bilddateiinhalt.

Gibt zurück

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Analysebestätigung (veraltet) [VERALTET]

Extrahieren Von Feldtext und semantischen Werten aus einem bestimmten Belegdokument (veraltet).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Textdetails einschließen
includeTextDetails boolean

Fügen Sie Textzeilen und Elementverweise in das Ergebnis ein. Standard: True (nur für FR-Connector).

Seiten
pages string

Die Seitenauswahl für mehrseitige PDF- und TIFF-Dokumente, um Rechnungsinformationen aus einzelnen Seiten und einen Seitenbereich (z. B. Seite 2 und Seiten 5-7) zu extrahieren, indem Sie die Seitenzahlen und Bereiche eingeben, die durch Kommas getrennt sind (z. B. "2, 5-7"). Wenn nicht festgelegt, werden alle Seiten verarbeitet.

Gebietsschema
locale string

Gebietsschema der Rechnung. Das unterstützte Gebietsschema umfasst: en-US.

Inhalt der Dokument-/Bilddatei
inputFileContent binary

Eine ZU analysierende PDF-Dokument- oder Bilddatei (JPG oder PNG).

Dokument-/Bild-URL
inputFileUrl string

URL-Pfad für eingabedatei. Alternative zu Dokument-/Bilddateiinhalt.

Gibt zurück

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Analyselayout (veraltet) [VERALTET]

Extrahieren von Text- und Layoutinformationen aus einem bestimmten Dokument (veraltet).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seiten
pages string

Die Seitenauswahl für mehrseitige PDF- und TIFF-Dokumente, um Rechnungsinformationen aus einzelnen Seiten und einen Seitenbereich (z. B. Seite 2 und Seiten 5-7) zu extrahieren, indem Sie die Seitenzahlen und Bereiche eingeben, die durch Kommas getrennt sind (z. B. "2, 5-7"). Wenn nicht festgelegt, werden alle Seiten verarbeitet.

Language
language string

Der BCP-47-Sprachcode des Texts im Dokument.

Lesereihenfolge
readingOrder string

Optionaler Parameter, um anzugeben, welcher Lesereihenfolgenalgorithmus beim Sortieren der Extrakttextelemente angewendet werden soll. Kann entweder "einfach" oder "natürlich" sein. Wird standardmäßig auf "einfach" festgelegt, falls nicht angegeben.

Inhalt der Dokument-/Bilddatei
inputFileContent binary

Eine ZU analysierende PDF-Dokument- oder Bilddatei (JPG oder PNG).

Dokument-/Bild-URL
inputFileUrl string

URL-Pfad für eingabedatei. Alternative zu Dokument-/Bilddateiinhalt.

Gibt zurück

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Analysieren des Dokuments für vordefinierte oder benutzerdefinierte Modelle (v3.x-API)

Extrahieren Sie Schlüsselwertpaare, Tabellen und semantische Werte aus einem bestimmten Dokument (v3.x API).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentintelligenz-API-Version
api-version True string

Dokumentintelligenz-API-Version.

Modellbezeichner
modelId True string

Prebuilt modelIds: prebuilt-read, prebuilt-layout, prebuilt-document, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt, prebuilt-tax.us.w2, prebuilt-impfCard, prebuilt-healthInsuranceCard.us. Benutzerdefiniertes modelId-Format - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Eindeutiger Modellname.

Seiten
pages string

Die Seitenauswahl für mehrseitige PDF- und TIFF-Dokumente, um Rechnungsinformationen aus einzelnen Seiten und einen Seitenbereich (z. B. Seite 2 und Seiten 5-7) zu extrahieren, indem Sie die Seitenzahlen und Bereiche eingeben, die durch Kommas getrennt sind (z. B. "2, 5-7"). Wenn nicht festgelegt, werden alle Seiten verarbeitet.

Gebietsschema
locale 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.

Zeichenfolgenindextyp
stringIndexType string

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge. Unterstützte Optionen: textElements, unicodeCodePoint, utf16CodeUnit.

Optionale und Premium-Features
features array

Liste der optionalen Analysefunktionen (z. B. ocrHighResolution, Sprachen, Barcodes, Formeln, keyValuePairs und styleFont).

Inhalt der Dokument-/Bilddatei
inputFileContent binary

Eine ZU analysierende PDF-Dokument- oder Bilddatei (JPG, PNG, BMP, TIFF).

Dokument-/Bild-URL
inputFileUrl string

URL-Pfad für eingabedatei. Alternative zu Dokument-/Bilddateiinhalt.

Gibt zurück

Status und Ergebnis des Analysevorgangs.

Analysieren des Dokuments für vordefinierte oder benutzerdefinierte Modelle (v4.x-API)

Extrahieren Sie Schlüsselwertpaare, Tabellen und semantische Werte aus einem bestimmten Dokument (v4.x API).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentintelligenz-API-Version
api-version True string

Dokumentintelligenz-API-Version.

Modellbezeichner
modelId True string

Prebuilt modelIds: prebuilt-read, prebuilt-layout, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt, prebuilt-tax.us.w2, prebuilt-impfCard, prebuilt-healthInsuranceCard.us, prebuilt-tax.us.1098, prebuilt-tax.us.1098E, prebuilt-tax.us.1098T, prebuilt-contract usw. Benutzerdefiniertes modelId-Format - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Eindeutiger Modellname.

Inhalt der Dokument-/Bilddatei
inputFileContent binary

Eine ZU analysierende PDF-Dokument- oder Bilddatei (JPG, PNG, BMP, TIFF).

Dokument-/Bild-URL
inputFileUrl string

URL-Pfad für eingabedatei. Alternative zu Dokument-/Bilddateiinhalt.

Seiten
pages string

Die Seitenauswahl für mehrseitige PDF- und TIFF-Dokumente, um Rechnungsinformationen aus einzelnen Seiten und einen Seitenbereich (z. B. Seite 2 und Seiten 5-7) zu extrahieren, indem Sie die Seitenzahlen und Bereiche eingeben, die durch Kommas getrennt sind (z. B. "2, 5-7"). Wenn nicht festgelegt, werden alle Seiten verarbeitet.

Gebietsschema
locale 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.

Zeichenfolgenindextyp
stringIndexType string

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge. Unterstützte Optionen: textElements, unicodeCodePoint, utf16CodeUnit.

Optionale und Premium-Features
features array

Liste der optionalen Analysefunktionen (z. B. ocrHighResolution, Sprachen, Barcodes, Formeln, keyValuePairs, styleFont und queryFields).

Abfragefelder
queryFields array

Liste der zu extrahierenden zusätzlichen Felder. Ex. "NumberOfGuests,StoreNumber"

Ausgabeinhaltsformat
outputContentFormat string

Format des Inhalts auf oberster Ebene des Analyseergebnisses.

Gibt zurück

Status und Ergebnis des Analysevorgangs.

Benutzerdefiniertes Formular analysieren (veraltet) [VERALTET]

Extrahieren Sie Schlüsselwertpaare, Tabellen und semantische Werte aus einem bestimmten Dokument (veraltet).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Modellbezeichner
modelId True string

Format - uuid. Modellbezeichner.

Textdetails einschließen
includeTextDetails boolean

Fügen Sie Textzeilen und Elementverweise in das Ergebnis ein. Standard: True (nur für FR-Connector).

Seiten
pages string

Die Seitenauswahl für mehrseitige PDF- und TIFF-Dokumente, um Rechnungsinformationen aus einzelnen Seiten und einen Seitenbereich (z. B. Seite 2 und Seiten 5-7) zu extrahieren, indem Sie die Seitenzahlen und Bereiche eingeben, die durch Kommas getrennt sind (z. B. "2, 5-7"). Wenn nicht festgelegt, werden alle Seiten verarbeitet.

Inhalt der Dokument-/Bilddatei
inputFileContent binary

Eine ZU analysierende PDF-Dokument- oder Bilddatei (JPG oder PNG).

Dokument-/Bild-URL
inputFileUrl string

URL-Pfad für eingabedatei. Alternative zu Dokument-/Bilddateiinhalt.

Gibt zurück

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Klassifizieren des Dokuments mit Dokumentklassifizierer (v3.1-API)

Klassifizieren des Dokuments mit Dokumentklassifizierer (v3.1-API).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Klassifiziererbezeichner
classifierId True string

Format - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Eindeutiger Klassifizierername.

Seiten
pages string

Die Seitenauswahl für mehrseitige PDF- und TIFF-Dokumente, um Informationen aus einzelnen Seiten und einem Seitenbereich (z. B. Seite 2 und Seiten 5-7) zu extrahieren, indem Sie die Seitenzahlen und Bereiche eingeben, die durch Kommas getrennt sind (z. B. "2, 5-7"). Wenn nicht festgelegt, werden alle Seiten verarbeitet.

Gebietsschema
locale 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.

Zeichenfolgenindextyp
stringIndexType string

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge. Unterstützte Optionen: textElements, unicodeCodePoint, utf16CodeUnit.

Inhalt der Dokument-/Bilddatei
inputFileContent binary

Eine ZU analysierende PDF-Dokument- oder Bilddatei (JPG, PNG, BMP, TIFF).

Dokument-/Bild-URL
inputFileUrl string

URL-Pfad für eingabedatei. Alternative zu Dokument-/Bilddateiinhalt.

Gibt zurück

Status und Ergebnis des Analysevorgangs.

Klassifizieren des Dokuments mit Dokumentklassifizierer (v4.x-API)

Klassifizieren des Dokuments mit Dokumentklassifizierer (v4.x-API).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentintelligenz-API-Version
api-version True string

Dokumentintelligenz-API-Version.

Klassifiziererbezeichner
classifierId True string

Format - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Eindeutiger Klassifizierername.

Inhalt der Dokument-/Bilddatei
inputFileContent binary

Eine ZU analysierende PDF-Dokument- oder Bilddatei (JPG, PNG, BMP, TIFF).

Dokument-/Bild-URL
inputFileUrl string

URL-Pfad für eingabedatei. Alternative zu Dokument-/Bilddateiinhalt.

Geteilter Modus
split string

Verhalten beim Teilen von Dateien.

Seiten
pages string

Die Seitenauswahl für mehrseitige PDF- und TIFF-Dokumente, um Informationen aus einzelnen Seiten und einem Seitenbereich (z. B. Seite 2 und Seiten 5-7) zu extrahieren, indem Sie die Seitenzahlen und Bereiche eingeben, die durch Kommas getrennt sind (z. B. "2, 5-7"). Wenn nicht festgelegt, werden alle Seiten verarbeitet.

Gebietsschema
locale 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.

Zeichenfolgenindextyp
stringIndexType string

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge. Unterstützte Optionen: textElements, unicodeCodePoint, utf16CodeUnit.

Gibt zurück

Status und Ergebnis des Analysevorgangs.

Rechnung analysieren (veraltet) [VERALTET]

Extrahieren Sie Feldtext und semantische Werte aus einem bestimmten Rechnungsdokument (veraltet).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Textdetails einschließen
includeTextDetails boolean

Fügen Sie Textzeilen und Elementverweise in das Ergebnis ein. Standard: True (nur für FR-Connector).

Seiten
pages string

Die Seitenauswahl für mehrseitige PDF- und TIFF-Dokumente, um Rechnungsinformationen aus einzelnen Seiten und einen Seitenbereich (z. B. Seite 2 und Seiten 5-7) zu extrahieren, indem Sie die Seitenzahlen und Bereiche eingeben, die durch Kommas getrennt sind (z. B. "2, 5-7"). Wenn nicht festgelegt, werden alle Seiten verarbeitet.

Gebietsschema
locale string

Gebietsschema der Rechnung. Das unterstützte Gebietsschema umfasst: en-US.

Inhalt der Dokument-/Bilddatei
inputFileContent binary

Eine ZU analysierende PDF-Dokument- oder Bilddatei (JPG oder PNG).

Dokument-/Bild-URL
inputFileUrl string

URL-Pfad für eingabedatei. Alternative zu Dokument-/Bilddateiinhalt.

Gibt zurück

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Visitenkarte analysieren (veraltet) [VERALTET]

Extrahieren von Feldtext und semantischen Werten aus einem bestimmten Visitenkartendokument (veraltet).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Textdetails einschließen
includeTextDetails boolean

Fügen Sie Textzeilen und Elementverweise in das Ergebnis ein. Standard: True (nur für FR-Connector).

Seiten
pages string

Die Seitenauswahl für mehrseitige PDF- und TIFF-Dokumente, um Rechnungsinformationen aus einzelnen Seiten und einen Seitenbereich (z. B. Seite 2 und Seiten 5-7) zu extrahieren, indem Sie die Seitenzahlen und Bereiche eingeben, die durch Kommas getrennt sind (z. B. "2, 5-7"). Wenn nicht festgelegt, werden alle Seiten verarbeitet.

Gebietsschema
locale string

Gebietsschema der Rechnung. Das unterstützte Gebietsschema umfasst: en-US.

Inhalt der Dokument-/Bilddatei
inputFileContent binary

Eine ZU analysierende PDF-Dokument- oder Bilddatei (JPG oder PNG).

Dokument-/Bild-URL
inputFileUrl string

URL-Pfad für eingabedatei. Alternative zu Dokument-/Bilddateiinhalt.

Gibt zurück

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Definitionen

OperationStatus

Status des in die Warteschlange eingereihten Vorgangs.

Status des in die Warteschlange eingereihten Vorgangs.

LayoutAnalyzeOperationResult

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Name Pfad Typ Beschreibung
status
status OperationStatus

Status des in die Warteschlange eingereihten Vorgangs.

createdDateTime
createdDateTime string

Datum und Uhrzeit (UTC), an dem der Analysevorgang übermittelt wurde.

lastUpdatedDateTime
lastUpdatedDateTime string

Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wird.

analyzeResult
analyzeResult LayoutAnalyzeResult

Analyse des Vorgangsergebnisses.

InvoiceAnalyzeOperationResult

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Name Pfad Typ Beschreibung
status
status OperationStatus

Status des in die Warteschlange eingereihten Vorgangs.

createdDateTime
createdDateTime string

Datum und Uhrzeit (UTC), an dem der Analysevorgang übermittelt wurde.

lastUpdatedDateTime
lastUpdatedDateTime string

Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wird.

analyzeResult
analyzeResult InvoiceAnalyzeResult

Analyse des Vorgangsergebnisses.

BusinessCardAnalyzeOperationResult

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Name Pfad Typ Beschreibung
status
status OperationStatus

Status des in die Warteschlange eingereihten Vorgangs.

createdDateTime
createdDateTime string

Datum und Uhrzeit (UTC), an dem der Analysevorgang übermittelt wurde.

lastUpdatedDateTime
lastUpdatedDateTime string

Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wird.

analyzeResult
analyzeResult BusinessCardAnalyzeResult

Analyse des Vorgangsergebnisses.

ReceiptAnalyzeOperationResult

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Name Pfad Typ Beschreibung
status
status OperationStatus

Status des in die Warteschlange eingereihten Vorgangs.

createdDateTime
createdDateTime string

Datum und Uhrzeit (UTC), an dem der Analysevorgang übermittelt wurde.

lastUpdatedDateTime
lastUpdatedDateTime string

Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wird.

analyzeResult
analyzeResult ReceiptAnalyzeResult

Analyse des Vorgangsergebnisses.

IdAnalyzeOperationResult

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Name Pfad Typ Beschreibung
status
status OperationStatus

Status des in die Warteschlange eingereihten Vorgangs.

createdDateTime
createdDateTime string

Datum und Uhrzeit (UTC), an dem der Analysevorgang übermittelt wurde.

lastUpdatedDateTime
lastUpdatedDateTime string

Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wird.

analyzeResult
analyzeResult IdAnalyzeResult

Analyse des Vorgangsergebnisses.

CustomFormsAnalyzeOperationResult

Status und Ergebnis des in die Warteschlange eingereihten Analysevorgangs.

Name Pfad Typ Beschreibung
status
status OperationStatus

Status des in die Warteschlange eingereihten Vorgangs.

createdDateTime
createdDateTime string

Datum und Uhrzeit (UTC), an dem der Analysevorgang übermittelt wurde.

lastUpdatedDateTime
lastUpdatedDateTime string

Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wird.

analyzeResult
analyzeResult CustomFormsAnalyzeResult

Analyse des Vorgangsergebnisses.

FormOperationError

Fehler, der während eines Vorgangs gemeldet wurde.

Name Pfad Typ Beschreibung
message
message string

Fehlermeldung.

LayoutAnalyzeResult

Analyse des Vorgangsergebnisses.

Name Pfad Typ Beschreibung
Ausgabe
version string

Version des Schemas, das für dieses Ergebnis verwendet wird.

readResults
readResults array of ReadResult

Aus der Eingabe extrahierter Text.

pageResults
pageResults array of PageResult

Aus der Eingabe extrahierte Informationen auf Seitenebene.

Irrtümer
errors array of FormOperationError

Liste der Während des Analysevorgangs gemeldeten Fehler.

InvoiceAnalyzeResult

Analyse des Vorgangsergebnisses.

Name Pfad Typ Beschreibung
Ausgabe
version string

Version des Schemas, das für dieses Ergebnis verwendet wird.

readResults
readResults array of ReadResult

Aus der Eingabe extrahierter Text.

pageResults
pageResults array of PageResult

Aus der Eingabe extrahierte Informationen auf Seitenebene.

documentResults
documentResults array of InvoiceDocumentResult

Informationen auf Dokumentebene, die aus der Eingabe extrahiert wurden.

Irrtümer
errors array of FormOperationError

Liste der Während des Analysevorgangs gemeldeten Fehler.

BusinessCardAnalyzeResult

Analyse des Vorgangsergebnisses.

Name Pfad Typ Beschreibung
Ausgabe
version string

Version des Schemas, das für dieses Ergebnis verwendet wird.

readResults
readResults array of ReadResult

Aus der Eingabe extrahierter Text.

pageResults
pageResults array of PageResult

Aus der Eingabe extrahierte Informationen auf Seitenebene.

documentResults
documentResults array of BusinessCardDocumentResult

Informationen auf Dokumentebene, die aus der Eingabe extrahiert wurden.

Irrtümer
errors array of FormOperationError

Liste der Während des Analysevorgangs gemeldeten Fehler.

ReceiptAnalyzeResult

Analyse des Vorgangsergebnisses.

Name Pfad Typ Beschreibung
Ausgabe
version string

Version des Schemas, das für dieses Ergebnis verwendet wird.

readResults
readResults array of ReadResult

Aus der Eingabe extrahierter Text.

pageResults
pageResults array of PageResult

Aus der Eingabe extrahierte Informationen auf Seitenebene.

documentResults
documentResults array of ReceiptDocumentResult

Informationen auf Dokumentebene, die aus der Eingabe extrahiert wurden.

Irrtümer
errors array of FormOperationError

Liste der Während des Analysevorgangs gemeldeten Fehler.

IdAnalyzeResult

Analyse des Vorgangsergebnisses.

Name Pfad Typ Beschreibung
Ausgabe
version string

Version des Schemas, das für dieses Ergebnis verwendet wird.

readResults
readResults array of ReadResult

Aus der Eingabe extrahierter Text.

pageResults
pageResults array of PageResult

Aus der Eingabe extrahierte Informationen auf Seitenebene.

documentResults
documentResults array of IdDocumentResult

Informationen auf Dokumentebene, die aus der Eingabe extrahiert wurden.

Irrtümer
errors array of FormOperationError

Liste der Während des Analysevorgangs gemeldeten Fehler.

CustomFormsAnalyzeResult

Analyse des Vorgangsergebnisses.

Name Pfad Typ Beschreibung
Ausgabe
version string

Version des Schemas, das für dieses Ergebnis verwendet wird.

readResults
readResults array of ReadResult

Aus der Eingabe extrahierter Text.

pageResults
pageResults array of PageResult

Aus der Eingabe extrahierte Informationen auf Seitenebene.

documentResults
documentResults array of CustomFormsDocumentResult

Informationen auf Dokumentebene, die aus der Eingabe extrahiert wurden.

Irrtümer
errors array of FormOperationError

Liste der Während des Analysevorgangs gemeldeten Fehler.

ReadResult

Text, der aus einer Seite im Eingabedokument extrahiert wurde.

Name Pfad Typ Beschreibung
Seite
page integer

Die 1-basierte Seitenzahl im Eingabedokument.

Winkel
angle float

Die allgemeine Ausrichtung des Texts im Uhrzeigersinn, gemessen in Grad zwischen (-180, 180].

width
width float

Die Breite des Bilds bzw. der PDF-Datei in Pixel/Zoll.

height
height float

Die Höhe des Bilds bzw. der PDF-Datei in Pixel/Zoll.

Einheit
unit string

Die Einheit, die von den Eigenschaften Width, height und boundingBox verwendet wird. Bei Bildern ist die Einheit "Pixel". Für PDF ist die Einheit "inch".

Linien
lines array of TextLine

Wenn includeTextDetails auf "true" festgelegt ist, wird eine Liste der erkannten Textzeilen angezeigt. Die maximale Anzahl zurückgegebener Zeilen beträgt 300 pro Seite. Die Linien werden von oben nach unten, von links nach rechts sortiert, obwohl in bestimmten Fällen näherung mit höherer Priorität behandelt wird. Da die Sortierreihenfolge vom erkannten Text abhängt, kann sie sich über Bilder und OCR-Versionsupdates ändern. Daher sollte die Geschäftslogik auf dem tatsächlichen Zeilenstandort statt auf der Bestellung aufgebaut werden.

TextLine

Ein Objekt, das eine extrahierte Textzeile darstellt.

Name Pfad Typ Beschreibung
Text
text string

Der Textinhalt der Zeile.

boundingBox
boundingBox BoundingBox

Rahmenfeld mit viereckigen Koordinaten, die relativ zur oberen linken Ecke des Ursprünglichen Bilds angegeben sind. Die acht Zahlen stellen die vier Punkte im Uhrzeigersinn von der oberen linken Ecke relativ zur Textausrichtung dar. Für das Bild werden die Koordinaten (x, y) in Pixeln gemessen. Bei PDF werden die Koordinaten (x, y) in Zoll gemessen.

words
words array of TextWord

Liste der Wörter in der Textzeile.

TextWord

Ein Objekt, das ein Wort darstellt.

Name Pfad Typ Beschreibung
Text
text string

Der Textinhalt des Worts.

boundingBox
boundingBox BoundingBox

Rahmenfeld mit viereckigen Koordinaten, die relativ zur oberen linken Ecke des Ursprünglichen Bilds angegeben sind. Die acht Zahlen stellen die vier Punkte im Uhrzeigersinn von der oberen linken Ecke relativ zur Textausrichtung dar. Für das Bild werden die Koordinaten (x, y) in Pixeln gemessen. Bei PDF werden die Koordinaten (x, y) in Zoll gemessen.

Vertrauen
confidence Confidence

Konfidenzwert.

BoundingBox

Rahmenfeld mit viereckigen Koordinaten, die relativ zur oberen linken Ecke des Ursprünglichen Bilds angegeben sind. Die acht Zahlen stellen die vier Punkte im Uhrzeigersinn von der oberen linken Ecke relativ zur Textausrichtung dar. Für das Bild werden die Koordinaten (x, y) in Pixeln gemessen. Bei PDF werden die Koordinaten (x, y) in Zoll gemessen.

Name Pfad Typ Beschreibung
Gegenstände
float

PageResult

Extrahierte Informationen von einer einzelnen Seite.

Name Pfad Typ Beschreibung
Seite
page integer

Seitennummer.

clusterId
clusterId integer

Clusterbezeichner.

keyValue-Paare
keyValuePairs array of KeyValuePair

Liste der Schlüsselwertpaare, die aus der Seite extrahiert wurden.

Tabellen
tables array of DataTable

Liste der aus der Seite extrahierten Datentabellen.

Schlüssel-Wert-Paar

Informationen zum extrahierten Schlüsselwertpaar.

Name Pfad Typ Beschreibung
label
label string

Eine benutzerdefinierte Bezeichnung für den Schlüssel-Wert-Paareintrag.

key
key KeyValueElement

Informationen zum extrahierten Schlüssel oder Wert in einem Schlüsselwertpaar.

value
value KeyValueElement

Informationen zum extrahierten Schlüssel oder Wert in einem Schlüsselwertpaar.

Vertrauen
confidence Confidence

Konfidenzwert.

KeyValueElement

Informationen zum extrahierten Schlüssel oder Wert in einem Schlüsselwertpaar.

Name Pfad Typ Beschreibung
Text
text string

Der Textinhalt des Schlüssels oder Werts.

boundingBox
boundingBox BoundingBox

Rahmenfeld mit viereckigen Koordinaten, die relativ zur oberen linken Ecke des Ursprünglichen Bilds angegeben sind. Die acht Zahlen stellen die vier Punkte im Uhrzeigersinn von der oberen linken Ecke relativ zur Textausrichtung dar. Für das Bild werden die Koordinaten (x, y) in Pixeln gemessen. Bei PDF werden die Koordinaten (x, y) in Zoll gemessen.

Elemente
elements array of ElementReference

Wenn includeTextDetails auf "true" festgelegt ist, wird eine Liste von Verweisen auf die Textelemente, die diesen Schlüssel oder Wert bilden, festgelegt.

ElementReference

Verweisen auf eine Zeile oder ein Wort.

Verweisen auf eine Zeile oder ein Wort.

DataTable

Informationen zur extrahierten Tabelle, die auf einer Seite enthalten ist.

Name Pfad Typ Beschreibung
Zeilen
rows integer

Anzahl der Zeilen.

columns
columns integer

Anzahl der Spalten.

Zellen
cells array of DataTableCell

Liste der Zellen, die in der Tabelle enthalten sind.

DataTableCell

Informationen zur extrahierten Zelle in einer Tabelle.

Name Pfad Typ Beschreibung
rowIndex
rowIndex integer

Zeilenindex der Zelle.

columnIndex
columnIndex integer

Spaltenindex der Zelle.

rowSpan
rowSpan integer

Die Anzahl der Zeilen, die von dieser Zelle überspannt sind.

columnSpan
columnSpan integer

Die Anzahl der Spalten, die von dieser Zelle überspannt sind.

Text
text string

Textinhalt der Zelle.

boundingBox
boundingBox BoundingBox

Rahmenfeld mit viereckigen Koordinaten, die relativ zur oberen linken Ecke des Ursprünglichen Bilds angegeben sind. Die acht Zahlen stellen die vier Punkte im Uhrzeigersinn von der oberen linken Ecke relativ zur Textausrichtung dar. Für das Bild werden die Koordinaten (x, y) in Pixeln gemessen. Bei PDF werden die Koordinaten (x, y) in Zoll gemessen.

Elemente
elements array of ElementReference

Wenn includeTextDetails auf "true" festgelegt ist, wird eine Liste von Verweisen auf die Textelemente, die diese Tabellenzelle bilden, festgelegt.

isHeader
isHeader boolean

Gibt zurück, wenn es sich bei der aktuellen Zelle um eine Kopfzeilenzelle handelt.

isFooter
isFooter boolean

Gibt zurück, wenn die aktuelle Zelle eine Fußzeilenzelle ist.

InvoiceDocumentResult

Eine Gruppe extrahierter Felder, die dem Eingabedokument entsprechen.

Name Pfad Typ Beschreibung
docType
docType string

Dokumenttyp.

pageRange
pageRange array of integer

Nummer der ersten und letzten Seite, in der das Dokument gefunden wird.

fields
fields InvoiceFields

Rechnungsfelder für 2.1.

BusinessCardDocumentResult

Eine Gruppe extrahierter Felder, die dem Eingabedokument entsprechen.

Name Pfad Typ Beschreibung
docType
docType string

Dokumenttyp.

pageRange
pageRange array of integer

Nummer der ersten und letzten Seite, in der das Dokument gefunden wird.

fields
fields BusinessCardFields

BusinessCard-Felder für 2.1.

CustomFormsDocumentResult

Eine Gruppe extrahierter Felder, die dem Eingabedokument entsprechen.

Name Pfad Typ Beschreibung
docType
docType string

Dokumenttyp.

pageRange
pageRange array of integer

Nummer der ersten und letzten Seite, in der das Dokument gefunden wird.

Felder
_fields array of CustomFormsFields

Array von Feldern mit fieldName- und fieldValue-Eigenschaften.

ReceiptDocumentResult

Eine Gruppe extrahierter Felder, die dem Eingabedokument entsprechen.

Name Pfad Typ Beschreibung
docType
docType string

Dokumenttyp.

pageRange
pageRange array of integer

Nummer der ersten und letzten Seite, in der das Dokument gefunden wird.

fields
fields ReceiptFields

Belegfelder für 2.1.

IdDocumentResult

Eine Gruppe extrahierter Felder, die dem Eingabedokument entsprechen.

Name Pfad Typ Beschreibung
docType
docType string

Dokumenttyp.

pageRange
pageRange array of integer

Nummer der ersten und letzten Seite, in der das Dokument gefunden wird.

fields
fields IdFields

ID-Dokumentfelder für 2.1.

CustomFormsFields

Benutzerdefinierte Formularfelder.

Name Pfad Typ Beschreibung
Feldname
fieldName string
Feldwert
fieldValue FieldValue

Prognostiziertes Feldwertobjekt.

InvoiceFields

Rechnungsfelder für 2.1.

Name Pfad Typ Beschreibung
Fälliger Betrag (Text)
AmountDue.text string

Gibt den fälligen Betrag wie auf der Rechnung geschrieben zurück.

Fälliger Betrag (Zahl)
AmountDue.valueNumber number

Als Zahl formatiert. Beispiel: 1234.98.

Konfidenz des fälligen Betrags
AmountDue.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Rechnungsadresse
BillingAddress.text string
Vertrauensstellung der Rechnungsadresse
BillingAddress.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Rechnungsadressenempfänger
BillingAddressRecipient.text string
Konfidenz des Rechnungsadressenempfängers
BillingAddressRecipient.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Kundenadresse
CustomerAddress.text string
Vertrauen der Kundenadresse
CustomerAddress.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Empfänger der Kundenadresse
CustomerAddressRecipient.text string
Vertrauen des Kundenadressenempfängers
CustomerAddressRecipient.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Kunden-ID
CustomerId.text string
Vertrauen der Kunden-ID
CustomerId.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Kundenname
CustomerName.text string
Vertrauen des Kundennamens
CustomerName.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Fälligkeitsdatum (Text)
DueDate.text string

Gibt das Fälligkeitsdatum wie auf der Rechnung geschrieben zurück.

Fälligkeitsdatum (Datum)
DueDate.valueDate date

Als Datum formatiert. Beispiel: 2019-05-31.

Vertrauensstellung am Fälligkeitsdatum
DueDate.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Rechnungsdatum (Text)
InvoiceDate.text string

Gibt das Rechnungsdatum wie auf der Rechnung geschrieben zurück.

Rechnungsdatum (Datum)
InvoiceDate.valueDate date

Als Datum formatiert. Beispiel: 2019-05-31.

Konfidenz des Rechnungsdatums
InvoiceDate.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Rechnungskennung
InvoiceId.text string
Konfidenz der Rechnungs-ID
InvoiceId.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Rechnungssumme (Text)
InvoiceTotal.text string

Gibt den Rechnungsbetrag wie auf der Rechnung geschrieben zurück.

Rechnungssumme (Zahl)
InvoiceTotal.valueNumber number

Als Zahl formatiert. Beispiel: 1234.98.

Konfidenz der Rechnungssumme
InvoiceTotal.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Vorheriger unbezahlter Saldo (Text)
PreviousUnpaidBalance.text string

Gibt den vorherigen nicht bezahlten Saldo wie auf der Rechnung geschrieben zurück.

Vorheriger unbezahlter Saldo (Zahl)
PreviousUnpaidBalance.valueNumber number

Als Zahl formatiert. Beispiel: 1234.98.

Konfidenz des vorherigen unbezahlten Saldos
PreviousUnpaidBalance.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Bestellauftrag
PurchaseOrder.text string
Konfidenz der Bestellung
PurchaseOrder.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Adresse der Übermittlung
RemittanceAddress.text string
Konfidenz der Empfängeradresse
RemittanceAddress.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Empfänger der Empfängeradresse
RemittanceAddressRecipient.text string
Konfidenz des Empfängers der Übermittlungsadresse
RemittanceAddressRecipient.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Dienstadresse
ServiceAddress.text string
Zuverlässigkeit der Dienstadresse
ServiceAddress.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Dienstadressenempfänger
ServiceAddressRecipient.text string
Vertrauensstellung des Empfängers der Dienstadresse
ServiceAddressRecipient.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Service-Enddatum (Text)
ServiceEndDate.text string

Gibt das Enddatum des Diensts wie auf der Rechnung geschrieben zurück.

Service-Enddatum (Datum)
ServiceEndDate.valueDate date

Als Datum formatiert. Beispiel: 2019-05-31.

Enddatum des Diensts zu vertrauen
ServiceEndDate.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Dienstanfangsdatum (Text)
ServiceStartDate.text string

Gibt das Startdatum des Diensts wie auf der Rechnung geschrieben zurück.

Startdatum des Diensts (Datum)
ServiceStartDate.valueDate date

Als Datum formatiert. Beispiel: 2019-05-31.

Startdatum des Diensts
ServiceStartDate.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Versandadresse
ShippingAddress.text string
Konfidenz der Versandadresse
ShippingAddress.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Empfänger der Versandadresse
ShippingAddressRecipient.text string
Konfidenz des Empfängers der Versandadresse
ShippingAddressRecipient.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Teilergebnis (Text)
SubTotal.text string

Gibt teilergebnis wie auf der Rechnung geschrieben zurück.

Teilergebnis (Zahl)
SubTotal.valueNumber number

Als Zahl formatiert. Beispiel: 1234.98.

Konfidenz des Teilergebnisses
SubTotal.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Gesamtsteuer (Text)
TotalTax.text string

Gibt die Gesamtsteuer wie auf der Rechnung geschrieben zurück.

Gesamtsteuer (Nummer)
TotalTax.valueNumber number

Als Zahl formatiert. Beispiel: 1234.98.

Konfidenz der Gesamtsteuer
TotalTax.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Lieferantenadresse
VendorAddress.text string
Zuverlässigkeit der Lieferantenadresse
VendorAddress.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Empfänger der Lieferantenadresse
VendorAddressRecipient.text string
Vertrauen des Lieferantenadressenempfängers
VendorAddressRecipient.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Lieferantenname
VendorName.text string
Vertrauen des Lieferantennamens
VendorName.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Gegenstände
Items.valueArray array of object

Array von Zeilenelementen

Betrag (Text)
Items.valueArray.valueObject.Amount.text string

Gibt den Betrag zurück, der auf der Rechnung geschrieben wurde.

Betrag (Zahl)
Items.valueArray.valueObject.Amount.valueNumber number

Als Zahl formatiert. Beispiel: 12.

Konfidenz des Betrags
Items.valueArray.valueObject.Amount.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Description
Items.valueArray.valueObject.Description.text string
Konfidenz der Beschreibung
Items.valueArray.valueObject.Description.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Menge (Text)
Items.valueArray.valueObject.Quantity.text string

Gibt die Menge wie auf der Rechnung geschrieben zurück.

Menge (Zahl)
Items.valueArray.valueObject.Quantity.valueNumber number

Als Zahl formatiert. Beispiel: 12.

Konfidenz der Menge
Items.valueArray.valueObject.Quantity.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Einzelpreis (Text)
Items.valueArray.valueObject.UnitPrice.text string

Gibt den Stückpreis wie auf der Rechnung geschrieben zurück.

Einzelpreis (Zahl)
Items.valueArray.valueObject.UnitPrice.valueNumber number

Als Zahl formatiert. Beispiel: 12.

Konfidenz des Einzelpreises
Items.valueArray.valueObject.UnitPrice.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Produktcode
Items.valueArray.valueObject.ProductCode.text string
Konfidenz des Produktcodes
Items.valueArray.valueObject.ProductCode.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Einheit
Items.valueArray.valueObject.Unit.text string
Konfidenz der Einheit
Items.valueArray.valueObject.Unit.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Datum (Text)
Items.valueArray.valueObject.Date.text string

Gibt das Datum wie auf der Rechnung geschrieben zurück.

Datum (Datum)
Items.valueArray.valueObject.Date.valueDate date

Als Datum formatiert. Beispiel: 2019-05-31.

Konfidenz des Datums
Items.valueArray.valueObject.Date.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Steuern (Text)
Items.valueArray.valueObject.Tax.text string

Gibt die Steuer wie auf der Rechnung geschrieben zurück.

Steuern (Nummer)
Items.valueArray.valueObject.Tax.valueNumber number

Als Zahl formatiert. Beispiel: 12.

Konfidenz der Steuern
Items.valueArray.valueObject.Tax.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

BusinessCardFields

BusinessCard-Felder für 2.1.

Name Pfad Typ Beschreibung
Kontaktnamen
ContactNames.valueArray array of object

Array von Kontaktnamen

Vorname
ContactNames.valueArray.valueObject.FirstName.text string
Konfidenz des Vornamens
ContactNames.valueArray.valueObject.FirstName.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Nachname
ContactNames.valueArray.valueObject.LastName.text string
Konfidenz des Nachnamens
ContactNames.valueArray.valueObject.LastName.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Firmennamen
CompanyNames.valueArray array of object

Array von Firmennamen

Unternehmensname
CompanyNames.valueArray.text string
Vertrauen des Firmennamens
CompanyNames.valueArray.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Departments
Departments.valueArray array of object

Array von Abteilungen

Abteilung
Departments.valueArray.text string
Vertrauen der Abteilung
Departments.valueArray.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Stellenbezeichnungen
JobTitles.valueArray array of object

Array von Stellentiteln

Berufsbezeichnung
JobTitles.valueArray.text string
Konfidenz der Position
JobTitles.valueArray.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

E-Mails
Emails.valueArray array of object

Array von E-Mails

Email
Emails.valueArray.text string
Konfidenz von E-Mails
Emails.valueArray.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Webseiten
Websites.valueArray array of object

Array von Websites

Webseite
Websites.valueArray.text string
Vertrauen der Website
Websites.valueArray.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Addresses
Addresses.valueArray array of object

Array von Adressen

Adresse
Addresses.valueArray.text string
Zuverlässigkeit der Adresse
Addresses.valueArray.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Mobiltelefone
MobilePhones.valueArray array of object

Array von Mobiltelefonen

Mobiltelefonnummer
MobilePhones.valueArray.text string
Konfidenz des Mobiltelefons
MobilePhones.valueArray.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Faxe
Faxes.valueArray array of object

Array von Faxen

Faxnummer
Faxes.valueArray.text string
Konfidenz von Fax
Faxes.valueArray.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Arbeitstelefone
WorkPhones.valueArray array of object

Array von Arbeitstelefonen

Telefon (Arbeit)
WorkPhones.valueArray.text string
Konfidenz des Geschäftlichen Telefons
WorkPhones.valueArray.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Andere Telefone
OtherPhones.valueArray array of object

Array anderer Telefone

Anderes Telefon
OtherPhones.valueArray.text string
Konfidenz von anderen Telefonen
OtherPhones.valueArray.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

ReceiptFields

Belegfelder für 2.1.

Name Pfad Typ Beschreibung
Bontyp
ReceiptType.text string
Konfidenz des Belegtyps
ReceiptType.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Händlername
MerchantName.text string
Vertrauen des Händlernamens
MerchantName.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Händlertelefonnummer
MerchantPhoneNumber.text string
Vertrauen der Händlertelefonnummer
MerchantPhoneNumber.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Händleradresse
MerchantAddress.text string
Vertrauen der Händleradresse
MerchantAddress.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Transaktionsdatum (Text)
TransactionDate.text string

Gibt das Transaktionsdatum wie auf der Rechnung geschrieben zurück.

Transaktionsdatum (Datum)
TransactionDate.valueDate date

Als Datum formatiert. Beispiel: 2019-05-31.

Konfidenz des Transaktionsdatums
TransactionDate.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Transaktionszeit (Text)
TransactionTime.text string

Gibt die Transaktionszeit wie in der Rechnung geschrieben zurück.

Transaktionszeit (Zeit)
TransactionTime.valueDate time

Als Datum formatiert. Beispiel: 2019-05-31.

Konfidenz der Transaktionszeit
TransactionTime.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Summe (Text)
Total.text string

Gibt den Gesamtbetrag wie auf der Rechnung geschrieben zurück.

Summe (Zahl)
Total.valueNumber number

Als Zahl formatiert. Beispiel: 1234.98.

Konfidenz insgesamt
Total.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Teilergebnis (Text)
Subtotal.text string

Gibt teilergebnis wie auf der Rechnung geschrieben zurück.

Teilergebnis (Zahl)
Subtotal.valueNumber number

Als Zahl formatiert. Beispiel: 1234.98.

Konfidenz des Teilergebnisses
Subtotal.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Steuern (Text)
Tax.text string

Gibt die Steuer wie auf der Rechnung geschrieben zurück.

Steuern (Nummer)
Tax.valueNumber number

Als Zahl formatiert. Beispiel: 1234.98.

Konfidenz der Steuern
Tax.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Tipp (Text)
Tip.text string

Gibt den Tipp wie auf der Rechnung geschrieben zurück.

Tipp (Zahl)
Tip.valueNumber number

Als Zahl formatiert. Beispiel: 1234.98.

Konfidenz von Tipp
Tip.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Gegenstände
Items.valueArray array of object

Array von Zeilenelementen

Name
Items.valueArray.valueObject.Name.text string
Vertrauen des Namens
Items.valueArray.valueObject.Name.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Menge (Text)
Items.valueArray.valueObject.Quantity.text string

Gibt die Menge wie auf der Rechnung geschrieben zurück.

Menge (Zahl)
Items.valueArray.valueObject.Quantity.valueNumber number

Als Zahl formatiert. Beispiel: 12.

Konfidenz der Menge
Items.valueArray.valueObject.Quantity.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Preis (Text)
Items.valueArray.valueObject.Price.text string

Gibt den Preis wie auf der Rechnung geschrieben zurück.

Preis (Zahl)
Items.valueArray.valueObject.Price.valueNumber number

Als Zahl formatiert. Beispiel: 12.

Vertrauen des Preises
Items.valueArray.valueObject.Price.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Gesamtpreis (Text)
Items.valueArray.valueObject.TotalPrice.text string

Gibt den Gesamtpreis wie auf der Rechnung geschrieben zurück.

Gesamtpreis (Zahl)
Items.valueArray.valueObject.TotalPrice.valueNumber number

Als Zahl formatiert. Beispiel: 12.

Vertrauen des Gesamtpreises
Items.valueArray.valueObject.TotalPrice.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

IdFields

ID-Dokumentfelder für 2.1.

Name Pfad Typ Beschreibung
Landregion
CountryRegion.valueCountryRegion string
Konfidenz der Länderregion
CountryRegion.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Ablaufdatum
DateOfExpiration.text string

Gibt das Ablaufdatum wie auf der Rechnung geschrieben zurück.

Ablaufdatum (Datum)
DateOfExpiration.valueDate date

Als Datum formatiert. Beispiel: 2019-05-31.

Vertrauensstellung des Ablaufdatums
DateOfExpiration.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Geburtsdatum (Text)
DateOfBirth.text string

Gibt das Geburtsdatum wie auf der Rechnung geschrieben zurück.

Geburtsdatum (Datum)
DateOfBirth.valueDate date

Als Datum formatiert. Beispiel: 2019-05-31.

Konfidenz des Geburtsdatums
DateOfBirth.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Dokumentnummer
DocumentNumber.text string
Konfidenz der Dokumentnummer
DocumentNumber.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Vorname
FirstName.text string
Konfidenz des Vornamens
FirstName.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Nachname
LastName.text string
Konfidenz des Nachnamens
LastName.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Nationality
Nationality.valueCountryRegion string
Vertrauen in die Staatsangehörigkeit
Nationality.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Sex
Sex.text string
Konfidenz des Geschlechts
Sex.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Maschinenlesbare Zone
MachineReadableZone.text string
Konfidenz der maschinenlesbaren Zone
MachineReadableZone.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Dokumenttyp
DocumentType.text string
Konfidenz des Dokumenttyps
DocumentType.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Adresse
Address.text string
Zuverlässigkeit der Adresse
Address.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

Region
Region.text string
Konfidenz der Region
Region.confidence float

Wie sicher das Modell in seiner Vorhersage ist.

FieldValue

Prognostiziertes Feldwertobjekt.

Name Pfad Typ Beschreibung
type
type FieldValueType

Semantischer Datentyp des Feldwerts.

valueString
valueString string

Zeichenfolgenwert.

valueDate
valueDate date-time

Datumswert.

valueTime
valueTime date-time

Zeitwert.

valuePhoneNumber
valuePhoneNumber string

Telefonnummernwert.

valueNumber
valueNumber number

Gleitkommawert.

valueInteger
valueInteger integer

Ganzzahliger Wert.

Text
text string
boundingBox
boundingBox BoundingBox

Rahmenfeld mit viereckigen Koordinaten, die relativ zur oberen linken Ecke des Ursprünglichen Bilds angegeben sind. Die acht Zahlen stellen die vier Punkte im Uhrzeigersinn von der oberen linken Ecke relativ zur Textausrichtung dar. Für das Bild werden die Koordinaten (x, y) in Pixeln gemessen. Bei PDF werden die Koordinaten (x, y) in Zoll gemessen.

Vertrauen
confidence Confidence

Konfidenzwert.

Elemente
elements array of ElementReference

Wenn includeTextDetails auf "true" festgelegt ist, wird eine Liste von Verweisen auf die Textelemente, die dieses Feld bilden, festgelegt.

Seite
page integer

Die 1-basierte Seitenzahl im Eingabedokument.

FieldValueType

Semantischer Datentyp des Feldwerts.

Semantischer Datentyp des Feldwerts.

Zuverlässigkeit

Konfidenzwert.

Konfidenzwert.

ApiVersion_V30

API-Version.

API-Version.

AnalyzeResultOperation_V30

Status und Ergebnis des Analysevorgangs.

Name Pfad Typ Beschreibung
status
status string

Vorgangsstatus.

createdDateTime
createdDateTime date-time

Datum und Uhrzeit (UTC), wann der Analysevorgang übermittelt wurde.

lastUpdatedDateTime
lastUpdatedDateTime date-time

Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wurde.

Fehler
error Error_V30

Fehlerinformationen.

analyzeResult
analyzeResult AnalyzeResult_V30

Ergebnis der Dokumentanalyse.

AnalyzeResult_V30

Ergebnis der Dokumentanalyse.

Name Pfad Typ Beschreibung
apiVersion
apiVersion ApiVersion_V30

API-Version.

modelId
modelId ModelId_V30

Eindeutiger Modellname.

stringIndexType
stringIndexType StringIndexType_V30

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

Inhalt
content string

Verketten Sie die Zeichenfolgendarstellung aller Text- und visuellen Elemente in lesereihenfolge.

contentFormat
contentFormat ContentFormat_V40

Format des Inhalts im analysierten Ergebnis.

pages
pages array of DocumentPage_V30

Analysierte Seiten.

Paragraphen
paragraphs array of DocumentParagraph_V30

Extrahierte Absätze.

Tabellen
tables array of DocumentTable_V30

Extrahierte Tabellen.

Figuren
figures array of DocumentFigure_V40

Extrahierte Zahlen.

Abschnitte
sections array of DocumentSection_V40

Extrahierte Abschnitte.

keyValue-Paare
keyValuePairs array of DocumentKeyValuePair_V30

Extrahierte Schlüssel-Wert-Paare.

Entitäten
entities array of DocumentEntity_V30

Extrahierte Entitäten.

stile
styles array of DocumentStyle_V30

Extrahierte Schriftformate.

Sprachen
languages array of DocumentLanguage_V30

Erkannte Sprachen.

Urkunden
documents array of Document_V30

Extrahierte Dokumente.

Warnungen
warnings array of Warning_V40

Liste der aufgetretenen Warnungen.

DocumentPage_V30

Inhalt und Layoutelemente, die aus einer Seite aus der Eingabe extrahiert wurden.

Name Pfad Typ Beschreibung
freundlich
kind string

Art der Dokumentseite.

pageNumber
pageNumber integer

1-basierte Seitenzahl im Eingabedokument.

Winkel
angle number

Die allgemeine Ausrichtung des Inhalts im Uhrzeigersinn, gemessen in Grad zwischen (-180, 180].

width
width number

Die Breite des Bilds bzw. der PDF-Datei in Pixel/Zoll.

height
height number

Die Höhe des Bilds bzw. der PDF-Datei in Pixel/Zoll.

Einheit
unit string

Die Einheit, die von den Eigenschaften Breite, Höhe und Polygon verwendet wird. Bei Bildern ist die Einheit "Pixel". Für PDF ist die Einheit "inch".

spans
spans array of DocumentSpan_V30

Speicherort der Seite in der Lesereihenfolge verketteter Inhalte.

words
words array of DocumentWord_V30

Extrahierte Wörter aus der Seite.

selectionMarks
selectionMarks array of DocumentSelectionMark_V30

Extrahierte Auswahlmarkierungen von der Seite.

images
images array of DocumentImage_V30

Extrahierte Bilder von der Seite.

Linien
lines array of DocumentLine_V30

Extrahierte Zeilen von der Seite, die potenziell textbezogene und visuelle Elemente enthalten.

Barcodes
barcodes array of DocumentBarcode_V31

Extrahierte Barcodes von der Seite.

formulas
formulas array of DocumentFormula_V31

Extrahierte Formeln von der Seite.

DocumentWord_V30

Ein Wortobjekt, das aus einer zusammenhängenden Abfolge von Zeichen besteht. Bei nicht leerzeichentrennten Sprachen, z. B. Chinesisch, Japanisch und Koreanisch, wird jedes Zeichen als eigenes Wort dargestellt.

Name Pfad Typ Beschreibung
Inhalt
content string

Textinhalt des Worts.

polygon
polygon BoundingPolygon_V30

Umgebendes Polygon, mit Koordinaten, die relativ zur oberen linken Ecke der Seite angegeben sind. Die Zahlen stellen die x-, y-Werte der Polygonvertices dar, im Uhrzeigersinn von links (-180 Grad einschließlich) relativ zur Elementausrichtung.

span
span DocumentSpan_V30

Zusammenhängender Bereich der verketteten Inhaltseigenschaft, angegeben als Offset und Länge.

Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

DocumentSelectionMark_V30

Ein Auswahlmarkierungsobjekt, das Kontrollkästchen, Optionsfelder und andere Elemente darstellt, die eine Auswahl angeben.

Name Pfad Typ Beschreibung
Staat
state DocumentSelectionMarkState_V30

Status des Auswahlzeichens.

polygon
polygon BoundingPolygon_V30

Umgebendes Polygon, mit Koordinaten, die relativ zur oberen linken Ecke der Seite angegeben sind. Die Zahlen stellen die x-, y-Werte der Polygonvertices dar, im Uhrzeigersinn von links (-180 Grad einschließlich) relativ zur Elementausrichtung.

span
span DocumentSpan_V30

Zusammenhängender Bereich der verketteten Inhaltseigenschaft, angegeben als Offset und Länge.

Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

DocumentImage_V30

Ein Bildobjekt, das auf der Seite erkannt wurde.

Name Pfad Typ Beschreibung
polygon
polygon BoundingPolygon_V30

Umgebendes Polygon, mit Koordinaten, die relativ zur oberen linken Ecke der Seite angegeben sind. Die Zahlen stellen die x-, y-Werte der Polygonvertices dar, im Uhrzeigersinn von links (-180 Grad einschließlich) relativ zur Elementausrichtung.

span
span DocumentSpan_V30

Zusammenhängender Bereich der verketteten Inhaltseigenschaft, angegeben als Offset und Länge.

pageRef
pageRef integer

0-basierte Index des Arrays der globalen Seiten, das den Inhalt des Bilds enthält.

Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

DocumentSelectionMarkState_V30

Status des Auswahlzeichens.

Status des Auswahlzeichens.

DocumentStyle_V30

Ein Objekt, das beobachtete Textformatvorlagen darstellt.

Name Pfad Typ Beschreibung
backgroundColor
backgroundColor string

Hintergrundfarbe im hexadezimalen Format #rrggbb.

color
color string

Vordergrundfarbe im #rrggbb Hexadezimalformat.

fontStyle
fontStyle string

Schriftschnitt.

fontWeight
fontWeight string

Schriftbreite.

isHandwritten
isHandwritten boolean

Ist Inhalt handschriftlich.

similarFontFamily
similarFontFamily string

Visuell ähnlichste Schriftart aus der Gruppe der unterstützten Schriftfamilien mit Fallbackschriftarten nach css-Konvention (z. B. 'Arial, sans-serif').

spans
spans array of DocumentSpan_V30

Die Position der Textelemente im verketteten Inhalt, auf den die Formatvorlage angewendet wird.

Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

DocumentLanguage_V30

Ein Objekt, das die erkannte Sprache für einen bestimmten Textbereich darstellt.

Name Pfad Typ Beschreibung
Gebietsschema
locale string

Erkannte Sprache. Der Wert kann einen ISO 639-1-Sprachcode (z. B. "en", "fr") oder BCP 47-Sprachtag (z. B. "zh-Hans") aufweisen.

spans
spans array of DocumentSpan_V30

Speicherort der Textelemente im verketteten Inhalt, auf den die Sprache angewendet wird.

Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

DocumentLine_V30

Ein Inhaltszeilenobjekt, bestehend aus einer zusammenhängenden Sequenz von Inhaltselementen (z. B. Wörter und Auswahlmarkierungen).

Name Pfad Typ Beschreibung
Inhalt
content string

Verketteter Inhalt der enthaltenen Elemente in lesereihenfolge.

polygon
polygon BoundingPolygon_V30

Umgebendes Polygon, mit Koordinaten, die relativ zur oberen linken Ecke der Seite angegeben sind. Die Zahlen stellen die x-, y-Werte der Polygonvertices dar, im Uhrzeigersinn von links (-180 Grad einschließlich) relativ zur Elementausrichtung.

spans
spans array of DocumentSpan_V30

Position der Zeile in der Lesereihenfolge verketteter Inhalte.

DocumentParagraph_V30

Ein Absatzobjekt, das in der Regel mit zusammenhängenden Linien besteht, mit allgemeiner Ausrichtung und Abständen.

Name Pfad Typ Beschreibung
role
role string

Semantische Rolle des Absatzes.

Inhalt
content string

Verketteter Inhalt des Absatzes in Leserichtung.

boundingRegions
boundingRegions array of BoundingRegion_V30

Begrenzungsbereiche, die den Absatz abdecken.

spans
spans array of DocumentSpan_V30

Position des Absatzes in der Lesereihenfolge verketteter Inhalte.

DocumentTable_V30

Ein Tabellenobjekt, das tabellenzellen besteht, die in einem rechteckigen Layout angeordnet sind.

Name Pfad Typ Beschreibung
rowCount
rowCount integer

Anzahl der Zeilen in der Tabelle.

columnCount
columnCount integer

Anzahl der Spalten in der Tabelle.

Zellen
cells array of DocumentTableCell_V30

Zellen, die in der Tabelle enthalten sind.

Beschriftung
caption DocumentCaption_V30

Ein Objekt, das die Position und den Inhalt einer Tabellenbeschriftung darstellt.

fußnoten
footnotes array of DocumentFootnote_V30

Fußnoten, die der Tabelle zugeordnet sind.

boundingRegions
boundingRegions array of BoundingRegion_V30

Begrenzungsbereiche, die die Tabelle abdecken.

spans
spans array of DocumentSpan_V30

Position der Tabelle in der Lesereihenfolge verketteter Inhalte.

DocumentTableCell_V30

Ein Objekt, das die Position und den Inhalt einer Tabellenzelle darstellt.

Name Pfad Typ Beschreibung
freundlich
kind string

Tabellenzellentyp.

rowIndex
rowIndex integer

Zeilenindex der Zelle.

columnIndex
columnIndex integer

Spaltenindex der Zelle.

rowSpan
rowSpan integer

Die Anzahl der Zeilen, die von dieser Zelle überspannt sind.

columnSpan
columnSpan integer

Die Anzahl der Spalten, die von dieser Zelle überspannt sind.

Inhalt
content string

Verketteter Inhalt der Tabellenzelle in Leserichtung.

boundingRegions
boundingRegions array of BoundingRegion_V30

Begrenzungsbereiche, die die Tabellenzelle abdecken.

spans
spans array of DocumentSpan_V30

Position der Tabellenzelle in der Lesereihenfolge verketteter Inhalte.

DocumentCaption_V30

Ein Objekt, das die Position und den Inhalt einer Tabellenbeschriftung darstellt.

Name Pfad Typ Beschreibung
Inhalt
content string

Tabellenbeschriftungsinhalt.

boundingRegions
boundingRegions array of BoundingRegion_V30

Begrenzungsbereiche, die die Tabellenüberschrift abdecken.

spans
spans array of DocumentSpan_V30

Speicherort der Tabellenbeschriftung in der Lesereihenfolge verketteter Inhalte.

DocumentFootnote_V30

Ein Objekt, das die Position und den Inhalt einer Tabellennote darstellt.

Name Pfad Typ Beschreibung
Inhalt
content string

Tabellennoteninhalt.

boundingRegions
boundingRegions array of BoundingRegion_V30

Begrenzungsbereiche, die die Tabellennote abdecken.

spans
spans array of DocumentSpan_V30

Position der Tabellennote in der Lesereihenfolge verketteter Inhalte.

DocumentKeyValuePair_V30

Ein Objekt, das ein Formularfeld mit eindeutiger Feldbeschriftung (Schlüssel) und Feldwert darstellt (kann leer sein).

Name Pfad Typ Beschreibung
key
key DocumentKeyValueElement_V30

Ein Objekt, das den Feldschlüssel oder -wert in einem Schlüssel-Wert-Paar darstellt.

value
value DocumentKeyValueElement_V30

Ein Objekt, das den Feldschlüssel oder -wert in einem Schlüssel-Wert-Paar darstellt.

Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

DocumentKeyValueElement_V30

Ein Objekt, das den Feldschlüssel oder -wert in einem Schlüssel-Wert-Paar darstellt.

Name Pfad Typ Beschreibung
Inhalt
content string

Verketteter Inhalt des Schlüsselwertelements in Leserichtung.

boundingRegions
boundingRegions array of BoundingRegion_V30

Begrenzungsbereiche, die das Schlüsselwertelement abdecken.

spans
spans array of DocumentSpan_V30

Speicherort des Schlüsselwertelements in der Lesereihenfolge verketteter Inhalte.

DocumentEntity_V30

Ein Objekt, das verschiedene Kategorien von Entitäten darstellt.

Name Pfad Typ Beschreibung
Kategorie
category string

Der Entitätstyp.

Unterkategorie
subCategory string

Entitätsuntertyp.

Inhalt
content string

Entitätsinhalt.

boundingRegions
boundingRegions array of BoundingRegion_V30

Begrenzungsregionen, die die Entität abdecken.

spans
spans array of DocumentSpan_V30

Speicherort der Entität in der Lesereihenfolge verketteter Inhalte.

Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

DocumentBarcode_V31

Ein Barcodeobjekt.

Name Pfad Typ Beschreibung
Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

freundlich
kind string

Barcodeart.

polygon
polygon BoundingPolygon_V30

Umgebendes Polygon, mit Koordinaten, die relativ zur oberen linken Ecke der Seite angegeben sind. Die Zahlen stellen die x-, y-Werte der Polygonvertices dar, im Uhrzeigersinn von links (-180 Grad einschließlich) relativ zur Elementausrichtung.

span
span DocumentSpan_V30

Zusammenhängender Bereich der verketteten Inhaltseigenschaft, angegeben als Offset und Länge.

value
value string

Barcodewert

DocumentFormula_V31

Ein Formelobjekt.

Name Pfad Typ Beschreibung
Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

freundlich
kind string

Formeltyp.

polygon
polygon BoundingPolygon_V30

Umgebendes Polygon, mit Koordinaten, die relativ zur oberen linken Ecke der Seite angegeben sind. Die Zahlen stellen die x-, y-Werte der Polygonvertices dar, im Uhrzeigersinn von links (-180 Grad einschließlich) relativ zur Elementausrichtung.

span
span DocumentSpan_V30

Zusammenhängender Bereich der verketteten Inhaltseigenschaft, angegeben als Offset und Länge.

value
value string

LaTex-Ausdruck, der die Formel beschreibt.

DocumentFigure_V40

Ein Objekt, das eine Abbildung im Dokument darstellt.

Name Pfad Typ Beschreibung
boundingRegions
boundingRegions array of BoundingRegion_V30

Begrenzungsbereiche, die die Abbildung abdecken.

spans
spans array of DocumentSpan_V30

Position der Abbildung in der Lesereihenfolge verketteter Inhalte.

Elemente
elements array of DocumentElement_V40

Untergeordnete Elemente der Abbildung, mit Ausnahme von Beschriftungen oder Fußnoten.

Beschriftung
caption DocumentCaption_V30

Ein Objekt, das die Position und den Inhalt einer Tabellenbeschriftung darstellt.

fußnoten
footnotes array of DocumentFootnote_V30

Liste der Fußnoten, die der Abbildung zugeordnet sind.

id
id string

Abbildungs-ID.

DocumentSection_V40

Ein Objekt, das einen Abschnitt im Dokument darstellt.

Name Pfad Typ Beschreibung
spans
spans array of DocumentSpan_V30

Speicherort des Abschnitts in der Lesereihenfolge verketteter Inhalte.

Elemente
elements array of DocumentElement_V40

Untergeordnete Elemente des Abschnitts.

DocumentElement_V40

Ein JSON-Zeiger, der auf ein Element des Dokuments verweist, z. B. Absatz, Tabelle, Abschnitt usw.

Ein JSON-Zeiger, der auf ein Element des Dokuments verweist, z. B. Absatz, Tabelle, Abschnitt usw.

Warning_V40

Das Fehlerobjekt.

Name Pfad Typ Beschreibung
Code
code string

Einer der serverdefinierten Warnungscodes.

message
message string

Eine lesbare Darstellung der Warnung.

target
target string

Das Ziel des Fehlers.

ContentFormat_V40

Format des Inhalts im analysierten Ergebnis.

Format des Inhalts im analysierten Ergebnis.

Document_V30

Ein Objekt, das die Position und den semantischen Inhalt eines Dokuments beschreibt.

Name Pfad Typ Beschreibung
docType
docType DocType_V30

Dokumenttypname.

boundingRegions
boundingRegions array of BoundingRegion_V30

Umgebende Bereiche, die das Dokument abdecken.

spans
spans array of DocumentSpan_V30

Speicherort des Dokuments in der Lesereihenfolge verketteter Inhalte.

fields
fields object

Wörterbuch der benannten Feldwerte.

Felder
_fields array of DocumentFieldNameValue_V30

Array von Feldern mit fieldName- und fieldValue-Eigenschaften.

Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

BoundingPolygon_V30

Umgebendes Polygon, mit Koordinaten, die relativ zur oberen linken Ecke der Seite angegeben sind. Die Zahlen stellen die x-, y-Werte der Polygonvertices dar, im Uhrzeigersinn von links (-180 Grad einschließlich) relativ zur Elementausrichtung.

Name Pfad Typ Beschreibung
Gegenstände
number

BoundingRegion_V30

Umgebendes Polygon auf einer bestimmten Seite der Eingabe.

Name Pfad Typ Beschreibung
pageNumber
pageNumber integer

1-basierte Seitenzahl der Seite, die den umgebenden Bereich enthält.

polygon
polygon BoundingPolygon_V30

Umgebendes Polygon, mit Koordinaten, die relativ zur oberen linken Ecke der Seite angegeben sind. Die Zahlen stellen die x-, y-Werte der Polygonvertices dar, im Uhrzeigersinn von links (-180 Grad einschließlich) relativ zur Elementausrichtung.

DocumentFieldType_V30

Semantischer Datentyp des Feldwerts.

Semantischer Datentyp des Feldwerts.

DocumentFieldNameValue_V30

Document field object with field name and its value.

Name Pfad Typ Beschreibung
Feldname
fieldName string
fieldValue
fieldValue DocumentField_V30

Ein Objekt, das den Inhalt und die Position eines Feldwerts darstellt.

DocumentField_V30

Ein Objekt, das den Inhalt und die Position eines Feldwerts darstellt.

Name Pfad Typ Beschreibung
type
type DocumentFieldType_V30

Semantischer Datentyp des Feldwerts.

valueString
valueString string

Zeichenfolgenwert.

valueDate
valueDate date

Datumswert im Format JJJJ-MM-DD (ISO 8601).

valueTime
valueTime time

Zeitwert im hh:mm:ss-Format (ISO 8601).

valuePhoneNumber
valuePhoneNumber string

Telefonnummernwert im E.164-Format (z. B. +19876543210).

valueNumber
valueNumber number

Gleitkommawert.

valueInteger
valueInteger integer

Ganzzahliger Wert.

valueSelectionMark
valueSelectionMark DocumentSelectionMarkState_V30

Status des Auswahlzeichens.

valueSignature
valueSignature string

Vorhandensein einer Signatur.

valueCountryRegion
valueCountryRegion string

3-Buchstaben-Ländercodewert (ISO 3166-1 alpha-3).

valueCurrency
valueCurrency CurrencyValue_V30

Währungsfeldwert.

valueAddress
valueAddress AddressValue_V30

Adressfeldwert.

valueBoolean
valueBoolean boolean

Boolescher Wert.

Inhalt
content string

Feldinhalt.

boundingRegions
boundingRegions array of BoundingRegion_V30

Begrenzungsbereiche, die das Feld abdecken.

spans
spans array of DocumentSpan_V30

Position des Felds in der Lesereihenfolge verketteter Inhalte.

Vertrauen
confidence Confidence_V30

Vorhersagevertrauen.

Confidence_V30

Vorhersagevertrauen.

Vorhersagevertrauen.

DocType_V30

Dokumenttypname.

Dokumenttypname.

DocumentSpan_V30

Zusammenhängender Bereich der verketteten Inhaltseigenschaft, angegeben als Offset und Länge.

Name Pfad Typ Beschreibung
offset
offset integer

Nullbasierter Index des Inhalts, der durch die Spanne dargestellt wird.

length
length integer

Die Anzahl der Zeichen im Inhalt, der durch den Bereich dargestellt wird.

StringIndexType_V30

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.

ModelId_V30

Eindeutiger Modellname.

Eindeutiger Modellname.

Error_V30

Fehlerinformationen.

Name Pfad Typ Beschreibung
Code
code string

Fehlercode.

message
message string

Fehlermeldung.

target
target string

Das Ziel des Fehlers.

details
details array of InnerError_V30

Liste der detaillierten Fehler.

innererror
innererror InnerError_V30

Detaillierter Fehler.

InnerError_V30

Detaillierter Fehler.

Name Pfad Typ Beschreibung
Code
code string

Fehlercode.

message
message string

Fehlermeldung.

CurrencyValue_V30

Währungsfeldwert.

Name Pfad Typ Beschreibung
Menge
amount double

Währungsbetrag.

Währungscode
currencyCode string

Aufgelöster Währungscode (ISO 4217), falls vorhanden.

currencySymbol
currencySymbol string

Währungssymbolbezeichnung, falls vorhanden.

AddressValue_V30

Adressfeldwert.

Name Pfad Typ Beschreibung
houseNumber
houseNumber string

Haus- oder Gebäudenummer.

Pobox
poBox string

Post office box number.

Straße
road string

Straßenname.

city
city string

Name der Stadt, Stadt, Dorf usw.

Staat
state string

Verwaltungsabteilung der ersten Ebene.

postalCode
postalCode string

Postleitzahl, die für die E-Mail-Sortierung verwendet wird.

countryRegion
countryRegion string

Land oder Region.

Straßenadresse
streetAddress string

Adresse auf Straßenebene, ausgenommen Stadt, Bundesland, LandRegion und Postleitzahl.

cityDistrict
cityDistrict string

Bezirke oder Bezirke in einer Stadt, z. B. Brooklyn in New York City oder City of Enumeration in London.

Haus
house string

Buildname, z. B. World Trade Center.

Niveau
level string

Bodennummer, z. B. 3F.

stateDistrict
stateDistrict string

Verwaltungsabteilung der zweiten Ebene, die in bestimmten Gebietsschemas verwendet wird.

Vorort
suburb string

Inoffizieller Nachbarschaftsname, wie Chinatown.

Einheit
unit string

Wohnung oder Büronummer.