Analyzer - Get Analyze Receipt Result

Tjänst:

Azure AI Services

API-version:

2.1

Spåra förloppet och hämta resultatet av analyskvittoåtgärden.

GET {endpoint}/formrecognizer/v2.1/prebuilt/receipt/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	Framgång
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 receipt result

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
AnalyzeOperationResult	Status och resultat av 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	Den enhet 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 formatmall.
TextLine	Ett objekt som representerar en extraherad textrad.
TextStyle	Namn på textradsformat, inklusive handskrift och annat.
TextWord	Ett objekt som representerar ett ord.

AnalyzeOperationResult

Objekt

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

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

AnalyzeResult

Objekt

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

Objekt

Ett objekt som representerar textradens utseende.

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

DataTable

Objekt

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 minimum: 1	Antal kolumner.
rows	integer minimum: 1	Antal rader.

DataTableCell

Objekt

Information om den extraherade cellen i en tabell.

Name	Typ	Standardvärde	Description
boundingBox	number[]		Cellens avgränsningsruta.
columnIndex	integer minimum: 0		Cellens kolumnindex.
columnSpan	integer minimum: 1	1	Antal kolumner som sträcker sig över cellen.
confidence	number minimum: 0 maximum: 1		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 minimum: 0		Cellens radindex.
rowSpan	integer minimum: 1	1	Antal rader som sträcker sig över den här cellen.
text	string		Cellens textinnehåll.

DocumentResult

Objekt

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

Name	Typ	Description
docType	string	Dokumenttyp.
docTypeConfidence	number minimum: 0 maximum: 1	Förutsagt förtroende för dokumenttyp.
fields	<string,  FieldValue>	Ordlista med namngivna fältvärden.
modelId	string (uuid)	Modellidentifierare.
pageRange	integer[] minimum: 1	Första och sista sidnumret där dokumentet hittas.

ErrorInformation

Objekt

Name	Typ	Description
code	string
message	string

ErrorResponse

Objekt

Name	Typ	Description
error	ErrorInformation

FieldValue

Objekt

Identifierat fältvärde.

Name	Typ	Description
boundingBox	number[]	Avgränsningsruta för fältvärdet, om det är lämpligt.
confidence	number minimum: 0 maximum: 1	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 minimum: 1	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 alpha-3).
valueDate	string (date)	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	Markeringsmarkeringsvärde.
valueString	string	Strängvärde.
valueTime	string (time)	Tidsvärde.

FieldValueType

Uppräkning

Semantisk datatyp för fältvärdet.

Värde	Description
array
countryRegion
date
integer
number
object
phoneNumber
selectionMark
string
time

KeyValueElement

Objekt

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 är inställt på true visas en lista med referenser till textelementen som utgör den här nyckeln eller värdet.
text	string	Textinnehållet i nyckeln eller värdet.
type	KeyValueType	Semantisk datatyp för nyckelvärdeelementet.

KeyValuePair

Objekt

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

Name	Typ	Description
confidence	number minimum: 0 maximum: 1	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

Uppräkning

Semantisk datatyp för nyckelvärdeelementet.

Värde	Description
selectionMark
string

LengthUnit

Uppräkning

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

Värde	Description
inch
pixel

OperationStatus

Uppräkning

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

Värde	Description
failed
notStarted
running
succeeded

PageResult

Objekt

Extraherad information från en enda sida.

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

ReadResult

Objekt

Text som extraherats från en sida i indatadokumentet.

Name	Typ	Description
angle	number minimum: -180 maximum: 180 exclusiveMinimum: True	Den allmänna orienteringen av texten i medsols riktning, mätt i grader mellan (-180, 180].
height	number minimum: 0	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ärslogik bör därför byggas på den faktiska radplatsen i stället för ordning.
page	integer minimum: 1	Det 1-baserade sidnumret i indatadokumentet.
selectionMarks	SelectionMark[]	Lista över markeringsmarkeringar som extraherats från sidan.
unit	LengthUnit	Den enhet som används av egenskaperna width, height och boundingBox. För bilder är enheten "pixel". För PDF är enheten "tum".
width	number minimum: 0	Bredden på bilden/PDF-filen i bildpunkter/tum.

SelectionMark

Objekt

Information om det extraherade markeringsmärket.

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

Style

Objekt

Ett objekt som representerar textradens formatmall.

Name	Typ	Description
confidence	number (float)	Konfidensen för textradsformat.
name	TextStyle	Namn på textradsformat, inklusive handskrift och annat.

TextLine

Objekt

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 med ord på textraden.

TextStyle

Uppräkning

Namn på textradsformat, inklusive handskrift och annat.

Värde	Description
handwriting
other

TextWord

Objekt

Ett objekt som representerar ett ord.

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