Analyzer - Analyze Layout

服務:

Azure AI Services

API 版本:

2.1

擷取指定文件的文字和版面配置資訊。 輸入文件必須是其中一種支援的內容類型 ：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。 或者，使用 'application/json' 類型來指定要分析的檔位置 (URI 或本機路徑) 。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus2.api.cognitive.microsoft.com) 。
language	query		Language	目前只有 Afrikaans ('af') 、 ('sq') 、Asturian ('ast') 、Basque ('eu') 、Bislama ('bi') 、Breton ('br') 、 卡達尼亞文 ('ca') 、Cebuano ('ceb') 、Chamorro ('ch') 、 ('kw') 、Corsican ('co') 、Crimean Tatar - Latin script ('crh') 、捷克 ('cs') 、 丹麥文 ('da') 、荷蘭文 ('nl') 、英文 ('en') 、愛沙尼亞文 ('et') 、 ('fj') 、 ('fil') 、芬蘭文 ('fi') 、 法文 ('fr') 、Friulian ('fur') 、Galician ('gl') 、德文 ('de') 、Gilbertese ('gil') 、Greenlandic ('kl') 、 ('ht') 、 Hani ('hni') 、Hmong Daw (') 、匈牙利文 ('hu') 、印尼文 ('id') 、Interlingua ('ia') 、Inuktitut ('iu') 、 ('ga') 、 義大利文 ('it') 、Japanese ('ja'ja') 、Javanese ('jv') 、Kabuver ('kea') 、Kachin ('kac') 、Kara-Kalpak ('kaa') 、Kashubian ('csb') 、 Khasi (') ，韓文 ('ko') ，Kurdish - 拉丁腳本 ('ku') ，K'iche' ('quc') ， ('lb') ，馬來亞文 ('ms') ，Manx ('gv') ， Neapolitan ('nap') 、挪威文 ('no') 、Occitan ('oc') 、波蘭文 ('pl') 、葡萄牙文 ('pt') 、Romansh ('rm') 、Scots ('sco') 、 Scottish Gaelic (『gd』) ， 簡體中文 ('zh-Hans') 、斯洛維尼亞文 ('sl') 、西班牙文 ('es') 、Swahili ('sw') 、瑞典文 ('sv') 、Tatar - 拉丁腳本 ('tt') 、 Tetum ('tet') 、繁體中文 ('zh-Hant') 、土耳其文 ('tr') 、Upper ('hsb') 、Uzbek ('uz') 、Volapük ('vo') 、 Walser ('wae') 、Western Frisian ('fy') 、Yucatec Maya ('yua') 、 ('za') 和 Zulu ('zu') 都受到支援 (列印 – 七十三種語言和手寫 – 英文) 。 版面配置支援自動語言識別和多語言檔，因此如果您想要強制將記載的檔當成該特定語言處理，則只提供語言代碼。
pages	query		string[]	多頁檔的自定義頁碼 (PDF/TIFF) ，輸入您想要取得 OCR 結果的頁面數目。 對於某個範圍的頁面，請使用連字元。 以逗號分隔每個頁面或範圍。
readingOrder	query		ReadingOrder	讀取順序演算法，以排序傳回的文字行。 支持的閱讀順序包括：基本 (預設) ，自然。

要求標頭

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

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

要求本文

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

名稱	類型	Description
source	string	檔案來源路徑。

回應

名稱	類型	Description
202 Accepted		要求已順利排入佇列。 標題 Operation-Location: string
Other Status Codes	ErrorResponse	回應實體隨附的非成功回應，其中包含有關錯誤的其他詳細數據。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

Analyze layout

範例要求

HTTP

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

範例回覆

狀態碼:

202

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

定義

名稱	Description
ErrorInformation
ErrorResponse
Language	目前只有 Afrikaans ('af') 、 ('sq') 、Asturian ('ast') 、Basque ('eu') 、Bislama ('bi') 、Breton ('br') 、 卡達尼亞文 ('ca') 、Cebuano ('ceb') 、Chamorro ('ch') 、 ('kw') 、Corsican ('co') 、Crimean Tatar - Latin script ('crh') 、捷克 ('cs') 、 丹麥文 ('da') 、荷蘭文 ('nl') 、英文 ('en') 、愛沙尼亞文 ('et') 、 ('fj') 、 ('fil') 、芬蘭文 ('fi') 、 法文 ('fr') 、Friulian ('fur') 、Galician ('gl') 、德文 ('de') 、Gilbertese ('gil') 、Greenlandic ('kl') 、 ('ht') 、 Hani ('hni') 、Hmong Daw (') 、匈牙利文 ('hu') 、印尼文 ('id') 、Interlingua ('ia') 、Inuktitut ('iu') 、 ('ga') 、 義大利文 ('it') 、Japanese ('ja'ja') 、Javanese ('jv') 、Kabuver ('kea') 、Kachin ('kac') 、Kara-Kalpak ('kaa') 、Kashubian ('csb') 、 Khasi (') ，韓文 ('ko') ，Kurdish - 拉丁腳本 ('ku') ，K'iche' ('quc') ， ('lb') ，馬來亞文 ('ms') ，Manx ('gv') ， Neapolitan ('nap') 、挪威文 ('no') 、Occitan ('oc') 、波蘭文 ('pl') 、葡萄牙文 ('pt') 、Romansh ('rm') 、Scots ('sco') 、 Scottish Gaelic (『gd』) ， 簡體中文 ('zh-Hans') 、斯洛維尼亞文 ('sl') 、西班牙文 ('es') 、Swahili ('sw') 、瑞典文 ('sv') 、Tatar - 拉丁腳本 ('tt') 、 Tetum ('tet') 、繁體中文 ('zh-Hant') 、土耳其文 ('tr') 、Upper ('hsb') 、Uzbek ('uz') 、Volapük ('vo') 、 Walser ('wae') 、Western Frisian ('fy') 、Yucatec Maya ('yua') 、 ('za') 和 Zulu ('zu') 都受到支援 (列印 – 七十三種語言和手寫 – 英文) 。 版面配置支援自動語言識別和多語言檔，因此如果您想要強制將記載的檔當成該特定語言處理，則只提供語言代碼。
ReadingOrder	讀取順序演算法，以排序傳回的文字行。 支持的閱讀順序包括：基本 (預設) ，自然。
SourcePath	源數據的 URI 或本機路徑。

ErrorInformation

名稱	類型	Description
code	string
message	string

ErrorResponse

名稱	類型	Description
error	ErrorInformation

Language

目前只有 Afrikaans ('af') 、 ('sq') 、Asturian ('ast') 、Basque ('eu') 、Bislama ('bi') 、Breton ('br') 、 卡達尼亞文 ('ca') 、Cebuano ('ceb') 、Chamorro ('ch') 、 ('kw') 、Corsican ('co') 、Crimean Tatar - Latin script ('crh') 、捷克 ('cs') 、 丹麥文 ('da') 、荷蘭文 ('nl') 、英文 ('en') 、愛沙尼亞文 ('et') 、 ('fj') 、 ('fil') 、芬蘭文 ('fi') 、 法文 ('fr') 、Friulian ('fur') 、Galician ('gl') 、德文 ('de') 、Gilbertese ('gil') 、Greenlandic ('kl') 、 ('ht') 、 Hani ('hni') 、Hmong Daw (') 、匈牙利文 ('hu') 、印尼文 ('id') 、Interlingua ('ia') 、Inuktitut ('iu') 、 ('ga') 、 義大利文 ('it') 、Japanese ('ja'ja') 、Javanese ('jv') 、Kabuver ('kea') 、Kachin ('kac') 、Kara-Kalpak ('kaa') 、Kashubian ('csb') 、 Khasi (') ，韓文 ('ko') ，Kurdish - 拉丁腳本 ('ku') ，K'iche' ('quc') ， ('lb') ，馬來亞文 ('ms') ，Manx ('gv') ， Neapolitan ('nap') 、挪威文 ('no') 、Occitan ('oc') 、波蘭文 ('pl') 、葡萄牙文 ('pt') 、Romansh ('rm') 、Scots ('sco') 、 Scottish Gaelic (『gd』) ， 簡體中文 ('zh-Hans') 、斯洛維尼亞文 ('sl') 、西班牙文 ('es') 、Swahili ('sw') 、瑞典文 ('sv') 、Tatar - 拉丁腳本 ('tt') 、 Tetum ('tet') 、繁體中文 ('zh-Hant') 、土耳其文 ('tr') 、Upper ('hsb') 、Uzbek ('uz') 、Volapük ('vo') 、 Walser ('wae') 、Western Frisian ('fy') 、Yucatec Maya ('yua') 、 ('za') 和 Zulu ('zu') 都受到支援 (列印 – 七十三種語言和手寫 – 英文) 。 版面配置支援自動語言識別和多語言檔，因此如果您想要強制將記載的檔當成該特定語言處理，則只提供語言代碼。

名稱	類型	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

讀取順序演算法，以排序傳回的文字行。 支持的閱讀順序包括：基本 (預設) ，自然。

名稱	類型	Description
basic	string
natural	string

SourcePath

源數據的 URI 或本機路徑。

名稱	類型	Description
source	string	檔案來源路徑。