Analyzer - Analyze Layout

Service:

Azure AI Services

API-versie:

2.1

Tekst- en indelingsgegevens extraheren uit een bepaald document. Het invoerdocument moet van een van de ondersteunde inhoudstypen zijn: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' of 'image/bmp'. U kunt ook het type toepassing/json gebruiken om de locatie (URI of lokaal pad) op te geven van het document dat moet worden geanalyseerd.

POST {endpoint}/formrecognizer/v2.1/layout/analyze

Met optionele parameters:

POST {endpoint}/formrecognizer/v2.1/layout/analyze?pages={pages}&language={language}&readingOrder={readingOrder}

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).
language	query		Language	Momenteel, alleen Afrikaans ('af'), Albanees ('sq'), Asturisch ('ast'), Baskisch ('eu'), Bislama ('bi'), Breton ('br'), Catalaans ('ca'), Mesoano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Corsicaans ('co'), Krim-Tatar - Latijns schrift('crh'), Tsjechisch ('cs'), Deens ('da'), Nederlands ('nl'), Engels ('en'), Ests ('et'), Fijian ('fj'), Filipijns ('fil'), Fins ('fi'), Frans ('fr'), Cachingan ('fur'), Galicisch ('gl'), Duits ('de'), Gilbertese ('gil'), Groenlands ('kl'), Haïtiaanse Creoolse ('ht'), Hani ('hni'), Hmong Daw ('mww'), Hongaars ('hu'), Indonesisch ('id'), Interlingua ('ia'), Inuktitut ('iu'), Iers ('ga'), Italiaans ('it'), Japans ('ja'), Javaans ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ("kaa"), Kashubian ('csb'), Khasi ('kha'), Koreaans ('ko'), Koerdisch - Latijns schrift ('ku'), K'iche' ('quc'), Luxemburgs ('lb'), Maleis ('ms'), Manx ('gv'), Neapolitan ('nap'), Noors ('no'), Occitaans ('oc'), Pools ('pl'), Portugees ('pt'), Reto-Romaans ('rm'), Schots ('sco'), Schots Gaelisch ('gd'), vereenvoudigd Chinees ('zh-Hans'), Sloveens ('sl'), Spaans ('es'), Swahili ('sw'), Zweeds ('sv'), Tatar - Latijns schrift ('tt'), Tetum ('tet'), traditioneel Chinees ('zh-Hant'), Turks ('tr'), Opper-Sorbisch ('hsb'), Oezbeeks ('uz'), Volapük ('vo'), Walser ('wae'), West-Fries ('fy'), Yucatec Maya ('yua'), Zhuang ('za') en Zulu ('zu') worden ondersteund (druk – drieënzeventig talen en handgeschreven – alleen Engels). Indeling ondersteunt automatische taalidentificatie en meertalige documenten, dus geef alleen een taalcode op als u wilt afdwingen dat de gedocumenteerde worden verwerkt als die specifieke taal.
pages	query		string[]	Aangepaste paginanummers voor documenten met meerdere pagina's (PDF/TIFF), voeren het aantal pagina's in dat u ocr-resultaat wilt ophalen. Gebruik een afbreekstreepje voor een reeks pagina's. Scheid elke pagina of elk bereik met een komma.
readingOrder	query		ReadingOrder	Algoritme voor leesvolgorde om de geretourneerde tekstregels te sorteren. Ondersteunde leesopdrachten zijn onder andere: basic (standaard), natuurlijk.

Aanvraagkoptekst

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

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

Aanvraagbody

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name	Type	Description
source	string	Bestandsbronpad.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is in de wachtrij geplaatst. Kopteksten Operation-Location: string
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

Analyze layout

Voorbeeldaanvraag

HTTP

POST {endpoint}/formrecognizer/v2.1/layout/analyze?language=en

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
ErrorInformation
ErrorResponse
Language	Momenteel, alleen Afrikaans ('af'), Albanees ('sq'), Asturisch ('ast'), Baskisch ('eu'), Bislama ('bi'), Breton ('br'), Catalaans ('ca'), Mesoano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Corsicaans ('co'), Krim-Tatar - Latijns schrift('crh'), Tsjechisch ('cs'), Deens ('da'), Nederlands ('nl'), Engels ('en'), Ests ('et'), Fijian ('fj'), Filipijns ('fil'), Fins ('fi'), Frans ('fr'), Cachingan ('fur'), Galicisch ('gl'), Duits ('de'), Gilbertese ('gil'), Groenlands ('kl'), Haïtiaanse Creoolse ('ht'), Hani ('hni'), Hmong Daw ('mww'), Hongaars ('hu'), Indonesisch ('id'), Interlingua ('ia'), Inuktitut ('iu'), Iers ('ga'), Italiaans ('it'), Japans ('ja'), Javaans ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ("kaa"), Kashubian ('csb'), Khasi ('kha'), Koreaans ('ko'), Koerdisch - Latijns schrift ('ku'), K'iche' ('quc'), Luxemburgs ('lb'), Maleis ('ms'), Manx ('gv'), Neapolitan ('nap'), Noors ('no'), Occitaans ('oc'), Pools ('pl'), Portugees ('pt'), Reto-Romaans ('rm'), Schots ('sco'), Schots Gaelisch ('gd'), vereenvoudigd Chinees ('zh-Hans'), Sloveens ('sl'), Spaans ('es'), Swahili ('sw'), Zweeds ('sv'), Tatar - Latijns schrift ('tt'), Tetum ('tet'), traditioneel Chinees ('zh-Hant'), Turks ('tr'), Opper-Sorbisch ('hsb'), Oezbeeks ('uz'), Volapük ('vo'), Walser ('wae'), West-Fries ('fy'), Yucatec Maya ('yua'), Zhuang ('za') en Zulu ('zu') worden ondersteund (druk – drieënzeventig talen en handgeschreven – alleen Engels). Indeling ondersteunt automatische taalidentificatie en meertalige documenten, dus geef alleen een taalcode op als u wilt afdwingen dat de gedocumenteerde worden verwerkt als die specifieke taal.
ReadingOrder	Algoritme voor leesvolgorde om de geretourneerde tekstregels te sorteren. Ondersteunde leesopdrachten zijn onder andere: basic (standaard), natuurlijk.
SourcePath	URI of lokaal pad naar brongegevens.

ErrorInformation

Name	Type	Description
code	string
message	string

ErrorResponse

Name	Type	Description
error	ErrorInformation

Language

Momenteel, alleen Afrikaans ('af'), Albanees ('sq'), Asturisch ('ast'), Baskisch ('eu'), Bislama ('bi'), Breton ('br'), Catalaans ('ca'), Mesoano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Corsicaans ('co'), Krim-Tatar - Latijns schrift('crh'), Tsjechisch ('cs'), Deens ('da'), Nederlands ('nl'), Engels ('en'), Ests ('et'), Fijian ('fj'), Filipijns ('fil'), Fins ('fi'), Frans ('fr'), Cachingan ('fur'), Galicisch ('gl'), Duits ('de'), Gilbertese ('gil'), Groenlands ('kl'), Haïtiaanse Creoolse ('ht'), Hani ('hni'), Hmong Daw ('mww'), Hongaars ('hu'), Indonesisch ('id'), Interlingua ('ia'), Inuktitut ('iu'), Iers ('ga'), Italiaans ('it'), Japans ('ja'), Javaans ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ("kaa"), Kashubian ('csb'), Khasi ('kha'), Koreaans ('ko'), Koerdisch - Latijns schrift ('ku'), K'iche' ('quc'), Luxemburgs ('lb'), Maleis ('ms'), Manx ('gv'), Neapolitan ('nap'), Noors ('no'), Occitaans ('oc'), Pools ('pl'), Portugees ('pt'), Reto-Romaans ('rm'), Schots ('sco'), Schots Gaelisch ('gd'), vereenvoudigd Chinees ('zh-Hans'), Sloveens ('sl'), Spaans ('es'), Swahili ('sw'), Zweeds ('sv'), Tatar - Latijns schrift ('tt'), Tetum ('tet'), traditioneel Chinees ('zh-Hant'), Turks ('tr'), Opper-Sorbisch ('hsb'), Oezbeeks ('uz'), Volapük ('vo'), Walser ('wae'), West-Fries ('fy'), Yucatec Maya ('yua'), Zhuang ('za') en Zulu ('zu') worden ondersteund (druk – drieënzeventig talen en handgeschreven – alleen Engels). Indeling ondersteunt automatische taalidentificatie en meertalige documenten, dus geef alleen een taalcode op als u wilt afdwingen dat de gedocumenteerde worden verwerkt als die specifieke taal.

Name	Type	Description
af	string
ast	string
bi	string
br	string
ca	string
ceb	string
ch	string
co	string
crh	string
cs	string
csb	string
da	string
de	string
en	string
es	string
et	string
eu	string
fi	string
fil	string
fj	string
fr	string
fur	string
fy	string
ga	string
gd	string
gil	string
gl	string
gv	string
hni	string
hsb	string
ht	string
hu	string
ia	string
id	string
it	string
iu	string
ja	string
jv	string
kaa	string
kac	string
kea	string
kha	string
kl	string
ko	string
ku	string
kw	string
lb	string
ms	string
mww	string
nap	string
nl	string
no	string
oc	string
pl	string
pt	string
quc	string
rm	string
sco	string
sl	string
sq	string
sv	string
sw	string
tet	string
tr	string
tt	string
uz	string
vo	string
wae	string
yua	string
za	string
zh-Hans	string
zh-Hant	string
zu	string

ReadingOrder

Algoritme voor leesvolgorde om de geretourneerde tekstregels te sorteren. Ondersteunde leesopdrachten zijn onder andere: basic (standaard), natuurlijk.

Name	Type	Description
basic	string
natural	string

SourcePath

URI of lokaal pad naar brongegevens.

Name	Type	Description
source	string	Bestandsbronpad.