Analyzer - Get Analyze Layout Result

Referens

Tjänst:: Azure AI Services

API-version:: 2.1

Spåra förloppet och hämta resultatet av åtgärden analysera layout

GET {endpoint}/formrecognizer/v2.1/layout/analyzeResults/{resultId}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
resultId	path	True	string uuid	Analysera åtgärdsresultatidentifierare.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Svar

Name	Typ	Description
200 OK	AnalyzeOperationResult	Klart
Other Status Codes	ErrorResponse	Svarsentitet som medföljer icke-lyckade svar som innehåller ytterligare information om felet.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Get analyze layout result

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
AnalyzeOperationResult	Status och resultat för den köade analysåtgärden.
AnalyzeResult	Analysera åtgärdsresultat.
Appearance	Ett objekt som representerar textradens utseende.
DataTable	Information om den extraherade tabellen som finns på en sida.
DataTableCell	Information om den extraherade cellen i en tabell.
DocumentResult	En uppsättning extraherade fält som motsvarar indatadokumentet.
ErrorInformation
ErrorResponse
FieldValue	Identifierat fältvärde.
FieldValueType	Semantisk datatyp för fältvärdet.
KeyValueElement	Information om den extraherade nyckeln eller värdet i ett nyckel/värde-par.
KeyValuePair	Information om det extraherade nyckel/värde-paret.
KeyValueType	Semantisk datatyp för nyckelvärdeelementet.
LengthUnit	Enheten som används av egenskaperna width, height och boundingBox. För bilder är enheten "pixel". För PDF är enheten "tum".
OperationStatus	Status för den köade åtgärden.
PageResult	Extraherad information från en enda sida.
ReadResult	Text som extraherats från en sida i indatadokumentet.
SelectionMark	Information om det extraherade markeringsmärket.
Style	Ett objekt som representerar textradens format.
TextLine	Ett objekt som representerar en extraherad textrad.
TextStyle	Namn på textradformat, inklusive handskrift och annat.
TextWord	Ett objekt som representerar ett ord.

AnalyzeOperationResult

Status och resultat för den köade analysåtgärden.

Name	Typ	Description
analyzeResult	AnalyzeResult	Resultat av analysåtgärden.
createdDateTime	string	Datum och tid (UTC) när analysåtgärden skickades.
lastUpdatedDateTime	string	Datum och tid (UTC) när statusen senast uppdaterades.
status	OperationStatus	Åtgärdsstatus.

AnalyzeResult

Analysera åtgärdsresultat.

Name	Typ	Description
documentResults	DocumentResult[]	Information på dokumentnivå som extraherats från indata.
errors	ErrorInformation[]	Lista över fel som rapporterats under analysåtgärden.
pageResults	PageResult[]	Information på sidnivå som extraherats från indata.
readResults	ReadResult[]	Text som extraherats från indata.
version	string	Version av schemat som används för det här resultatet.

Appearance

Ett objekt som representerar textradens utseende.

Name	Typ	Description
style	Style	Ett objekt som representerar textradens formatmall.

DataTable

Information om den extraherade tabellen som finns på en sida.

Name	Typ	Description
boundingBox	number[]	Tabellens avgränsningsruta.
cells	DataTableCell[]	Lista över celler som finns i tabellen.
columns	integer	Antal kolumner.
rows	integer	Antal rader.

DataTableCell

Information om den extraherade cellen i en tabell.

Name	Typ	Standardvärde	Description
boundingBox	number[]		Cellens avgränsningsruta.
columnIndex	integer		Cellens kolumnindex.
columnSpan	integer	1	Antal kolumner som omfattas av den här cellen.
confidence	number		Konfidensvärde.
elements	string[]		När includeTextDetails har angetts till true visas en lista med referenser till textelementen som utgör den här tabellcellen.
isFooter	boolean	False	Är den aktuella cellen en sidfotscell?
isHeader	boolean	False	Är den aktuella cellen en rubrikcell?
rowIndex	integer		Cellens radindex.
rowSpan	integer	1	Antal rader som omfattas av den här cellen.
text	string		Cellens textinnehåll.

DocumentResult

En uppsättning extraherade fält som motsvarar indatadokumentet.

Name	Typ	Description
docType	string	Dokumenttyp.
docTypeConfidence	number	Förutsagd konfidens för dokumenttyp.
fields	<string, FieldValue>	Ordlista med namngivna fältvärden.
modelId	string	Modellidentifierare.
pageRange	integer[]	Första och sista sidnumret där dokumentet finns.

ErrorInformation

Name	Typ	Description
code	string
message	string

ErrorResponse

Name	Typ	Description
error	ErrorInformation

FieldValue

Identifierat fältvärde.

Name	Typ	Description
boundingBox	number[]	Avgränsningsruta för fältvärdet, om det är lämpligt.
confidence	number	Konfidenspoäng.
elements	string[]	När includeTextDetails har angetts till true visas en lista med referenser till textelementen som utgör det här fältet.
page	integer	Det 1-baserade sidnumret i indatadokumentet.
text	string	Textinnehåll i det extraherade fältet.
type	FieldValueType	Typ av fältvärde.
valueArray	FieldValue[]	Matris med fältvärden.
valueCountryRegion	string	Landskod med tre bokstäver (ISO 3166-1 alfa-3).
valueDate	string	Datumvärde.
valueInteger	integer	Heltalsvärde.
valueNumber	number	Flyttalsvärde.
valueObject	<string, FieldValue>	Ordlista med namngivna fältvärden.
valuePhoneNumber	string	Telefonnummervärde.
valueSelectionMark	enum: selected unselected	Markeringens värde.
valueString	string	Strängvärde.
valueTime	string	Tidsvärde.

FieldValueType

Semantisk datatyp för fältvärdet.

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

KeyValueElement

Information om den extraherade nyckeln eller värdet i ett nyckel/värde-par.

Name	Typ	Description
boundingBox	number[]	Avgränsningsruta för nyckeln eller värdet.
elements	string[]	När includeTextDetails har angetts till true visas en lista med referenser till textelementen som utgör den här nyckeln eller det här värdet.
text	string	Textinnehållet i nyckeln eller värdet.
type	KeyValueType	Semantisk datatyp för nyckelvärdeelementet.

KeyValuePair

Information om det extraherade nyckel/värde-paret.

Name	Typ	Description
confidence	number	Konfidensvärde.
key	KeyValueElement	Information om den extraherade nyckeln i ett nyckel/värde-par.
label	string	En användardefinierad etikett för nyckel/värde-parposten.
value	KeyValueElement	Information om det extraherade värdet i ett nyckel/värde-par.

KeyValueType

Semantisk datatyp för nyckelvärdeelementet.

Name	Typ	Description
selectionMark	string
string	string

LengthUnit

Enheten som används av egenskaperna width, height och boundingBox. För bilder är enheten "pixel". För PDF är enheten "tum".

Name	Typ	Description
inch	string
pixel	string

OperationStatus

Status för den köade åtgärden.

Name	Typ	Description
failed	string
notStarted	string
running	string
succeeded	string

PageResult

Extraherad information från en enda sida.

Name	Typ	Description
clusterId	integer	Klusteridentifierare.
keyValuePairs	KeyValuePair[]	Lista över nyckel/värde-par som extraherats från sidan.
page	integer	Sidnummer.
tables	DataTable[]	Lista över datatabeller som extraherats från sidan.

ReadResult

Text som extraherats från en sida i indatadokumentet.

Name	Typ	Description
angle	number	Den allmänna orienteringen av texten i medsols riktning, mätt i grader mellan (-180, 180].
height	number	Bildens/PDF-filens höjd i bildpunkter/tum.
lines	TextLine[]	När includeTextDetails har angetts till true visas en lista med identifierade textrader. Det maximala antalet rader som returneras är 300 per sida. Linjerna sorteras uppifrån och ned, från vänster till höger, men i vissa fall behandlas närhet med högre prioritet. Eftersom sorteringsordningen beror på den identifierade texten kan den ändras mellan bilder och OCR-versionsuppdateringar. Affärslogiken bör därför byggas på den faktiska radplatsen i stället för på order.
page	integer	Det 1-baserade sidnumret i indatadokumentet.
selectionMarks	SelectionMark[]	Lista över markeringsmarkeringar som extraherats från sidan.
unit	LengthUnit	Enheten som används av egenskaperna width, height och boundingBox. För bilder är enheten "pixel". För PDF är enheten "tum".
width	number	Bredden på bilden/PDF-filen i bildpunkter/tum.

SelectionMark

Information om det extraherade markeringsmärket.

Name	Typ	Description
boundingBox	number[]	Markeringsmarkeringens avgränsningsruta.
confidence	number	Konfidensvärde.
state	enum: selected unselected	Markeringsmarkeringens tillstånd.

Style

Ett objekt som representerar textradens format.

Name	Typ	Description
confidence	number	Textradstilens konfidens.
name	TextStyle	Namn på textradformat, inklusive handskrift och annat.

TextLine

Ett objekt som representerar en extraherad textrad.

Name	Typ	Description
appearance	Appearance	Egenskaper för textutseende.
boundingBox	number[]	Avgränsningsruta för en extraherad linje.
text	string	Textinnehållet på raden.
words	TextWord[]	Lista över ord i textraden.

TextStyle

Namn på textradformat, inklusive handskrift och annat.

Name	Typ	Description
handwriting	string
other	string

TextWord

Ett objekt som representerar ett ord.

Name	Typ	Description
boundingBox	number[]	Avgränsningsruta för ett extraherat ord.
confidence	number	Konfidensvärde.
text	string	Textens innehåll i ordet.

Dela via