Analyzer - Get Analyze Layout Result

Referencia

Szolgáltatás:: Azure AI Services

API-verzió:: 2.1

A folyamat nyomon követése és az elemzési elrendezési művelet eredményének lekérése

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus2.api.cognitive.microsoft.com).
resultId	path	True	string uuid	Elemzési művelet eredményazonosítója.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string

Válaszok

Name	Típus	Description
200 OK	AnalyzeOperationResult	Siker
Other Status Codes	ErrorResponse	A nem sikeres válaszokat kísérő válaszentitás, amely további részleteket tartalmaz a hibáról.

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

Példák

Get analyze layout result

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

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

Definíciók

Name	Description
AnalyzeOperationResult	Az üzenetsorba helyezett elemzési művelet állapota és eredménye.
AnalyzeResult	A művelet eredményének elemzése.
Appearance	A szövegsor megjelenését jelképező objektum.
DataTable	Információk a lap kibontott táblájáról.
DataTableCell	A táblázat kibontott cellájára vonatkozó információk.
DocumentResult	A bemeneti dokumentumnak megfelelő kibontott mezők halmaza.
ErrorInformation
ErrorResponse
FieldValue	Felismert mezőérték.
FieldValueType	A mezőérték szemantikai adattípusa.
KeyValueElement	Információ a kinyert kulcsról vagy értékről egy kulcs-érték párban.
KeyValuePair	Információk a kinyert kulcs-érték párról.
KeyValueType	A kulcsérték elem szemantikai adattípusa.
LengthUnit	A szélesség, a magasság és a határolókeret tulajdonságai által használt egység. Képek esetén az egység "pixel". PDF esetén az egység "hüvelyk".
OperationStatus	Az üzenetsorba helyezett művelet állapota.
PageResult	Egyetlen oldalról kinyert információk.
ReadResult	A bemeneti dokumentum egy oldaláról kinyert szöveg.
SelectionMark	Információk a kinyert kijelölési jelről.
Style	A szövegsor stílusát képviselő objektum.
TextLine	Kinyert szövegsort jelölő objektum.
TextStyle	A szövegsor stílusának neve, beleértve a kézírást és másokat is.
TextWord	Egy szót jelképező objektum.

AnalyzeOperationResult

Az üzenetsorba helyezett elemzési művelet állapota és eredménye.

Name	Típus	Description
analyzeResult	AnalyzeResult	Az elemzési művelet eredményei.
createdDateTime	string	Az elemzési művelet elküldésének dátuma és időpontja (UTC).
lastUpdatedDateTime	string	Az állapot utolsó frissítésének dátuma és időpontja (UTC).
status	OperationStatus	Művelet állapota.

AnalyzeResult

A művelet eredményének elemzése.

Name	Típus	Description
documentResults	DocumentResult[]	A bemenetből kinyert dokumentumszintű információk.
errors	ErrorInformation[]	Az elemzési művelet során jelentett hibák listája.
pageResults	PageResult[]	A bemenetből kinyert oldalszintű információk.
readResults	ReadResult[]	A bemenetből kinyert szöveg.
version	string	Az eredményhez használt séma verziója.

Appearance

A szövegsor megjelenését jelképező objektum.

Name	Típus	Description
style	Style	A szövegsor stílusát képviselő objektum.

DataTable

Információk a lap kibontott táblájáról.

Name	Típus	Description
boundingBox	number[]	A táblázat határolókerete.
cells	DataTableCell[]	A táblázatban található cellák listája.
columns	integer	Oszlopok száma.
rows	integer	Sorok száma.

DataTableCell

A táblázat kibontott cellájára vonatkozó információk.

Name	Típus	Alapértelmezett érték	Description
boundingBox	number[]		A cella határolókerete.
columnIndex	integer		A cella oszlopindexe.
columnSpan	integer	1	A cellán átnyúló oszlopok száma.
confidence	number		Megbízhatósági érték.
elements	string[]		Ha az includeTextDetails értéke igaz, a táblázatcellát alkotó szöveges elemekre mutató hivatkozások listája.
isFooter	boolean	False	Az aktuális cella élőlábcella?
isHeader	boolean	False	Az aktuális cella fejléccella?
rowIndex	integer		A cella sorindexe.
rowSpan	integer	1	A cellán átnyúló sorok száma.
text	string		A cella szöveges tartalma.

DocumentResult

A bemeneti dokumentumnak megfelelő kibontott mezők halmaza.

Name	Típus	Description
docType	string	Dokumentum típusa.
docTypeConfidence	number	Előrejelzett dokumentumtípus megbízhatósága.
fields	<string, FieldValue>	Elnevezett mezőértékek szótára.
modelId	string	Modellazonosító.
pageRange	integer[]	Az első és az utolsó oldalszám, ahol a dokumentum található.

ErrorInformation

Name	Típus	Description
code	string
message	string

ErrorResponse

Name	Típus	Description
error	ErrorInformation

FieldValue

Felismert mezőérték.

Name	Típus	Description
boundingBox	number[]	Ha szükséges, a mezőérték határolókerete.
confidence	number	Megbízhatósági pontszám.
elements	string[]	Ha az includeTextDetails értéke true (igaz), akkor a mezőnek minősülő szöveges elemekre mutató hivatkozások listája.
page	integer	A bemeneti dokumentum 1-alapú oldalszáma.
text	string	A kinyert mező szöveges tartalma.
type	FieldValueType	Mezőérték típusa.
valueArray	FieldValue[]	Mezőértékek tömbje.
valueCountryRegion	string	3 betűs országkód (ISO 3166-1 alpha-3).
valueDate	string	Dátumérték.
valueInteger	integer	Egész számérték.
valueNumber	number	Lebegőpontos érték.
valueObject	<string, FieldValue>	Elnevezett mezőértékek szótára.
valuePhoneNumber	string	Telefonszám értéke.
valueSelectionMark	enum: selected unselected	Kijelölésjel értéke.
valueString	string	Sztringérték.
valueTime	string	Időérték.

FieldValueType

A mezőérték szemantikai adattípusa.

Name	Típus	Description
array	string
countryRegion	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
string	string
time	string

KeyValueElement

Információ a kinyert kulcsról vagy értékről egy kulcs-érték párban.

Name	Típus	Description
boundingBox	number[]	A kulcs vagy érték határolókerete.
elements	string[]	Ha az includeTextDetails értéke true (igaz), a kulcsnak vagy értéknek minősülő szöveges elemekre mutató hivatkozások listája.
text	string	A kulcs vagy érték szöveges tartalma.
type	KeyValueType	A kulcsérték elem szemantikai adattípusa.

KeyValuePair

Információk a kinyert kulcs-érték párról.

Name	Típus	Description
confidence	number	Megbízhatósági érték.
key	KeyValueElement	Információ a kulcs-érték párban kinyert kulcsról.
label	string	A kulcs/érték pár bejegyzés felhasználó által definiált címkéje.
value	KeyValueElement	Információ a kinyert értékről egy kulcs-érték párban.

KeyValueType

A kulcsérték elem szemantikai adattípusa.

Name	Típus	Description
selectionMark	string
string	string

LengthUnit

A szélesség, a magasság és a határolókeret tulajdonságai által használt egység. Képek esetén az egység "pixel". PDF esetén az egység "hüvelyk".

Name	Típus	Description
inch	string
pixel	string

OperationStatus

Az üzenetsorba helyezett művelet állapota.

Name	Típus	Description
failed	string
notStarted	string
running	string
succeeded	string

PageResult

Egyetlen oldalról kinyert információk.

Name	Típus	Description
clusterId	integer	Fürtazonosító.
keyValuePairs	KeyValuePair[]	Az oldalról kinyert kulcs-érték párok listája.
page	integer	Oldalszám.
tables	DataTable[]	A lapról kinyert adattáblák listája.

ReadResult

A bemeneti dokumentum egy oldaláról kinyert szöveg.

Name	Típus	Description
angle	number	A szöveg általános tájolása az óramutató járásával megegyező irányban, fokban mérve (-180, 180).
height	number	A kép/PDF magassága képpontban/hüvelykben.
lines	TextLine[]	Ha az includeTextDetails értéke igaz, a felismert szövegsorok listája. A visszaadott sorok maximális száma oldalanként 300. A vonalak felülről lefelé, balról jobbra vannak rendezve, bár bizonyos esetekben a közelség magasabb prioritással van kezelve. Mivel a rendezési sorrend az észlelt szövegtől függ, a képek és az OCR-verziófrissítések között változhat. Így az üzleti logikát a rendelés helyett a tényleges sorhelyre kell építeni.
page	integer	A bemeneti dokumentum 1-alapú oldalszáma.
selectionMarks	SelectionMark[]	A lapról kinyert kijelölésjelek listája.
unit	LengthUnit	A szélesség, a magasság és a határolókeret tulajdonságai által használt egység. Képek esetén az egység "pixel". PDF esetén az egység "hüvelyk".
width	number	A kép/PDF szélessége képpontban/hüvelykben.

SelectionMark

Információk a kinyert kijelölési jelről.

Name	Típus	Description
boundingBox	number[]	A kijelölési jel határolókerete.
confidence	number	Megbízhatósági érték.
state	enum: selected unselected	A kijelölési jel állapota.

Style

A szövegsor stílusát képviselő objektum.

Name	Típus	Description
confidence	number	A szövegsorstílus megbízhatósága.
name	TextStyle	A szövegsor stílusának neve, beleértve a kézírást és másokat is.

TextLine

Kinyert szövegsort jelölő objektum.

Name	Típus	Description
appearance	Appearance	A szöveg megjelenésének tulajdonságai.
boundingBox	number[]	Kibontott vonal határolókerete.
text	string	A sor szöveges tartalma.
words	TextWord[]	A szövegsorban lévő szavak listája.

TextStyle

A szövegsor stílusának neve, beleértve a kézírást és másokat is.

Name	Típus	Description
handwriting	string
other	string

TextWord

Egy szót jelképező objektum.

Name	Típus	Description
boundingBox	number[]	Kibontott szó határolókerete.
confidence	number	Megbízhatósági érték.
text	string	A szó szöveges tartalma.

Megosztás a következőn keresztül: