Analyzer - Analyze Layout

Service:

Azure AI Services

API Version:

2.1

Wyodrębnianie informacji o tekście i układzie z danego dokumentu. Dokument wejściowy musi być jednym z obsługiwanych typów zawartości — "application/pdf", "image/jpeg", "image/png", "image/tiff" lub "image/bmp". Alternatywnie użyj typu "application/json", aby określić lokalizację (identyfikator URI lub ścieżkę lokalną) dokumentu do przeanalizowania.

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

With optional parameters:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus2.api.cognitive.microsoft.com).
language	query		Language	Obecnie only Afrikaans ('af'), Albańczyk ('sq'), Asturian ('ast'), Basque ('eu'), Bislama ('bi'), Breton ('br'), Kataloński ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Corsican ('co'), Krymski Tatar - skrypt łaciński('crh')), Czeski ('cs'), Duński ('da'), Holenderski ('nl'), Angielski ('en'), Estoński ('et'), Fidżian ('fj'), Filipino ('fil'), Fiński ('fi'), Francuski ('fr'), Friulian ('fur'), Galicyjczyk ('gl'), Niemiecki ('de'), Gilbertese ('gil'), Grenlandiczny ('kl'), Haitian Creole ('ht'), Hani ('hni'), Hmong Daw ('mww'), węgierski ('hu'), indonezyjski ('id'), Interulat ('ia'), Inuktitut ('iu'), irlandzki ('ga'), włoski ('it'), japoński ('ja'), Javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kaszhubian ('csb'), Khasi ('kha'), Koreański ('ko'), Kurdyjski - łaciński skrypt ('ku'), K'iche' ('quc'), Luksemburski ('lb'), Malay ('ms'), Manx ('gv'), Neapolitan ('nap'), Norweski ('no'), Occitan ('oc'), Polski ('pl'), Portugalski ('pt'), Romansh ('rm'), Szkoci ('sco'), Scottish Gaelic ('gd'), uproszczony chiński ('zh-Hans'), słowenijski ('sl'), hiszpański ('es'), suahili ('sw'), szwedzki ('sv'), tatar - łaciński skrypt ('tt'), Tetum ('tet'), tradycyjny chiński ('zh-Dur') '), turecki ('tr'), Górny Sorbiański ('hsb'), Uzbek ('uz'), Volapük ('vo'), Walser ('wae'), Western Frisian ('fy'), Yucatec Maya ('yua'), Beck ('za') i Zulu ('zu') są obsługiwane (drukuj – siedemdziesiąt trzy języki i odręczne ). Układ obsługuje automatyczną identyfikację języka i dokumenty w wielu językach, dlatego podaj tylko kod języka, jeśli chcesz wymusić przetworzenie udokumentowanego języka jako określonego języka.
pages	query		string[]	Niestandardowe numery stron dla dokumentów wielostronicowych (PDF/TIFF), wprowadź liczbę stron, które chcesz uzyskać wynik OCR. W przypadku zakresu stron użyj łącznika. Oddziel każdą stronę lub zakres przecinkiem.
readingOrder	query		ReadingOrder	Algorytm kolejności odczytywania w celu sortowania zwracanych wierszy tekstu. Obsługiwane zamówienia odczytu obejmują: basic(default), natural.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Treść żądania

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

Nazwa	Typ	Opis
source	string	Ścieżka źródła pliku.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało pomyślnie w kolejce. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Jednostka odpowiedzi towarzysząca nieudanych odpowiedzi zawierających dodatkowe szczegóły dotyczące błędu.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Przykłady

Analyze layout

Sample Request

HTTP

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

Sample Response

Status code:

202

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

Definicje

Nazwa	Opis
ErrorInformation
ErrorResponse
Language	Obecnie only Afrikaans ('af'), Albańczyk ('sq'), Asturian ('ast'), Basque ('eu'), Bislama ('bi'), Breton ('br'), Kataloński ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Corsican ('co'), Krymski Tatar - skrypt łaciński('crh')), Czeski ('cs'), Duński ('da'), Holenderski ('nl'), Angielski ('en'), Estoński ('et'), Fidżian ('fj'), Filipino ('fil'), Fiński ('fi'), Francuski ('fr'), Friulian ('fur'), Galicyjczyk ('gl'), Niemiecki ('de'), Gilbertese ('gil'), Grenlandiczny ('kl'), Haitian Creole ('ht'), Hani ('hni'), Hmong Daw ('mww'), węgierski ('hu'), indonezyjski ('id'), Interulat ('ia'), Inuktitut ('iu'), irlandzki ('ga'), włoski ('it'), japoński ('ja'), Javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kaszhubian ('csb'), Khasi ('kha'), Koreański ('ko'), Kurdyjski - łaciński skrypt ('ku'), K'iche' ('quc'), Luksemburski ('lb'), Malay ('ms'), Manx ('gv'), Neapolitan ('nap'), Norweski ('no'), Occitan ('oc'), Polski ('pl'), Portugalski ('pt'), Romansh ('rm'), Szkoci ('sco'), Scottish Gaelic ('gd'), uproszczony chiński ('zh-Hans'), słowenijski ('sl'), hiszpański ('es'), suahili ('sw'), szwedzki ('sv'), tatar - łaciński skrypt ('tt'), Tetum ('tet'), tradycyjny chiński ('zh-Dur') '), turecki ('tr'), Górny Sorbiański ('hsb'), Uzbek ('uz'), Volapük ('vo'), Walser ('wae'), Western Frisian ('fy'), Yucatec Maya ('yua'), Beck ('za') i Zulu ('zu') są obsługiwane (drukuj – siedemdziesiąt trzy języki i odręczne ). Układ obsługuje automatyczną identyfikację języka i dokumenty w wielu językach, dlatego podaj tylko kod języka, jeśli chcesz wymusić przetworzenie udokumentowanego języka jako określonego języka.
ReadingOrder	Algorytm kolejności odczytywania w celu sortowania zwracanych wierszy tekstu. Obsługiwane zamówienia odczytu obejmują: basic(default), natural.
SourcePath	Identyfikator URI lub ścieżka lokalna do danych źródłowych.

ErrorInformation

Nazwa	Typ	Opis
code	string
message	string

ErrorResponse

Nazwa	Typ	Opis
error	ErrorInformation

Language

Obecnie only Afrikaans ('af'), Albańczyk ('sq'), Asturian ('ast'), Basque ('eu'), Bislama ('bi'), Breton ('br'), Kataloński ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Corsican ('co'), Krymski Tatar - skrypt łaciński('crh')), Czeski ('cs'), Duński ('da'), Holenderski ('nl'), Angielski ('en'), Estoński ('et'), Fidżian ('fj'), Filipino ('fil'), Fiński ('fi'), Francuski ('fr'), Friulian ('fur'), Galicyjczyk ('gl'), Niemiecki ('de'), Gilbertese ('gil'), Grenlandiczny ('kl'), Haitian Creole ('ht'), Hani ('hni'), Hmong Daw ('mww'), węgierski ('hu'), indonezyjski ('id'), Interulat ('ia'), Inuktitut ('iu'), irlandzki ('ga'), włoski ('it'), japoński ('ja'), Javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kaszhubian ('csb'), Khasi ('kha'), Koreański ('ko'), Kurdyjski - łaciński skrypt ('ku'), K'iche' ('quc'), Luksemburski ('lb'), Malay ('ms'), Manx ('gv'), Neapolitan ('nap'), Norweski ('no'), Occitan ('oc'), Polski ('pl'), Portugalski ('pt'), Romansh ('rm'), Szkoci ('sco'), Scottish Gaelic ('gd'), uproszczony chiński ('zh-Hans'), słowenijski ('sl'), hiszpański ('es'), suahili ('sw'), szwedzki ('sv'), tatar - łaciński skrypt ('tt'), Tetum ('tet'), tradycyjny chiński ('zh-Dur') '), turecki ('tr'), Górny Sorbiański ('hsb'), Uzbek ('uz'), Volapük ('vo'), Walser ('wae'), Western Frisian ('fy'), Yucatec Maya ('yua'), Beck ('za') i Zulu ('zu') są obsługiwane (drukuj – siedemdziesiąt trzy języki i odręczne ). Układ obsługuje automatyczną identyfikację języka i dokumenty w wielu językach, dlatego podaj tylko kod języka, jeśli chcesz wymusić przetworzenie udokumentowanego języka jako określonego języka.

Nazwa	Typ	Opis
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

Algorytm kolejności odczytywania w celu sortowania zwracanych wierszy tekstu. Obsługiwane zamówienia odczytu obejmują: basic(default), natural.

Nazwa	Typ	Opis
basic	string
natural	string

SourcePath

Identyfikator URI lub ścieżka lokalna do danych źródłowych.

Nazwa	Typ	Opis
source	string	Ścieżka źródła pliku.