Analyzer - Get Analyze Invoice Result

Služba:

Azure AI Services

Verze rozhraní API:

2.1

Sledujte průběh a získejte výsledek operace analyzovat fakturu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).
resultId	path	True	string uuid	Analýza identifikátoru výsledku operace

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Odpovědi

Name	Typ	Description
200 OK	AnalyzeOperationResult	Success
Other Status Codes	ErrorResponse	Entita odpovědi doprovázející neúspěšné odpovědi obsahující další podrobnosti o chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

Get analyze receipt result

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
AnalyzeOperationResult	Stav a výsledek operace analýzy ve frontě
AnalyzeResult	Analýza výsledku operace
Appearance	Objekt představující vzhled řádku textu.
DataTable	Informace o extrahované tabulce obsažené na stránce
DataTableCell	Informace o extrahované buňce v tabulce
DocumentResult	Sada extrahovaných polí odpovídajících vstupnímu dokumentu.
ErrorInformation
ErrorResponse
FieldValue	Rozpoznaná hodnota pole.
FieldValueType	Sémantický datový typ hodnoty pole.
KeyValueElement	Informace o extrahovaném klíči nebo hodnotě ve dvojici klíč-hodnota
KeyValuePair	Informace o extrahovaném páru klíč-hodnota
KeyValueType	Sémantický datový typ prvku klíčové hodnoty.
LengthUnit	Jednotka používaná vlastnostmi width, height a boundingBox. U obrázků je to "pixel". Pro PDF je jednotka "inch".
OperationStatus	Stav operace ve frontě.
PageResult	Extrahované informace z jedné stránky.
ReadResult	Text extrahovaný ze stránky ve vstupním dokumentu
SelectionMark	Informace o extrahované značce výběru
Style	Objekt představující styl řádku textu.
TextLine	Objekt představující extrahovaný textový řádek.
TextStyle	Název stylu textové čáry, včetně rukopisu a dalších.
TextWord	Objekt představující slovo.

AnalyzeOperationResult

Stav a výsledek operace analýzy ve frontě

Name	Typ	Description
analyzeResult	AnalyzeResult	Výsledky operace analýzy.
createdDateTime	string	Datum a čas (UTC), kdy byla operace analýzy odeslána.
lastUpdatedDateTime	string	Datum a čas (UTC), kdy byl stav naposledy aktualizován.
status	OperationStatus	Stav operace.

AnalyzeResult

Analýza výsledku operace

Name	Typ	Description
documentResults	DocumentResult[]	Informace na úrovni dokumentu extrahované ze vstupu
errors	ErrorInformation[]	Seznam chyb hlášených během operace analýzy
pageResults	PageResult[]	Informace na úrovni stránky extrahované ze vstupu
readResults	ReadResult[]	Text extrahovaný ze vstupu
version	string	Verze schématu použitá pro tento výsledek.

Appearance

Objekt představující vzhled řádku textu.

Name	Typ	Description
style	Style	Objekt představující styl řádku textu.

DataTable

Informace o extrahované tabulce obsažené na stránce

Name	Typ	Description
boundingBox	number[]	Ohraničující rámeček tabulky.
cells	DataTableCell[]	Seznam buněk obsažených v tabulce
columns	integer	Počet sloupců
rows	integer	Počet řádků.

DataTableCell

Informace o extrahované buňce v tabulce

Name	Typ	Default value	Description
boundingBox	number[]		Ohraničující rámeček buňky.
columnIndex	integer		Sloupcový index buňky.
columnSpan	integer	1	Počet sloupců překlenovaných touto buňkou
confidence	number		Hodnota spolehlivosti.
elements	string[]		Pokud je includeTextDetails nastavena na true, seznam odkazů na textové prvky tvořící tuto buňku tabulky.
isFooter	boolean	False	Je aktuální buňka buňka zápatí?
isHeader	boolean	False	Je aktuální buňka buňkou záhlaví?
rowIndex	integer		Index řádku buňky.
rowSpan	integer	1	Počet řádků překlenovaných touto buňkou
text	string		Textový obsah buňky.

DocumentResult

Sada extrahovaných polí odpovídajících vstupnímu dokumentu.

Name	Typ	Description
docType	string	Typ dokumentu.
docTypeConfidence	number	Předpovězená spolehlivost typu dokumentu
fields	<string,  FieldValue>	Slovník hodnot pojmenovaných polí.
modelId	string	Identifikátor modelu.
pageRange	integer[]	Číslo první a poslední stránky, kde se dokument nachází.

ErrorInformation

Name	Typ	Description
code	string
message	string

ErrorResponse

Name	Typ	Description
error	ErrorInformation

FieldValue

Rozpoznaná hodnota pole.

Name	Typ	Description
boundingBox	number[]	Ohraničující rámeček hodnoty pole, pokud je to vhodné.
confidence	number	Skóre spolehlivosti.
elements	string[]	Pokud includeTextDetails je nastavena na true, seznam odkazů na textové prvky tvořící toto pole.
page	integer	Číslo stránky založené na 1 ve vstupním dokumentu.
text	string	Textový obsah extrahovaného pole.
type	FieldValueType	Typ hodnoty pole.
valueArray	FieldValue[]	Pole hodnot polí.
valueCountryRegion	string	3-písmena kód země (ISO 3166-1 alfa-3).
valueDate	string	Hodnota data.
valueInteger	integer	Celočíselná hodnota.
valueNumber	number	Hodnota s plovoucí desetinou čárkou.
valueObject	<string,  FieldValue>	Slovník hodnot pojmenovaných polí.
valuePhoneNumber	string	Hodnota telefonního čísla.
valueSelectionMark	enum: selected unselected	Hodnota značky výběru.
valueString	string	Řetězcová hodnota.
valueTime	string	Časová hodnota.

FieldValueType

Sémantický datový typ hodnoty pole.

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

KeyValueElement

Informace o extrahovaném klíči nebo hodnotě ve dvojici klíč-hodnota

Name	Typ	Description
boundingBox	number[]	Ohraničující rámeček klíče nebo hodnoty.
elements	string[]	Pokud includeTextDetails je nastavena na true, seznam odkazů na textové prvky tvořící tento klíč nebo hodnotu.
text	string	Textový obsah klíče nebo hodnoty.
type	KeyValueType	Sémantický datový typ prvku klíčové hodnoty.

KeyValuePair

Informace o extrahovaném páru klíč-hodnota

Name	Typ	Description
confidence	number	Hodnota spolehlivosti.
key	KeyValueElement	Informace o extrahovaném klíči ve dvojici klíč-hodnota
label	string	Uživatelem definovaný popisek pro položku páru klíč/hodnota.
value	KeyValueElement	Informace o extrahované hodnotě ve dvojici klíč-hodnota

KeyValueType

Sémantický datový typ prvku klíčové hodnoty.

Name	Typ	Description
selectionMark	string
string	string

LengthUnit

Jednotka používaná vlastnostmi width, height a boundingBox. U obrázků je to "pixel". Pro PDF je jednotka "inch".

Name	Typ	Description
inch	string
pixel	string

OperationStatus

Stav operace ve frontě.

Name	Typ	Description
failed	string
notStarted	string
running	string
succeeded	string

PageResult

Extrahované informace z jedné stránky.

Name	Typ	Description
clusterId	integer	Identifikátor clusteru.
keyValuePairs	KeyValuePair[]	Seznam párů klíč-hodnota extrahovaných ze stránky
page	integer	Číslo stránky.
tables	DataTable[]	Seznam tabulek dat extrahovaných ze stránky

ReadResult

Text extrahovaný ze stránky ve vstupním dokumentu

Name	Typ	Description
angle	number	Obecná orientace textu ve směru po směru hodinových ručiček měřená ve stupních mezi (-180, 180).
height	number	Výška obrázku nebo PDF v pixelech nebo palcích
lines	TextLine[]	Pokud je includeTextDetails nastavená na hodnotu true, zobrazí se seznam rozpoznaných textových řádků. Maximální počet vrácených řádků je 300 na stránku. Čáry jsou seřazené shora dolů, zleva doprava, i když v některých případech je vzdálenost považována za vyšší prioritu. Vzhledem k tomu, že pořadí řazení závisí na zjištěném textu, může se měnit napříč obrázky a aktualizacemi verzí OCR. Obchodní logika by proto měla být založena na skutečném umístění řádku místo na pořadí.
page	integer	Číslo stránky založené na 1 ve vstupním dokumentu.
selectionMarks	SelectionMark[]	Seznam značek výběru extrahovaných ze stránky
unit	LengthUnit	Jednotka používaná vlastnostmi width, height a boundingBox. U obrázků je to "pixel". Pro PDF je jednotka "inch".
width	number	Šířka obrázku nebo PDF v pixelech/palcích.

SelectionMark

Informace o extrahované značce výběru

Name	Typ	Description
boundingBox	number[]	Ohraničující rámeček značky výběru.
confidence	number	Hodnota spolehlivosti.
state	enum: selected unselected	Stav značky výběru.

Style

Objekt představující styl řádku textu.

Name	Typ	Description
confidence	number	Spolehlivost stylu čáry textu.
name	TextStyle	Název stylu textové čáry, včetně rukopisu a dalších.

TextLine

Objekt představující extrahovaný textový řádek.

Name	Typ	Description
appearance	Appearance	Vlastnosti vzhledu textu.
boundingBox	number[]	Ohraničující rámeček extrahované čáry.
text	string	Textový obsah řádku.
words	TextWord[]	Seznam slov v řádku textu

TextStyle

Název stylu textové čáry, včetně rukopisu a dalších.

Name	Typ	Description
handwriting	string
other	string

TextWord

Objekt představující slovo.

Name	Typ	Description
boundingBox	number[]	Ohraničující rámeček extrahovaného slova.
confidence	number	Hodnota spolehlivosti.
text	string	Textový obsah slova.