Analyzer - Analyze Layout

Služba:

Azure AI Services

Verze rozhraní API:

2.1

Extrahuje text a informace o rozložení z daného dokumentu. Vstupní dokument musí mít jeden z podporovaných typů obsahu – "application/pdf", "image/jpeg", "image/png", "image/tiff" nebo "image/bmp". Případně můžete použít typ application/json a určit umístění (URI nebo místní cestu) analyzovaného dokumentu.

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

S volitelnými parametry:

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

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).
language	query		Language	V současné době pouze afrikánština ('af'), albánština ('sq'), asturština ('ast'), baskičtina ('eu'), Bislama ('bi'), bretonština ('br'), katalánština ('ca'), Cebuano ('ceb'), Chamorro ('ch'), cornish ('kw'), Korsika ('co'), krymština-tatarská - latinka('crh'), čeština ('crh'), čeština ('kw'), korsika'cs'), dánština ('da'), nizozemština ('nl'), angličtina ('en'), estonština ('et'), fidžijština ('fj'), filipínština ('fj'), finština ('fi'), francouzština ('fr'), friuština ('fr'), galicijština ('gl'), němčina ('de'), gilbertština ('gil'), grónská ('kl'), Haitská kreolština ("ht"), Hani ("hni"), Hmong Daw ("mww"), maďarština ("hu"), indonéština ("id"), Interlingua ("ia"), Inuktitu ('iu'), irština ('ga'), italština ('it'), japonština ('ja'), javánština ('jv'), Kabuverdianu ('kea'), Kachin ('kac').), Kara-Kalpak ('kaa'), kashubian ('csb'), khasi ('kha'), korejština ('ko'), koso-latinka ('ku'), K'iche' ('quc'), lucemburština ('lb'), malajština ('ms'), Manx ('gv'), neapolština ('nap'), norština ('no'), okcitánština ('oc'), polština ('pl'), Portugalština ("pt"), romanština ("rm"), Skot ('sco'), skotská gaelština ("gd"), zjednodušená čínština ("zh-Hans"), slovinština ("sl"), španělština ("es"), svahilština ("sw"), švédština ("sv"), tatarština – latinka ('tt'), Tetum ("tet"), tradiční čínština ("zh-hant"), turečtina Jsou podporovány ("tr"), Horní srbština ("hsb"), uzbečtina ("uz"), Volapük ("vo"), Walser ("wae"), Západní Frisian ("fy"), Yucatec Maya ("yua"), Zhuang ("za") a Zulu ("zu") (tisk – třiasedmdesát jazyků a rukopis – pouze v angličtině). Rozložení podporuje automatickou identifikaci jazyka a vícejazyčné dokumenty, takže kód jazyka zadejte pouze v případě, že chcete vynutit zpracování dokumentovaného jazyka jako konkrétní jazyk.
pages	query		string[]	Vlastní čísla stránek pro vícestránkové dokumenty (PDF/TIFF) zadejte počet stránek, pro které chcete získat výsledek OCR. Pro rozsah stránek použijte spojovník. Každou stránku nebo oblast oddělte čárkou.
readingOrder	query		ReadingOrder	Algoritmus pořadí čtení, který seřadí vrácené řádky textu. Mezi podporované směry čtení patří: základní (výchozí), přirozené.

Hlavička požadavku

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

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

Text požadavku

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

Name	Typ	Description
source	string	Cesta ke zdroji souboru.

Odpovědi

Name	Typ	Description
202 Accepted		Požadavek je úspěšně zařazen do fronty. Hlavičky Operation-Location: string
Other Status Codes	ErrorResponse	Entita odpovědi, která doprovází neúspěšné odpovědi, obsahuje další podrobnosti o chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

Analyze layout

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

202

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

Definice

Name	Description
ErrorInformation
ErrorResponse
Language	V současné době pouze afrikánština ('af'), albánština ('sq'), asturština ('ast'), baskičtina ('eu'), Bislama ('bi'), bretonština ('br'), katalánština ('ca'), Cebuano ('ceb'), Chamorro ('ch'), cornish ('kw'), Korsika ('co'), krymština-tatarská - latinka('crh'), čeština ('crh'), čeština ('kw'), korsika'cs'), dánština ('da'), nizozemština ('nl'), angličtina ('en'), estonština ('et'), fidžijština ('fj'), filipínština ('fj'), finština ('fi'), francouzština ('fr'), friuština ('fr'), galicijština ('gl'), němčina ('de'), gilbertština ('gil'), grónská ('kl'), Haitská kreolština ("ht"), Hani ("hni"), Hmong Daw ("mww"), maďarština ("hu"), indonéština ("id"), Interlingua ("ia"), Inuktitu ('iu'), irština ('ga'), italština ('it'), japonština ('ja'), javánština ('jv'), Kabuverdianu ('kea'), Kachin ('kac').), Kara-Kalpak ('kaa'), kashubian ('csb'), khasi ('kha'), korejština ('ko'), koso-latinka ('ku'), K'iche' ('quc'), lucemburština ('lb'), malajština ('ms'), Manx ('gv'), neapolština ('nap'), norština ('no'), okcitánština ('oc'), polština ('pl'), Portugalština ("pt"), romanština ("rm"), Skot ('sco'), skotská gaelština ("gd"), zjednodušená čínština ("zh-Hans"), slovinština ("sl"), španělština ("es"), svahilština ("sw"), švédština ("sv"), tatarština – latinka ('tt'), Tetum ("tet"), tradiční čínština ("zh-hant"), turečtina Jsou podporovány ("tr"), Horní srbština ("hsb"), uzbečtina ("uz"), Volapük ("vo"), Walser ("wae"), Západní Frisian ("fy"), Yucatec Maya ("yua"), Zhuang ("za") a Zulu ("zu") (tisk – třiasedmdesát jazyků a rukopis – pouze v angličtině). Rozložení podporuje automatickou identifikaci jazyka a vícejazyčné dokumenty, takže kód jazyka zadejte pouze v případě, že chcete vynutit zpracování dokumentovaného jazyka jako konkrétní jazyk.
ReadingOrder	Algoritmus pořadí čtení, který seřadí vrácené řádky textu. Mezi podporované směry čtení patří: základní (výchozí), přirozené.
SourcePath	Identifikátor URI nebo místní cesta ke zdrojovým datům.

ErrorInformation

Name	Typ	Description
code	string
message	string

ErrorResponse

Name	Typ	Description
error	ErrorInformation

Language

V současné době pouze afrikánština ('af'), albánština ('sq'), asturština ('ast'), baskičtina ('eu'), Bislama ('bi'), bretonština ('br'), katalánština ('ca'), Cebuano ('ceb'), Chamorro ('ch'), cornish ('kw'), Korsika ('co'), krymština-tatarská - latinka('crh'), čeština ('crh'), čeština ('kw'), korsika'cs'), dánština ('da'), nizozemština ('nl'), angličtina ('en'), estonština ('et'), fidžijština ('fj'), filipínština ('fj'), finština ('fi'), francouzština ('fr'), friuština ('fr'), galicijština ('gl'), němčina ('de'), gilbertština ('gil'), grónská ('kl'), Haitská kreolština ("ht"), Hani ("hni"), Hmong Daw ("mww"), maďarština ("hu"), indonéština ("id"), Interlingua ("ia"), Inuktitu ('iu'), irština ('ga'), italština ('it'), japonština ('ja'), javánština ('jv'), Kabuverdianu ('kea'), Kachin ('kac').), Kara-Kalpak ('kaa'), kashubian ('csb'), khasi ('kha'), korejština ('ko'), koso-latinka ('ku'), K'iche' ('quc'), lucemburština ('lb'), malajština ('ms'), Manx ('gv'), neapolština ('nap'), norština ('no'), okcitánština ('oc'), polština ('pl'), Portugalština ("pt"), romanština ("rm"), Skot ('sco'), skotská gaelština ("gd"), zjednodušená čínština ("zh-Hans"), slovinština ("sl"), španělština ("es"), svahilština ("sw"), švédština ("sv"), tatarština – latinka ('tt'), Tetum ("tet"), tradiční čínština ("zh-hant"), turečtina Jsou podporovány ("tr"), Horní srbština ("hsb"), uzbečtina ("uz"), Volapük ("vo"), Walser ("wae"), Západní Frisian ("fy"), Yucatec Maya ("yua"), Zhuang ("za") a Zulu ("zu") (tisk – třiasedmdesát jazyků a rukopis – pouze v angličtině). Rozložení podporuje automatickou identifikaci jazyka a vícejazyčné dokumenty, takže kód jazyka zadejte pouze v případě, že chcete vynutit zpracování dokumentovaného jazyka jako konkrétní jazyk.

Name	Typ	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

Algoritmus pořadí čtení, který seřadí vrácené řádky textu. Mezi podporované směry čtení patří: základní (výchozí), přirozené.

Name	Typ	Description
basic	string
natural	string

SourcePath

Identifikátor URI nebo místní cesta ke zdrojovým datům.

Name	Typ	Description
source	string	Cesta ke zdroji souboru.