Document Classifiers - Get Classify Result

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-07-31-preview

Ruft das Ergebnis des Dokumentklassifizierers ab.

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-07-31-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
classifierId	path	True	string	Eindeutiger Dokumentklassifizierername. RegEx-Muster: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
endpoint	path	True	string uri	Der Document Intelligence-Dienstendpunkt.
resultId	path	True	string uuid	Analysieren Sie die Ergebnis-ID des Vorgangs.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AnalyzeResultOperation	Die Anforderung ist erfolgreich.
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

Get Classify Document Result

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "status": "succeeded",
  "createdDateTime": "2021-09-24T13:00:46Z",
  "lastUpdatedDateTime": "2021-09-24T13:00:49Z",
  "analyzeResult": {
    "apiVersion": "2024-07-31-preview",
    "modelId": "myClassifier",
    "stringIndexType": "textElements",
    "contentFormat": "text",
    "content": "",
    "pages": [
      {
        "pageNumber": 1,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 2,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 3,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      }
    ],
    "documents": [
      {
        "docType": "formA",
        "boundingRegions": [
          {
            "pageNumber": 1,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          },
          {
            "pageNumber": 2,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      },
      {
        "docType": "formB",
        "boundingRegions": [
          {
            "pageNumber": 3,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      }
    ]
  }
}

Definitionen

Name	Beschreibung
AddressValue	Adressfeldwert.
AnalyzeResult	Ergebnis der Dokumentanalyse.
AnalyzeResultOperation	Status und Ergebnis des Analysevorgangs.
BoundingRegion	Umgebendes Polygon auf einer bestimmten Seite der Eingabe.
ContentFormat	Format des Inhalts im analysierten Ergebnis.
CurrencyValue	Währungsfeldwert.
Document	Ein Objekt, das die Position und den semantischen Inhalt eines Dokuments beschreibt.
DocumentBarcode	Ein Barcodeobjekt.
DocumentBarcodeKind	Barcodeart.
DocumentCaption	Ein Beschriftungsobjekt, das eine Tabelle oder Abbildung beschreibt.
DocumentField	Ein Objekt, das den Inhalt und die Position eines Feldwerts darstellt.
DocumentFieldType	Semantischer Datentyp des Feldwerts.
DocumentFigure	Ein Objekt, das eine Abbildung im Dokument darstellt.
DocumentFootnote	Ein Fußnotenobjekt, das eine Tabelle oder Abbildung beschreibt.
DocumentFormula	Ein Formelobjekt.
DocumentFormulaKind	Formeltyp.
DocumentKeyValueElement	Ein Objekt, das den Feldschlüssel oder -wert in einem Schlüssel-Wert-Paar darstellt.
DocumentKeyValuePair	Ein Objekt, das ein Formularfeld mit eindeutiger Feldbeschriftung (Schlüssel) und Feldwert darstellt (kann leer sein).
DocumentLanguage	Ein Objekt, das die erkannte Sprache für einen bestimmten Textbereich darstellt.
DocumentLine	Ein Inhaltszeilenobjekt, das aus einer angrenzenden Abfolge von Inhaltselementen besteht, z. B. Wörter und Auswahlzeichen.
DocumentPage	Inhalt und Layoutelemente, die aus einer Seite aus der Eingabe extrahiert wurden.
DocumentParagraph	Ein Absatzobjekt, das in der Regel mit zusammenhängenden Linien besteht, mit allgemeiner Ausrichtung und Abständen.
DocumentSection	Ein Objekt, das einen Abschnitt im Dokument darstellt.
DocumentSelectionMark	Ein Auswahlmarkierungsobjekt, das Kontrollkästchen, Optionsfelder und andere Elemente darstellt, die eine Auswahl angeben.
DocumentSelectionMarkState	Status des Auswahlzeichens.
DocumentSignatureType	Vorhandensein einer Signatur.
DocumentSpan	Zusammenhängender Bereich der verketteten Inhaltseigenschaft, angegeben als Offset und Länge.
DocumentStyle	Ein Objekt, das beobachtete Textformatvorlagen darstellt.
DocumentTable	Ein Tabellenobjekt, das tabellenzellen besteht, die in einem rechteckigen Layout angeordnet sind.
DocumentTableCell	Ein Objekt, das die Position und den Inhalt einer Tabellenzelle darstellt.
DocumentTableCellKind	Tabellenzellentyp.
DocumentWord	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.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
FontStyle	Schriftschnitt.
FontWeight	Schriftbreite.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
LengthUnit	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".
OperationStatus	Vorgangsstatus.
ParagraphRole	Semantische Rolle des Absatzes.
StringIndexType	Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.
Warning	Das Fehlerobjekt.

AddressValue

Adressfeldwert.

Name	Typ	Beschreibung
city	string	Name der Stadt, Stadt, Dorf usw.
cityDistrict	string	Bezirke oder Bezirke in einer Stadt, z. B. Brooklyn in New York City oder City of Enumeration in London.
countryRegion	string	Land/Region.
house	string	Buildname, z. B. World Trade Center.
houseNumber	string	Haus- oder Gebäudenummer.
level	string	Bodennummer, z. B. 3F.
poBox	string	Post office box number.
postalCode	string	Postleitzahl, die für die E-Mail-Sortierung verwendet wird.
road	string	Straßenname.
state	string	Verwaltungsabteilung der ersten Ebene.
stateDistrict	string	Verwaltungsabteilung der zweiten Ebene, die in bestimmten Gebietsschemas verwendet wird.
streetAddress	string	Adresse auf Straßenebene, ausgenommen Stadt, Bundesland, LandRegion und Postleitzahl.
suburb	string	Inoffizieller Nachbarschaftsname, wie Chinatown.
unit	string	Wohnung oder Büronummer

AnalyzeResult

Ergebnis der Dokumentanalyse.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die verwendet wird, um dieses Ergebnis zu erzeugen.
content	string	Verketten Sie die Zeichenfolgendarstellung aller Text- und visuellen Elemente in lesereihenfolge.
contentFormat	ContentFormat	Format des Inhalts auf oberster Ebene des Analyseergebnisses.
documents	Document[]	Extrahierte Dokumente.
figures	DocumentFigure[]	Extrahierte Zahlen.
keyValuePairs	DocumentKeyValuePair[]	Extrahierte Schlüssel-Wert-Paare.
languages	DocumentLanguage[]	Erkannte Sprachen.
modelId	string	Dokumentmodell-ID, die verwendet wird, um dieses Ergebnis zu erzeugen.
pages	DocumentPage[]	Analysierte Seiten.
paragraphs	DocumentParagraph[]	Extrahierte Absätze.
sections	DocumentSection[]	Extrahierte Abschnitte.
stringIndexType	StringIndexType	Methode zum Berechnen des Zeichenfolgenoffsets und der Länge.
styles	DocumentStyle[]	Extrahierte Schriftformate.
tables	DocumentTable[]	Extrahierte Tabellen.
warnings	Warning[]	Liste der aufgetretenen Warnungen.

AnalyzeResultOperation

Status und Ergebnis des Analysevorgangs.

Name	Typ	Beschreibung
analyzeResult	AnalyzeResult	Ergebnis der Dokumentanalyse.
createdDateTime	string	Datum und Uhrzeit (UTC), wann der Analysevorgang übermittelt wurde.
error	Error	Fehler während der Dokumentanalyse.
lastUpdatedDateTime	string	Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wurde.
status	OperationStatus	Vorgangsstatus. notStarted, running, succeeded, or failed

BoundingRegion

Umgebendes Polygon auf einer bestimmten Seite der Eingabe.

Name	Typ	Beschreibung
pageNumber	integer	1-basierte Seitenzahl der Seite, die den umgebenden Bereich enthält.
polygon	number[]	Umgebendes Polygon auf der Seite oder die gesamte Seite, falls nicht angegeben. Koordinaten, die relativ zur oberen linken Seite der Seite angegeben werden. Die Zahlen stellen die x-, y-Werte der Polygonvertices dar, im Uhrzeigersinn von links (-180 Grad einschließlich) relativ zur Elementausrichtung.

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.

CurrencyValue

Währungsfeldwert.

Name	Typ	Beschreibung
amount	number	Währungsbetrag.
currencyCode	string	Aufgelöster Währungscode (ISO 4217), falls vorhanden.
currencySymbol	string	Währungssymbolbezeichnung, falls vorhanden.

Document

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

Name	Typ	Beschreibung
boundingRegions	BoundingRegion[]	Umgebende Bereiche, die das Dokument abdecken.
confidence	number	Konfidenz, dass das Dokument ordnungsgemäß extrahiert wird.
docType	string	Dokumenttyp.
fields	<string, DocumentField>	Wörterbuch der benannten Feldwerte.
spans	DocumentSpan[]	Speicherort des Dokuments in der Lesereihenfolge verketteter Inhalte.

DocumentBarcode

Ein Barcodeobjekt.

Name	Typ	Beschreibung
confidence	number	Konfidenz, dass der Barcode richtig extrahiert wird.
kind	DocumentBarcodeKind	Barcodeart.
polygon	number[]	Umgebendes Polygon des Barcodes 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	DocumentSpan	Speicherort des Barcodes in der Lesereihenfolge verketteter Inhalte.
value	string	Barcodewert.

DocumentBarcodeKind

Barcodeart.

Name	Typ	Beschreibung
Aztec	string	Aztec-Code gemäß definition in ISO/IEC 24778:2008.
Codabar	string	Codabar-Barcode, wie in ANSI/AIM BC3-1995 definiert.
Code128	string	Code 128 Barcode, wie in ISO/IEC 15417:2007 definiert.
Code39	string	Code 39 Barcode, wie in ISO/IEC 16388:2007 definiert.
Code93	string	Code 93 Barcode, wie in ANSI/AIM BC5-1995 definiert.
DataBar	string	GS1 DataBar-Barcode.
DataBarExpanded	string	GS1 DataBar Expanded Barcode.
DataMatrix	string	Datenmatrixcode, wie in ISO/IEC 16022:2006 definiert.
EAN13	string	GS1 13-stellige Internationale Artikelnummer (Europäische Artikelnummer).
EAN8	string	GS1 8-stellige Internationale Artikelnummer (Europäische Artikelnummer).
ITF	string	Interleaved 2 of 5 barcode, as defined in ANSI/AIM BC2-1995.
MaxiCode	string	MaxCode, wie in ISO/IEC 16023:2000 definiert.
MicroQRCode	string	Mikro-QR-Code, wie in ISO/IEC 23941:2022 definiert.
PDF417	string	PDF417, wie in ISO 15438 definiert.
QRCode	string	QR-Code, wie in ISO/IEC 18004:2015 definiert.
UPCA	string	GS1 12-stelliger Universeller Produktcode.
UPCE	string	GS1 6-stelliger Universeller Produktcode.

DocumentCaption

Ein Beschriftungsobjekt, das eine Tabelle oder Abbildung beschreibt.

Name	Typ	Beschreibung
boundingRegions	BoundingRegion[]	Begrenzungsbereiche, die die Beschriftung abdecken.
content	string	Inhalt der Beschriftung.
elements	string[]	Untergeordnete Elemente der Beschriftung.
spans	DocumentSpan[]	Speicherort der Beschriftung in der Lesereihenfolge verketteter Inhalte.

DocumentField

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

Name	Typ	Beschreibung
boundingRegions	BoundingRegion[]	Begrenzungsbereiche, die das Feld abdecken.
confidence	number	Konfidenz, dass das Feld ordnungsgemäß extrahiert wird.
content	string	Feldinhalt.
spans	DocumentSpan[]	Position des Felds in der Lesereihenfolge verketteter Inhalte.
type	DocumentFieldType	Datentyp des Feldwerts.
valueAddress	AddressValue	Adresswert.
valueArray	DocumentField[]	Array von Feldwerten.
valueBoolean	boolean	Boolescher Wert.
valueCountryRegion	string	3-Buchstaben-Ländercodewert (ISO 3166-1 alpha-3).
valueCurrency	CurrencyValue	Währungswert.
valueDate	string	Datumswert im Format JJJJ-MM-DD (ISO 8601).
valueInteger	integer	Ganzzahliger Wert.
valueNumber	number	Gleitkommawert.
valueObject	<string, DocumentField>	Wörterbuch der benannten Feldwerte.
valuePhoneNumber	string	Telefonnummernwert im E.164-Format (z. B. +19876543210).
valueSelectionGroup	string[]	Auswahlgruppenwert.
valueSelectionMark	DocumentSelectionMarkState	Auswahlzeichenwert.
valueSignature	DocumentSignatureType	Vorhandensein einer Signatur.
valueString	string	Zeichenfolgenwert.
valueTime	string	Zeitwert im hh:mm:ss-Format (ISO 8601).

DocumentFieldType

Semantischer Datentyp des Feldwerts.

Name	Typ	Beschreibung
address	string	Analysierte Adresse.
array	string	Liste der Unterfelder desselben Typs.
boolean	string	Boolescher Wert, normalisiert auf "true" oder "false".
countryRegion	string	Land/Region, normalisiert auf ISO 3166-1 Alpha-3-Format (z. B. USA).
currency	string	Währungsbetrag mit optionalem Währungssymbol und Einheit.
date	string	Datum, normalisiert auf ISO 8601 (JJJJ-MM-DD) Format.
integer	string	Ganze Zahl, normalisiert auf 64-Bit-Ganzzahl mit Vorzeichen.
number	string	Gleitkommazahl, normalisiert in Gleitkommazahl mit doppelter Genauigkeit.
object	string	Benannte Liste von Unterfeldern potenziell unterschiedlicher Typen.
phoneNumber	string	Telefonnummer, normalisiert auf E.164 (+{CountryCode}{SubscriberNumber}) Format.
selectionGroup	string	Array der ausgewählten Zeichenfolgenwerte.
selectionMark	string	Ist das Feld ausgewählt?
signature	string	Ist die Signatur vorhanden?
string	string	Klartext.
time	string	Zeit, normalisiert auf ISO 8601 (hh:mm:ss)-Format.

DocumentFigure

Ein Objekt, das eine Abbildung im Dokument darstellt.

Name	Typ	Beschreibung
boundingRegions	BoundingRegion[]	Begrenzungsbereiche, die die Abbildung abdecken.
caption	DocumentCaption	Beschriftung, die der Abbildung zugeordnet ist.
elements	string[]	Untergeordnete Elemente der Abbildung, mit Ausnahme von Beschriftungen oder Fußnoten.
footnotes	DocumentFootnote[]	Liste der Fußnoten, die der Abbildung zugeordnet sind.
id	string	Abbildungs-ID.
spans	DocumentSpan[]	Position der Abbildung in der Lesereihenfolge verketteter Inhalte.

DocumentFootnote

Ein Fußnotenobjekt, das eine Tabelle oder Abbildung beschreibt.

Name	Typ	Beschreibung
boundingRegions	BoundingRegion[]	Begrenzungsbereiche, die die Fußnote abdecken.
content	string	Inhalt der Fußnote.
elements	string[]	Untergeordnete Elemente der Fußnote.
spans	DocumentSpan[]	Position der Fußnote in der Lesereihenfolge verketteter Inhalte.

DocumentFormula

Ein Formelobjekt.

Name	Typ	Beschreibung
confidence	number	Konfidenz, dass die Formel ordnungsgemäß extrahiert wird.
kind	DocumentFormulaKind	Formeltyp.
polygon	number[]	Umgebendes Polygon der Formel mit Koordinaten, die relativ zur oberen linken Seite 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	DocumentSpan	Position der Formel in der Lesereihenfolge verketteter Inhalte.
value	string	LaTex-Ausdruck, der die Formel beschreibt.

DocumentFormulaKind

Formeltyp.

Name	Typ	Beschreibung
display	string	Eine Formel im Anzeigemodus, die eine ganze Zeile einnimmt.
inline	string	Eine Formel, die in den Inhalt eines Absatzes eingebettet ist.

DocumentKeyValueElement

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

Name	Typ	Beschreibung
boundingRegions	BoundingRegion[]	Begrenzungsbereiche, die das Schlüsselwertelement abdecken.
content	string	Verketteter Inhalt des Schlüsselwertelements in Leserichtung.
spans	DocumentSpan[]	Speicherort des Schlüsselwertelements in der Lesereihenfolge verketteter Inhalte.

DocumentKeyValuePair

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

Name	Typ	Beschreibung
confidence	number	Konfidenz, dass das Schlüssel-Wert-Paar ordnungsgemäß extrahiert wird.
key	DocumentKeyValueElement	Feldbeschriftung des Schlüsselwertpaars.
value	DocumentKeyValueElement	Feldwert des Schlüsselwertpaars.

DocumentLanguage

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

Name	Typ	Beschreibung
confidence	number	Vertrauen der korrekten Identifizierung der Sprache.
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	DocumentSpan[]	Speicherort der Textelemente im verketteten Inhalt, auf den die Sprache angewendet wird.

DocumentLine

Ein Inhaltszeilenobjekt, das aus einer angrenzenden Abfolge von Inhaltselementen besteht, z. B. Wörter und Auswahlzeichen.

Name	Typ	Beschreibung
content	string	Verketteter Inhalt der enthaltenen Elemente in lesereihenfolge.
polygon	number[]	Umgebendes Polygon der Linie 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	DocumentSpan[]	Position der Zeile in der Lesereihenfolge verketteter Inhalte.

DocumentPage

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

Name	Typ	Beschreibung
angle	number	Die allgemeine Ausrichtung des Inhalts im Uhrzeigersinn, gemessen in Grad zwischen (-180, 180].
barcodes	DocumentBarcode[]	Extrahierte Barcodes von der Seite.
formulas	DocumentFormula[]	Extrahierte Formeln von der Seite.
height	number	Die Höhe des Bilds bzw. der PDF-Datei in Pixel/Zoll.
lines	DocumentLine[]	Extrahierte Zeilen von der Seite, die potenziell textbezogene und visuelle Elemente enthalten.
pageNumber	integer	1-basierte Seitenzahl im Eingabedokument.
selectionMarks	DocumentSelectionMark[]	Extrahierte Auswahlmarkierungen von der Seite.
spans	DocumentSpan[]	Speicherort der Seite in der Lesereihenfolge verketteter Inhalte.
unit	LengthUnit	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".
width	number	Die Breite des Bilds bzw. der PDF-Datei in Pixel/Zoll.
words	DocumentWord[]	Extrahierte Wörter aus der Seite.

DocumentParagraph

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

Name	Typ	Beschreibung
boundingRegions	BoundingRegion[]	Begrenzungsbereiche, die den Absatz abdecken.
content	string	Verketteter Inhalt des Absatzes in Leserichtung.
role	ParagraphRole	Semantische Rolle des Absatzes.
spans	DocumentSpan[]	Position des Absatzes in der Lesereihenfolge verketteter Inhalte.

DocumentSection

Ein Objekt, das einen Abschnitt im Dokument darstellt.

Name	Typ	Beschreibung
elements	string[]	Untergeordnete Elemente des Abschnitts.
spans	DocumentSpan[]	Speicherort des Abschnitts in der Lesereihenfolge verketteter Inhalte.

DocumentSelectionMark

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

Name	Typ	Beschreibung
confidence	number	Konfidenz, dass das Auswahlzeichen korrekt extrahiert wird.
polygon	number[]	Umgebendes Polygon des Auswahlzeichens 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	DocumentSpan	Position des Auswahlzeichens in der Lesereihenfolge verketteter Inhalte.
state	DocumentSelectionMarkState	Status des Auswahlzeichens.

DocumentSelectionMarkState

Status des Auswahlzeichens.

Name	Typ	Beschreibung
selected	string	Das Auswahlzeichen wird ausgewählt, häufig durch ein Häkchen oder X innerhalb des Markierungszeichens gekennzeichnet.
unselected	string	Das Auswahlzeichen ist nicht ausgewählt.

DocumentSignatureType

Vorhandensein einer Signatur.

Name	Typ	Beschreibung
signed	string	Eine Signatur wird erkannt.
unsigned	string	Es werden keine Signaturen erkannt.

DocumentSpan

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

Name	Typ	Beschreibung
length	integer	Die Anzahl der Zeichen im Inhalt, der durch den Bereich dargestellt wird.
offset	integer	Nullbasierter Index des Inhalts, der durch die Spanne dargestellt wird.

DocumentStyle

Ein Objekt, das beobachtete Textformatvorlagen darstellt.

Name	Typ	Beschreibung
backgroundColor	string	Hintergrundfarbe im hexadezimalen Format #rrggbb.
color	string	Vordergrundfarbe im #rrggbb Hexadezimalformat.
confidence	number	Vertrauen der korrekten Identifizierung des Stils.
fontStyle	FontStyle	Schriftschnitt.
fontWeight	FontWeight	Schriftbreite.
isHandwritten	boolean	Sind Inhalte handschriftlich?
similarFontFamily	string	Visuell ähnlichste Schriftart aus der Gruppe der unterstützten Schriftfamilien mit Fallbackschriftarten nach css-Konvention (z. B. 'Arial, sans-serif').
spans	DocumentSpan[]	Die Position der Textelemente im verketteten Inhalt, auf den die Formatvorlage angewendet wird.

DocumentTable

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

Name	Typ	Beschreibung
boundingRegions	BoundingRegion[]	Begrenzungsbereiche, die die Tabelle abdecken.
caption	DocumentCaption	Beschriftung, die der Tabelle zugeordnet ist.
cells	DocumentTableCell[]	Zellen, die in der Tabelle enthalten sind.
columnCount	integer	Anzahl der Spalten in der Tabelle.
footnotes	DocumentFootnote[]	Liste der Fußnoten, die der Tabelle zugeordnet sind.
rowCount	integer	Anzahl der Zeilen in der Tabelle.
spans	DocumentSpan[]	Position der Tabelle in der Lesereihenfolge verketteter Inhalte.

DocumentTableCell

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

Name	Typ	Standardwert	Beschreibung
boundingRegions	BoundingRegion[]		Begrenzungsbereiche, die die Tabellenzelle abdecken.
columnIndex	integer		Spaltenindex der Zelle.
columnSpan	integer	1	Die Anzahl der Spalten, die von dieser Zelle überspannt sind.
content	string		Verketteter Inhalt der Tabellenzelle in Leserichtung.
elements	string[]		Untergeordnete Elemente der Tabellenzelle.
kind	DocumentTableCellKind	content	Tabellenzellentyp.
rowIndex	integer		Zeilenindex der Zelle.
rowSpan	integer	1	Die Anzahl der Zeilen, die von dieser Zelle überspannt sind.
spans	DocumentSpan[]		Position der Tabellenzelle in der Lesereihenfolge verketteter Inhalte.

DocumentTableCellKind

Tabellenzellentyp.

Name	Typ	Beschreibung
columnHeader	string	Beschreibt den Inhalt der Spalte.
content	string	Enthält den Hauptinhalt/die Hauptdaten.
description	string	Beschreibt den Inhalt in (Teilen) der Tabelle.
rowHeader	string	Beschreibt den Inhalt der Zeile.
stubHead	string	Beschreibt die Zeilenüberschriften, die sich normalerweise in der oberen linken Ecke einer Tabelle befinden.

DocumentWord

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	Typ	Beschreibung
confidence	number	Konfidenz, dass das Wort richtig extrahiert wird.
content	string	Textinhalt des Worts.
polygon	number[]	Umgebendes Polygon des Worts 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	DocumentSpan	Position des Worts in der Lesereihenfolge verketteter Inhalte.

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.

FontStyle

Schriftschnitt.

Name	Typ	Beschreibung
italic	string	Zeichen werden visuell nach rechts geneigt.
normal	string	Zeichen werden normal dargestellt.

FontWeight

Schriftbreite.

Name	Typ	Beschreibung
bold	string	Zeichen werden mit dickeren Strichen dargestellt.
normal	string	Zeichen werden normal dargestellt.

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.

LengthUnit

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".

Name	Typ	Beschreibung
inch	string	Längeneinheit für PDF-Dateien.
pixel	string	Längeneinheit für Bilddateien.

OperationStatus

Vorgangsstatus.

Name	Typ	Beschreibung
canceled	string	Der Vorgang wurde abgebrochen.
completed	string	Der Vorgang wurde abgeschlossen.
failed	string	Fehler beim Vorgang.
notStarted	string	Der Vorgang wurde noch nicht gestartet.
running	string	Der Vorgang wird ausgeführt.
succeeded	string	Der Vorgang ist erfolgreich.

ParagraphRole

Semantische Rolle des Absatzes.

Name	Typ	Beschreibung
footnote	string	Eine Notiz, die in der Regel nach dem Hauptinhalt auf einer Seite platziert wird.
formulaBlock	string	Ein Formelblock, häufig mit freigegebener Ausrichtung.
pageFooter	string	Text am unteren Rand der Seite.
pageHeader	string	Text am oberen Rand der Seite.
pageNumber	string	Seitennummer.
sectionHeading	string	Unterüberschrift, die einen Abschnitt des Dokuments beschreibt.
title	string	Titel der obersten Ebene, der das gesamte Dokument beschreibt.

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.

Warning