Analyzer - Get Analyze Id Document Result
Kövesse nyomon az előrehaladást, és szerezze be az elemzési azonosító művelet eredményét.
GET {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/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). |
result
|
path | True |
string uuid |
A művelet eredményazonosítóinak elemzése. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Siker |
|
Other Status Codes |
A nem sikeres válaszokat kísérő válasz entitá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 ID result
Mintakérelem
GET {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f
Mintaválasz
{
"status": "running",
"createdDateTime": "2019-05-01T10:53:21Z",
"lastUpdatedDateTime": "2019-05-01T10:53:23Z",
"analyzeResult": {
"version": "v2.1",
"readResults": [],
"pageResults": [],
"documentResults": [],
"errors": []
}
}
Definíciók
Name | Description |
---|---|
Analyze |
Az üzenetsorba helyezett elemzési művelet állapota és eredménye. |
Analyze |
A művelet eredményének elemzése. |
Appearance |
A szövegsor megjelenését jelképező objektum. |
Data |
Információk a lap kibontott táblájáról. |
Data |
A táblázat kibontott cellájára vonatkozó információk. |
Document |
A bemeneti dokumentumnak megfelelő kibontott mezők halmaza. |
Error |
|
Error |
|
Field |
Felismert mezőérték. |
Field |
A mezőérték szemantikai adattípusa. |
Key |
Információ a kinyert kulcsról vagy értékről egy kulcs-érték párban. |
Key |
Információk a kinyert kulcs-érték párról. |
Key |
A kulcsérték elem szemantikai adattípusa. |
Length |
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". |
Operation |
Az üzenetsorba helyezett művelet állapota. |
Page |
Egyetlen oldalról kinyert információk. |
Read |
A bemeneti dokumentum egy oldaláról kinyert szöveg. |
Selection |
Információk a kinyert kijelölési jelről. |
Style |
A szövegsor stílusát képviselő objektum. |
Text |
Kinyert szövegsort jelölő objektum. |
Text |
A szövegsorstílus neve, beleértve a kézírást és az egyéb elemet is. |
Text |
Egy szót jelképező objektum. |
AnalyzeOperationResult
Az üzenetsorba helyezett elemzési művelet állapota és eredménye.
Name | Típus | Description |
---|---|---|
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 |
Művelet állapota. |
AnalyzeResult
A művelet eredményének elemzése.
Name | Típus | Description |
---|---|---|
documentResults |
A bemenetből kinyert dokumentumszintű információk. |
|
errors |
Az elemzési művelet során jelentett hibák listája. |
|
pageResults |
A bemenetből kinyert oldalszintű információk. |
|
readResults |
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 |
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 |
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,
Field |
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 |
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 |
Mezőérték típusa. |
|
valueArray |
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,
Field |
Elnevezett mezőértékek szótára. |
valuePhoneNumber |
string |
Telefonszám értéke. |
valueSelectionMark |
enum:
|
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 |
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 |
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 |
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 |
Az oldalról kinyert kulcs-érték párok listája. |
|
page |
integer |
Oldalszám. |
tables |
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 |
Text |
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 |
A lapról kinyert kijelölésjelek listája. |
|
unit |
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:
|
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 |
A szövegsorstílus neve, beleértve a kézírást és az egyéb elemet is. |
TextLine
Kinyert szövegsort jelölő objektum.
Name | Típus | Description |
---|---|---|
appearance |
A szöveg megjelenésének tulajdonságai. |
|
boundingBox |
number[] |
Kibontott vonal határolókerete. |
text |
string |
A sor szöveges tartalma. |
words |
Text |
A szövegsorban lévő szavak listája. |
TextStyle
A szövegsorstílus neve, beleértve a kézírást és az egyéb elemet 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. |