Analyzer - Get Analyze Id Document Result

Referenz

Dienst:: Azure AI Services

API-Version:: 2.1

Verfolgen Sie den Fortschritt, und rufen Sie das Ergebnis des Vorgangs zur Analyse-ID ab.

GET {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/{resultId}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com
resultId	path	True	string uuid	Analysieren des Vorgangsergebnisbezeichners.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Antworten

Name	Typ	Beschreibung
200 OK	AnalyzeOperationResult	Erfolg
Other Status Codes	ErrorResponse	Antwortentität, die nicht erfolgreiche Antworten begleitet, die zusätzliche Details zum Fehler enthält.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Get analyze ID result

Beispielanforderung

HTTP

GET {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Beispiel für eine Antwort

Statuscode:: 200

{
  "status": "running",
  "createdDateTime": "2019-05-01T10:53:21Z",
  "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
  "analyzeResult": {
    "version": "v2.1",
    "readResults": [],
    "pageResults": [],
    "documentResults": [],
    "errors": []
  }
}

Definitionen

Name	Beschreibung
AnalyzeOperationResult	Status und Ergebnis des Analysevorgangs in der Warteschlange.
AnalyzeResult	Analysieren des Vorgangsergebnisses.
Appearance	Ein -Objekt, das die Darstellung der Textzeile darstellt.
DataTable	Informationen zur extrahierten Tabelle, die auf einer Seite enthalten ist.
DataTableCell	Informationen zur extrahierten Zelle in einer Tabelle.
DocumentResult	Ein Satz extrahierter Felder, die dem Eingabedokument entsprechen.
ErrorInformation
ErrorResponse
FieldValue	Erkannter Feldwert.
FieldValueType	Semantischer Datentyp des Feldwerts.
KeyValueElement	Informationen zum extrahierten Schlüssel oder Wert in einem Schlüssel-Wert-Paar.
KeyValuePair	Informationen zum extrahierten Schlüssel-Wert-Paar.
KeyValueType	Semantischer Datentyp des Schlüsselwertelements.
LengthUnit	Die von den Eigenschaften width, height und boundingBox verwendete Einheit. Bei Bildern ist die Einheit "Pixel". Für PDF ist die Einheit "Zoll".
OperationStatus	Status des Vorgangs in der Warteschlange.
PageResult	Extrahierte Informationen von einer einzelnen Seite.
ReadResult	Text, der von einer Seite im Eingabedokument extrahiert wurde.
SelectionMark	Informationen zum extrahierten Auswahlzeichen.
Style	Ein -Objekt, das den Stil der Textzeile darstellt.
TextLine	Ein Objekt, das eine extrahierte Textzeile darstellt.
TextStyle	Der Name der Textzeilenformatvorlage, einschließlich Handschrift und anderer.
TextWord	Ein Objekt, das ein Wort darstellt.

AnalyzeOperationResult

Status und Ergebnis des Analysevorgangs in der Warteschlange.

Name	Typ	Beschreibung
analyzeResult	AnalyzeResult	Ergebnisse des Analysevorgangs.
createdDateTime	string	Datum und Uhrzeit (UTC), zu dem der Analysevorgang übermittelt wurde.
lastUpdatedDateTime	string	Datum und Uhrzeit (UTC), zu dem die status zuletzt aktualisiert wurde.
status	OperationStatus	Vorgangsstatus

AnalyzeResult

Analysieren des Vorgangsergebnisses.

Name	Typ	Beschreibung
documentResults	DocumentResult[]	Informationen auf Dokumentebene, die aus der Eingabe extrahiert wurden.
errors	ErrorInformation[]	Liste der fehler, die während des Analysevorgangs gemeldet wurden.
pageResults	PageResult[]	Informationen auf Seitenebene, die aus der Eingabe extrahiert wurden.
readResults	ReadResult[]	Text, der aus der Eingabe extrahiert wurde.
version	string	Version des Schemas, das für dieses Ergebnis verwendet wird.

Appearance

Ein -Objekt, das die Darstellung der Textzeile darstellt.

Name	Typ	Beschreibung
style	Style	Ein -Objekt, das den Stil der Textzeile darstellt.

DataTable

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

Name	Typ	Beschreibung
boundingBox	number[]	Begrenzungsrahmen der Tabelle.
cells	DataTableCell[]	Liste der in der Tabelle enthaltenen Zellen.
columns	integer	Anzahl der Spalten.
rows	integer	Anzahl von Zeilen.

DataTableCell

Informationen zur extrahierten Zelle in einer Tabelle.

Name	Typ	Standardwert	Beschreibung
boundingBox	number[]		Begrenzungsrahmen der Zelle.
columnIndex	integer		Spaltenindex der Zelle.
columnSpan	integer	1	Anzahl der Spalten, die von dieser Zelle überspannt sind.
confidence	number		Konfidenzwert.
elements	string[]		Wenn includeTextDetails auf true festgelegt ist, eine Liste von Verweisen auf die Textelemente, die diese Tabellenzelle bilden.
isFooter	boolean	False	Ist die aktuelle Zelle eine Fußzeilenzelle?
isHeader	boolean	False	Ist die aktuelle Zelle eine Kopfzeilenzelle?
rowIndex	integer		Zeilenindex der Zelle.
rowSpan	integer	1	Anzahl der Zeilen, die von dieser Zelle überspannt sind.
text	string		Textinhalt der Zelle.

DocumentResult

Ein Satz extrahierter Felder, die dem Eingabedokument entsprechen.

Name	Typ	Beschreibung
docType	string	Dokumenttyp.
docTypeConfidence	number	Vorhergesagte Zuverlässigkeit des Dokumenttyps.
fields	<string, FieldValue>	Wörterbuch mit benannten Feldwerten.
modelId	string	Modellbezeichner.
pageRange	integer[]	Nummer der ersten und letzten Seite, auf der sich das Dokument befindet.

ErrorInformation

Name	Typ	Beschreibung
code	string
message	string

ErrorResponse

Name	Typ	Beschreibung
error	ErrorInformation

FieldValue

Erkannter Feldwert.

Name	Typ	Beschreibung
boundingBox	number[]	Begrenzungsrahmen des Feldwerts, falls zutreffend.
confidence	number	Konfidenzbewertung.
elements	string[]	Wenn includeTextDetails auf true festgelegt ist, eine Liste von Verweisen auf die Textelemente, die dieses Feld bilden.
page	integer	Die 1-basierte Seitenzahl im Eingabedokument.
text	string	Textinhalt des extrahierten Felds.
type	FieldValueType	Typ des Feldwerts.
valueArray	FieldValue[]	Array von Feldwerten.
valueCountryRegion	string	3-Buchstaben-Ländercode (ISO 3166-1 Alpha-3).
valueDate	string	Datumswert.
valueInteger	integer	Wert für ganze Zahl.
valueNumber	number	Gleitkommawert.
valueObject	<string, FieldValue>	Wörterbuch mit benannten Feldwerten.
valuePhoneNumber	string	Telefonnummernwert.
valueSelectionMark	enum: selected unselected	Auswahlmarkierungswert.
valueString	string	Zeichenfolgenwert.
valueTime	string	Zeitwert.

FieldValueType

Semantischer Datentyp des Feldwerts.

Name	Typ	Beschreibung
array	string
countryRegion	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
string	string
time	string

KeyValueElement

Informationen zum extrahierten Schlüssel oder Wert in einem Schlüssel-Wert-Paar.

Name	Typ	Beschreibung
boundingBox	number[]	Begrenzungsrahmen des Schlüssels oder Werts.
elements	string[]	Wenn includeTextDetails auf true festgelegt ist, wird eine Liste von Verweisen auf die Textelemente verwendet, die diesen Schlüssel oder Wert bilden.
text	string	Der Textinhalt des Schlüssels oder Werts.
type	KeyValueType	Semantischer Datentyp des Schlüsselwertelements.

KeyValuePair

Informationen zum extrahierten Schlüssel-Wert-Paar.

Name	Typ	Beschreibung
confidence	number	Konfidenzwert.
key	KeyValueElement	Informationen zum extrahierten Schlüssel in einem Schlüssel-Wert-Paar.
label	string	Eine benutzerdefinierte Bezeichnung für den Schlüssel-Wert-Paareintrag.
value	KeyValueElement	Informationen zum extrahierten Wert in einem Schlüssel-Wert-Paar.

KeyValueType

Semantischer Datentyp des Schlüsselwertelements.

Name	Typ	Beschreibung
selectionMark	string
string	string

LengthUnit

Die von den Eigenschaften width, height und boundingBox verwendete Einheit. Bei Bildern ist die Einheit "Pixel". Für PDF ist die Einheit "Zoll".

Name	Typ	Beschreibung
inch	string
pixel	string

OperationStatus

Status des Vorgangs in der Warteschlange.

Name	Typ	Beschreibung
failed	string
notStarted	string
running	string
succeeded	string

PageResult

Extrahierte Informationen von einer einzelnen Seite.

Name	Typ	Beschreibung
clusterId	integer	Clusterbezeichner.
keyValuePairs	KeyValuePair[]	Liste der Schlüssel-Wert-Paare, die von der Seite extrahiert wurden.
page	integer	Seitenzahl.
tables	DataTable[]	Liste der von der Seite extrahierten Datentabellen.

ReadResult

Text, der von einer Seite im Eingabedokument extrahiert wurde.

Name	Typ	Beschreibung
angle	number	Die allgemeine Ausrichtung des Texts im Uhrzeigersinn, gemessen in Grad zwischen (-180, 180).
height	number	Die Höhe des Bilds/pdf in Pixel/Zoll.
lines	TextLine[]	Wenn includeTextDetails auf true festgelegt ist, eine Liste der erkannten Textzeilen. Die maximale Anzahl der zurückgegebenen Zeilen beträgt 300 pro Seite. Die Zeilen werden von oben nach unten sortiert, von links nach rechts, obwohl in bestimmten Fällen die Nähe mit höherer Priorität behandelt wird. Da die Sortierreihenfolge vom erkannten Text abhängt, kann sie sich zwischen Images und OCR-Versionsupdates ändern. Daher sollte die Geschäftslogik auf der tatsächlichen Position der Position der Position basieren, anstatt auf der Reihenfolge.
page	integer	Die 1-basierte Seitenzahl im Eingabedokument.
selectionMarks	SelectionMark[]	Liste der Auswahlmarkierungen, die von der Seite extrahiert wurden.
unit	LengthUnit	Die von den Eigenschaften width, height und boundingBox verwendete Einheit. Bei Bildern ist die Einheit "Pixel". Für PDF ist die Einheit "Zoll".
width	number	Die Breite des Bilds/pdf in Pixel/Zoll.

SelectionMark

Informationen zum extrahierten Auswahlzeichen.

Name	Typ	Beschreibung
boundingBox	number[]	Begrenzungsfeld des Auswahlmarkierungszeichens.
confidence	number	Konfidenzwert.
state	enum: selected unselected	Status des Auswahlzeichens.

Style

Ein -Objekt, das den Stil der Textzeile darstellt.

Name	Typ	Beschreibung
confidence	number	Die Zuverlässigkeit der Textzeilenformatvorlage.
name	TextStyle	Der Name der Textzeilenformatvorlage, einschließlich Handschrift und anderer.

TextLine

Ein Objekt, das eine extrahierte Textzeile darstellt.

Name	Typ	Beschreibung
appearance	Appearance	Textdarstellungseigenschaften.
boundingBox	number[]	Begrenzungsrahmen einer extrahierten Linie.
text	string	Der Textinhalt der Zeile.
words	TextWord[]	Liste der Wörter in der Textzeile.

TextStyle

Der Name der Textzeilenformatvorlage, einschließlich Handschrift und anderer.

Name	Typ	Beschreibung
handwriting	string
other	string

TextWord

Ein Objekt, das ein Wort darstellt.

Name	Typ	Beschreibung
boundingBox	number[]	Begrenzungsrahmen eines extrahierten Worts.
confidence	number	Konfidenzwert.
text	string	Der Textinhalt des Worts.

Freigeben über