Analyzer - Analyze Layout

Tjänst:

Azure AI Services

API-version:

2.1

Extrahera text- och layoutinformation från ett visst dokument. Indatadokumentet måste ha någon av de innehållstyper som stöds – "application/pdf", "image/jpeg", "image/png", "image/tiff" eller "image/bmp". Du kan också använda typen "application/json" för att ange platsen (Uri eller lokal sökväg) för dokumentet som ska analyseras.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
language	query		Language	För närvarande endast afrikaaner ('af'), albanska ('sq'), asturiska ('ast'), baskiska ('eu'), Bislama ('bi'), Breton ('br'), katalanska ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Korsikan ('co'), Krimtatar - latinsk skrift('crh''), Cornish ('kw'), Korsikan ('co'), Krimtatar - latinsk skrift('crh''), ), tjeckiska ('cs'), danska ('da'), nederländska ('nl'), engelska ('en'), estniska ('et'), fijianska ('fj'), filippinska ('fil'), finska ('fi'), franska ('fr'), friuliska ('fur'), galiciska ('gl'), tyska ('de'), Gilbertese ('gil'), Grönlandic ('kl'), Haitisk kreol ('ht'), Hani ('hni'), Hmong Daw ('mww'), ungerska ('hu'), indonesiska ('id'), Interlingua ('ia'), Inuktitut ('iu'), irländska ('ga'), italienska ('it'), japanska ('ja'), Javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'' ), Kara-Kalpak ('kaa'), Kashubian ('csb'), Khasi ('kha'), koreansk ('ko'), kurdisk - latinsk skrift ('ku'), K'iche' ('quc'), luxemburgsk ('lb'), malajiska ('ms'), Manx ('gv'), neapolitan ('nap'), norska ('nej'), Occitan ('oc'), polska ('pl'), Portugisiska ('pt'), Romansh ('rm'), skottar ('sco'), skotsk gaeliska ('gd'), förenklad kinesiska ('zh-Hans'), slovenska ('sl'), spanska ('es'), Swahili ('sw'), svenska ('sv'), tatar - latinsk skrift ('tt'), Tetum ('tet'), traditionell kinesiska ('zh-Hant'), turkiska ('tr'), Upper Sorbian ('hsb'), Uzbek ('uz'), Volapük ('vo'), Walser ('wae'), Western Frisian ('fy'), Yucatec Maya ('yua'), Zhuang ('za') och Zulu ('zu') stöds (skriv ut – sjuttiotre språk och handskrivna – endast engelska). Layout stöder automatisk språkidentifiering och dokument med flera språk, så ange bara en språkkod om du vill tvinga den dokumenterade att bearbetas som det specifika språket.
pages	query		string[]	Anpassade sidnummer för dokument med flera sidor (PDF/TIFF), anger antalet sidor som du vill få OCR-resultat. Använd ett bindestreck för ett intervall med sidor. Avgränsa varje sida eller intervall med kommatecken.
readingOrder	query		ReadingOrder	Läsordningsalgoritm för att sortera de returnerade textraderna. Läsordrar som stöds är: basic(default), natural.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

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

Name	Typ	Description
source	string minLength: 0 maxLength: 2048	Sökväg till filkälla.

Svar

Name	Typ	Description
202 Accepted		Begäran har placerats i kö. Sidhuvuden Operation-Location: string
Other Status Codes	ErrorResponse	Svarsentitet som medföljer icke-lyckade svar som innehåller ytterligare information om felet.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Analyze layout

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

202

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

Definitioner

Name	Description
ErrorInformation
ErrorResponse
Language	För närvarande endast afrikaaner ('af'), albanska ('sq'), asturiska ('ast'), baskiska ('eu'), Bislama ('bi'), Breton ('br'), katalanska ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Korsikan ('co'), Krimtatar - latinsk skrift('crh''), Cornish ('kw'), Korsikan ('co'), Krimtatar - latinsk skrift('crh''), ), tjeckiska ('cs'), danska ('da'), nederländska ('nl'), engelska ('en'), estniska ('et'), fijianska ('fj'), filippinska ('fil'), finska ('fi'), franska ('fr'), friuliska ('fur'), galiciska ('gl'), tyska ('de'), Gilbertese ('gil'), Grönlandic ('kl'), Haitisk kreol ('ht'), Hani ('hni'), Hmong Daw ('mww'), ungerska ('hu'), indonesiska ('id'), Interlingua ('ia'), Inuktitut ('iu'), irländska ('ga'), italienska ('it'), japanska ('ja'), Javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'' ), Kara-Kalpak ('kaa'), Kashubian ('csb'), Khasi ('kha'), koreansk ('ko'), kurdisk - latinsk skrift ('ku'), K'iche' ('quc'), luxemburgsk ('lb'), malajiska ('ms'), Manx ('gv'), neapolitan ('nap'), norska ('nej'), Occitan ('oc'), polska ('pl'), Portugisiska ('pt'), Romansh ('rm'), skottar ('sco'), skotsk gaeliska ('gd'), förenklad kinesiska ('zh-Hans'), slovenska ('sl'), spanska ('es'), Swahili ('sw'), svenska ('sv'), tatar - latinsk skrift ('tt'), Tetum ('tet'), traditionell kinesiska ('zh-Hant'), turkiska ('tr'), Upper Sorbian ('hsb'), Uzbek ('uz'), Volapük ('vo'), Walser ('wae'), Western Frisian ('fy'), Yucatec Maya ('yua'), Zhuang ('za') och Zulu ('zu') stöds (skriv ut – sjuttiotre språk och handskrivna – endast engelska). Layout stöder automatisk språkidentifiering och dokument med flera språk, så ange bara en språkkod om du vill tvinga den dokumenterade att bearbetas som det specifika språket.
ReadingOrder	Läsordningsalgoritm för att sortera de returnerade textraderna. Läsordrar som stöds är: basic(default), natural.
SourcePath	Uri eller lokal sökväg till källdata.

ErrorInformation

Objekt

Name	Typ	Description
code	string
message	string

ErrorResponse

Objekt

Name	Typ	Description
error	ErrorInformation

Language

Uppräkning

För närvarande endast afrikaaner ('af'), albanska ('sq'), asturiska ('ast'), baskiska ('eu'), Bislama ('bi'), Breton ('br'), katalanska ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Korsikan ('co'), Krimtatar - latinsk skrift('crh''), Cornish ('kw'), Korsikan ('co'), Krimtatar - latinsk skrift('crh''), ), tjeckiska ('cs'), danska ('da'), nederländska ('nl'), engelska ('en'), estniska ('et'), fijianska ('fj'), filippinska ('fil'), finska ('fi'), franska ('fr'), friuliska ('fur'), galiciska ('gl'), tyska ('de'), Gilbertese ('gil'), Grönlandic ('kl'), Haitisk kreol ('ht'), Hani ('hni'), Hmong Daw ('mww'), ungerska ('hu'), indonesiska ('id'), Interlingua ('ia'), Inuktitut ('iu'), irländska ('ga'), italienska ('it'), japanska ('ja'), Javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'' ), Kara-Kalpak ('kaa'), Kashubian ('csb'), Khasi ('kha'), koreansk ('ko'), kurdisk - latinsk skrift ('ku'), K'iche' ('quc'), luxemburgsk ('lb'), malajiska ('ms'), Manx ('gv'), neapolitan ('nap'), norska ('nej'), Occitan ('oc'), polska ('pl'), Portugisiska ('pt'), Romansh ('rm'), skottar ('sco'), skotsk gaeliska ('gd'), förenklad kinesiska ('zh-Hans'), slovenska ('sl'), spanska ('es'), Swahili ('sw'), svenska ('sv'), tatar - latinsk skrift ('tt'), Tetum ('tet'), traditionell kinesiska ('zh-Hant'), turkiska ('tr'), Upper Sorbian ('hsb'), Uzbek ('uz'), Volapük ('vo'), Walser ('wae'), Western Frisian ('fy'), Yucatec Maya ('yua'), Zhuang ('za') och Zulu ('zu') stöds (skriv ut – sjuttiotre språk och handskrivna – endast engelska). Layout stöder automatisk språkidentifiering och dokument med flera språk, så ange bara en språkkod om du vill tvinga den dokumenterade att bearbetas som det specifika språket.

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

ReadingOrder

Uppräkning

Läsordningsalgoritm för att sortera de returnerade textraderna. Läsordrar som stöds är: basic(default), natural.

Värde	Description
basic
natural

SourcePath

Objekt

Uri eller lokal sökväg till källdata.

Name	Typ	Description
source	string minLength: 0 maxLength: 2048	Sökväg till filkälla.