Analyzer - Get Analyze Id Document Result

Referentie

Service:: Azure AI Services

API-versie:: 2.1

De voortgang bijhouden en het resultaat van de analyse-id-bewerking verkrijgen.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus2.api.cognitive.microsoft.com).
resultId	path	True	string uuid	De resultaat-id van de bewerking analyseren.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string

Antwoorden

Name	Type	Description
200 OK	AnalyzeOperationResult	Geslaagd
Other Status Codes	ErrorResponse	Antwoordentiteit bij niet-geslaagde antwoorden met aanvullende informatie over de fout.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

Get analyze ID result

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
AnalyzeOperationResult	Status en resultaat van de analysebewerking in de wachtrij.
AnalyzeResult	Bewerkingsresultaat analyseren.
Appearance	Een object dat het uiterlijk van de tekstregel weergeeft.
DataTable	Informatie over de geëxtraheerde tabel op een pagina.
DataTableCell	Informatie over de geëxtraheerde cel in een tabel.
DocumentResult	Een set geëxtraheerde velden die overeenkomen met het invoerdocument.
ErrorInformation
ErrorResponse
FieldValue	Herkende veldwaarde.
FieldValueType	Semantisch gegevenstype van de veldwaarde.
KeyValueElement	Informatie over de geëxtraheerde sleutel of waarde in een sleutel-waardepaar.
KeyValuePair	Informatie over het geëxtraheerde sleutel-waardepaar.
KeyValueType	Semantisch gegevenstype van het sleutelwaardeelement.
LengthUnit	De eenheid die wordt gebruikt door de eigenschappen width, height en boundingBox. Voor afbeeldingen is de eenheid 'pixel'. Voor PDF is de eenheid 'inch'.
OperationStatus	Status van de bewerking in de wachtrij.
PageResult	Geëxtraheerde informatie uit één pagina.
ReadResult	Tekst geëxtraheerd van een pagina in het invoerdocument.
SelectionMark	Informatie over de geëxtraheerde selectiemarkering.
Style	Een object dat de stijl van de tekstregel vertegenwoordigt.
TextLine	Een object dat een geëxtraheerde tekstregel vertegenwoordigt.
TextStyle	De naam van de tekstregelstijl, inclusief handschrift en andere.
TextWord	Een object dat een woord vertegenwoordigt.

AnalyzeOperationResult

Status en resultaat van de analysebewerking in de wachtrij.

Name	Type	Description
analyzeResult	AnalyzeResult	Resultaten van de analysebewerking.
createdDateTime	string	De datum en tijd (UTC) waarop de analysebewerking is verzonden.
lastUpdatedDateTime	string	De datum en tijd (UTC) waarop de status voor het laatst is bijgewerkt.
status	OperationStatus	Bewerkingsstatus.

AnalyzeResult

Bewerkingsresultaat analyseren.

Name	Type	Description
documentResults	DocumentResult[]	Informatie op documentniveau geëxtraheerd uit de invoer.
errors	ErrorInformation[]	Lijst met fouten die zijn gerapporteerd tijdens de analysebewerking.
pageResults	PageResult[]	Informatie op paginaniveau geëxtraheerd uit de invoer.
readResults	ReadResult[]	Tekst geëxtraheerd uit de invoer.
version	string	Versie van het schema dat voor dit resultaat wordt gebruikt.

Appearance

Een object dat het uiterlijk van de tekstregel weergeeft.

Name	Type	Description
style	Style	Een object dat de stijl van de tekstregel vertegenwoordigt.

DataTable

Informatie over de geëxtraheerde tabel op een pagina.

Name	Type	Description
boundingBox	number[]	Begrenzingsvak van de tabel.
cells	DataTableCell[]	Lijst met cellen in de tabel.
columns	integer	Aantal kolommen.
rows	integer	Aantal rijen.

DataTableCell

Informatie over de geëxtraheerde cel in een tabel.

Name	Type	Default value	Description
boundingBox	number[]		Begrenzingsvak van de cel.
columnIndex	integer		Kolomindex van de cel.
columnSpan	integer	1	Het aantal kolommen dat door deze cel wordt omspannen.
confidence	number		Betrouwbaarheidswaarde.
elements	string[]		Wanneer includeTextDetails is ingesteld op true, wordt een lijst met verwijzingen naar de tekstelementen in deze tabelcel weergegeven.
isFooter	boolean	False	Is de huidige cel een voettekstcel?
isHeader	boolean	False	Is de huidige cel een koptekstcel?
rowIndex	integer		Rijindex van de cel.
rowSpan	integer	1	Het aantal rijen dat door deze cel wordt omspannen.
text	string		Tekstinhoud van de cel.

DocumentResult

Een set geëxtraheerde velden die overeenkomen met het invoerdocument.

Name	Type	Description
docType	string	Documenttype.
docTypeConfidence	number	Voorspelde betrouwbaarheid van documenttypen.
fields	<string, FieldValue>	Woordenlijst met benoemde veldwaarden.
modelId	string	Model-id.
pageRange	integer[]	Nummer van de eerste en laatste pagina waar het document is gevonden.

ErrorInformation

Name	Type	Description
code	string
message	string

ErrorResponse

Name	Type	Description
error	ErrorInformation

FieldValue

Herkende veldwaarde.

Name	Type	Description
boundingBox	number[]	Begrenzingsvak van de veldwaarde, indien van toepassing.
confidence	number	Betrouwbaarheidsscore.
elements	string[]	Wanneer includeTextDetails is ingesteld op true, een lijst met verwijzingen naar de tekstelementen die deel uitmaken van dit veld.
page	integer	Het paginanummer op basis van 1 in het invoerdocument.
text	string	Tekstinhoud van het geëxtraheerde veld.
type	FieldValueType	Type veldwaarde.
valueArray	FieldValue[]	Matrix van veldwaarden.
valueCountryRegion	string	Drieletterige landcode (ISO 3166-1 alfa-3).
valueDate	string	Datumwaarde.
valueInteger	integer	Waarde voor geheel getal.
valueNumber	number	Drijvende-kommawaarde.
valueObject	<string, FieldValue>	Woordenlijst met benoemde veldwaarden.
valuePhoneNumber	string	Waarde van telefoonnummer.
valueSelectionMark	enum: selected unselected	Waarde van selectiemarkering.
valueString	string	Tekenreekswaarde.
valueTime	string	Tijdwaarde.

FieldValueType

Semantisch gegevenstype van de veldwaarde.

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

KeyValueElement

Informatie over de geëxtraheerde sleutel of waarde in een sleutel-waardepaar.

Name	Type	Description
boundingBox	number[]	Begrenzingsvak van de sleutel of waarde.
elements	string[]	Wanneer includeTextDetails is ingesteld op true, een lijst met verwijzingen naar de tekstelementen die deze sleutel of waarde vormen.
text	string	De tekstinhoud van de sleutel of waarde.
type	KeyValueType	Semantisch gegevenstype van het sleutelwaardeelement.

KeyValuePair

Informatie over het geëxtraheerde sleutel-waardepaar.

Name	Type	Description
confidence	number	Betrouwbaarheidswaarde.
key	KeyValueElement	Informatie over de geëxtraheerde sleutel in een sleutel-waardepaar.
label	string	Een door de gebruiker gedefinieerd label voor het sleutel-waardepaar.
value	KeyValueElement	Informatie over de geëxtraheerde waarde in een sleutel-waardepaar.

KeyValueType

Semantisch gegevenstype van het sleutelwaardeelement.

Name	Type	Description
selectionMark	string
string	string

LengthUnit

De eenheid die wordt gebruikt door de eigenschappen width, height en boundingBox. Voor afbeeldingen is de eenheid 'pixel'. Voor PDF is de eenheid 'inch'.

Name	Type	Description
inch	string
pixel	string

OperationStatus

Status van de bewerking in de wachtrij.

Name	Type	Description
failed	string
notStarted	string
running	string
succeeded	string

PageResult

Geëxtraheerde informatie uit één pagina.

Name	Type	Description
clusterId	integer	Cluster-id.
keyValuePairs	KeyValuePair[]	Lijst met sleutel-waardeparen die van de pagina zijn geëxtraheerd.
page	integer	Paginanummer.
tables	DataTable[]	Lijst met gegevenstabellen die van de pagina zijn geëxtraheerd.

ReadResult

Tekst geëxtraheerd van een pagina in het invoerdocument.

Name	Type	Description
angle	number	De algemene richting van de tekst met de klok mee, gemeten in graden tussen (-180, 180).
height	number	De hoogte van de afbeelding/PDF in respectievelijk pixels/inch.
lines	TextLine[]	Wanneer includeTextDetails is ingesteld op true, een lijst met herkende tekstregels. Het maximum aantal geretourneerde regels is 300 per pagina. De lijnen worden van boven naar beneden gesorteerd, van links naar rechts, hoewel in bepaalde gevallen nabijheid met een hogere prioriteit wordt behandeld. Omdat de sorteervolgorde afhankelijk is van de gedetecteerde tekst, kan deze worden gewijzigd tussen afbeeldingen en OCR-versie-updates. Bedrijfslogica moet dus worden gebaseerd op de werkelijke regellocatie in plaats van op volgorde.
page	integer	Het paginanummer op basis van 1 in het invoerdocument.
selectionMarks	SelectionMark[]	Lijst met selectiemarkeringen die van de pagina zijn geëxtraheerd.
unit	LengthUnit	De eenheid die wordt gebruikt door de eigenschappen width, height en boundingBox. Voor afbeeldingen is de eenheid 'pixel'. Voor PDF is de eenheid 'inch'.
width	number	De breedte van de afbeelding/PDF in respectievelijk pixels/inch.

SelectionMark

Informatie over de geëxtraheerde selectiemarkering.

Name	Type	Description
boundingBox	number[]	Begrenzingsvak van de selectiemarkering.
confidence	number	Betrouwbaarheidswaarde.
state	enum: selected unselected	Status van de selectiemarkering.

Style

Een object dat de stijl van de tekstregel vertegenwoordigt.

Name	Type	Description
confidence	number	De betrouwbaarheid van de stijl van tekstlijnen.
name	TextStyle	De naam van de tekstregelstijl, inclusief handschrift en andere.

TextLine

Een object dat een geëxtraheerde tekstregel vertegenwoordigt.

Name	Type	Description
appearance	Appearance	Eigenschappen van tekstweergave.
boundingBox	number[]	Begrenzingsvak van een geëxtraheerde lijn.
text	string	De tekstinhoud van de regel.
words	TextWord[]	Lijst met woorden in de tekstregel.

TextStyle

De naam van de tekstregelstijl, inclusief handschrift en andere.

Name	Type	Description
handwriting	string
other	string

TextWord

Een object dat een woord vertegenwoordigt.

Name	Type	Description
boundingBox	number[]	Begrenzingsvak van een geëxtraheerd woord.
confidence	number	Betrouwbaarheidswaarde.
text	string	De tekstinhoud van het woord.

Delen via