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	目前， 只有非洲人（'af'）、阿爾巴尼亞文（'sq'）、阿圖裡安（'ast'）、巴斯克（'eu'）、比斯拉馬（'bi'）、布雷頓（'br'）、加泰羅尼亞文（'ca'）、塞布亞諾（'ceb'）、查莫羅（'ch'）、科西坎（'co'）、克里米亞塔塔爾 - 拉丁劇本（'crh'）， 捷克文（'cs'）、丹麥文（'da'）、荷蘭文（'nl'）、英文（'en'）、愛沙尼亞文（'et'）、斐濟文（'fj'）、菲律賓文（'fil'）、芬蘭文（'fi'）、法文（'fr'）、弗里聯（'毛'）、加利西亞文（'gl'）、德文（'德'）、吉伯特文（'吉爾'）、格陵蘭迪克文（'kl'）、 海地克里奧爾（'ht'）、哈尼（'hni'）、Hmong Daw（'兆瓦'）、匈牙利文（'胡'）、印尼文（'id'）、國際語（'ia'）、因努特（'iu'）、愛爾蘭文（'ga'）、義大利文（'it'）、日本（'ja'）、爪哇人（'jv'）、卡布韋迪亞努（'kea'）、卡欽（'kac'）、 Kara-Kalpak（'kaa'）、卡舒比安（'csb'）、卡西（'kha'）、韓文（'ko'）、庫爾德文 - 拉丁腳本（'ku'）、K'iche'（'quc'）、盧森堡文（'lb'）、馬來語（'ms'）、馬來語（'gv'）、尼波利坦（'nap'）、挪威文（'no'）、奧西坦（'oc'）、波蘭文（'pl'）、 葡萄牙文（'pt'）、羅曼什（'rm'）、蘇格蘭人（'sco'）、蘇格蘭蓋爾文（'gd'）、簡體中文（'zh-漢斯'）、斯洛維尼亞文（'sl'）、西班牙文（'es'）、斯瓦希利（'sw'）、瑞典文（'sv'）、塔塔爾 - 拉丁腳本（'tt'）、泰圖姆（'tet'）、繁體中文（'zh-漢特'）、 土耳其文（'tr'）、上索比安（'hsb'）、烏茲別克（'烏茲'）、沃拉普克（'vo'）、沃爾瑟（'wae'）、西弗里西亞（'fy'）、尤卡泰克·瑪雅（'yua'）、莊（'za'）和祖魯（'祖'）都受到支援（印刷-七十三種語言和手寫-僅限英文）。 版面配置支援自動語言識別和多語言檔，因此如果您想要強制將記載的文件強制為該特定語言，則只提供語言代碼。
pages	query		string[]	多頁檔的自定義頁碼（PDF/TIFF），輸入您想要取得 OCR 結果的頁面數目。 針對頁面範圍，請使用連字元。 以逗號分隔每個頁面或範圍。
readingOrder	query		ReadingOrder	讀取順序演算法來排序傳回的文字行。 支持的閱讀順序包括：basic（default），自然。

要求標頭

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 minLength: 0 maxLength: 2048	檔案來源路徑。

回應

名稱	類型	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	目前， 只有非洲人（'af'）、阿爾巴尼亞文（'sq'）、阿圖裡安（'ast'）、巴斯克（'eu'）、比斯拉馬（'bi'）、布雷頓（'br'）、加泰羅尼亞文（'ca'）、塞布亞諾（'ceb'）、查莫羅（'ch'）、科西坎（'co'）、克里米亞塔塔爾 - 拉丁劇本（'crh'）， 捷克文（'cs'）、丹麥文（'da'）、荷蘭文（'nl'）、英文（'en'）、愛沙尼亞文（'et'）、斐濟文（'fj'）、菲律賓文（'fil'）、芬蘭文（'fi'）、法文（'fr'）、弗里聯（'毛'）、加利西亞文（'gl'）、德文（'德'）、吉伯特文（'吉爾'）、格陵蘭迪克文（'kl'）、 海地克里奧爾（'ht'）、哈尼（'hni'）、Hmong Daw（'兆瓦'）、匈牙利文（'胡'）、印尼文（'id'）、國際語（'ia'）、因努特（'iu'）、愛爾蘭文（'ga'）、義大利文（'it'）、日本（'ja'）、爪哇人（'jv'）、卡布韋迪亞努（'kea'）、卡欽（'kac'）、 Kara-Kalpak（'kaa'）、卡舒比安（'csb'）、卡西（'kha'）、韓文（'ko'）、庫爾德文 - 拉丁腳本（'ku'）、K'iche'（'quc'）、盧森堡文（'lb'）、馬來語（'ms'）、馬來語（'gv'）、尼波利坦（'nap'）、挪威文（'no'）、奧西坦（'oc'）、波蘭文（'pl'）、 葡萄牙文（'pt'）、羅曼什（'rm'）、蘇格蘭人（'sco'）、蘇格蘭蓋爾文（'gd'）、簡體中文（'zh-漢斯'）、斯洛維尼亞文（'sl'）、西班牙文（'es'）、斯瓦希利（'sw'）、瑞典文（'sv'）、塔塔爾 - 拉丁腳本（'tt'）、泰圖姆（'tet'）、繁體中文（'zh-漢特'）、 土耳其文（'tr'）、上索比安（'hsb'）、烏茲別克（'烏茲'）、沃拉普克（'vo'）、沃爾瑟（'wae'）、西弗里西亞（'fy'）、尤卡泰克·瑪雅（'yua'）、莊（'za'）和祖魯（'祖'）都受到支援（印刷-七十三種語言和手寫-僅限英文）。 版面配置支援自動語言識別和多語言檔，因此如果您想要強制將記載的文件強制為該特定語言，則只提供語言代碼。
ReadingOrder	讀取順序演算法來排序傳回的文字行。 支持的閱讀順序包括：basic（default），自然。
SourcePath	源數據的 URI 或本機路徑。

ErrorInformation

Object

名稱	類型	Description
code	string
message	string

ErrorResponse

Object

名稱	類型	Description
error	ErrorInformation

Language

列舉型別

目前， 只有非洲人（'af'）、阿爾巴尼亞文（'sq'）、阿圖裡安（'ast'）、巴斯克（'eu'）、比斯拉馬（'bi'）、布雷頓（'br'）、加泰羅尼亞文（'ca'）、塞布亞諾（'ceb'）、查莫羅（'ch'）、科西坎（'co'）、克里米亞塔塔爾 - 拉丁劇本（'crh'）， 捷克文（'cs'）、丹麥文（'da'）、荷蘭文（'nl'）、英文（'en'）、愛沙尼亞文（'et'）、斐濟文（'fj'）、菲律賓文（'fil'）、芬蘭文（'fi'）、法文（'fr'）、弗里聯（'毛'）、加利西亞文（'gl'）、德文（'德'）、吉伯特文（'吉爾'）、格陵蘭迪克文（'kl'）、 海地克里奧爾（'ht'）、哈尼（'hni'）、Hmong Daw（'兆瓦'）、匈牙利文（'胡'）、印尼文（'id'）、國際語（'ia'）、因努特（'iu'）、愛爾蘭文（'ga'）、義大利文（'it'）、日本（'ja'）、爪哇人（'jv'）、卡布韋迪亞努（'kea'）、卡欽（'kac'）、 Kara-Kalpak（'kaa'）、卡舒比安（'csb'）、卡西（'kha'）、韓文（'ko'）、庫爾德文 - 拉丁腳本（'ku'）、K'iche'（'quc'）、盧森堡文（'lb'）、馬來語（'ms'）、馬來語（'gv'）、尼波利坦（'nap'）、挪威文（'no'）、奧西坦（'oc'）、波蘭文（'pl'）、 葡萄牙文（'pt'）、羅曼什（'rm'）、蘇格蘭人（'sco'）、蘇格蘭蓋爾文（'gd'）、簡體中文（'zh-漢斯'）、斯洛維尼亞文（'sl'）、西班牙文（'es'）、斯瓦希利（'sw'）、瑞典文（'sv'）、塔塔爾 - 拉丁腳本（'tt'）、泰圖姆（'tet'）、繁體中文（'zh-漢特'）、 土耳其文（'tr'）、上索比安（'hsb'）、烏茲別克（'烏茲'）、沃拉普克（'vo'）、沃爾瑟（'wae'）、西弗里西亞（'fy'）、尤卡泰克·瑪雅（'yua'）、莊（'za'）和祖魯（'祖'）都受到支援（印刷-七十三種語言和手寫-僅限英文）。 版面配置支援自動語言識別和多語言檔，因此如果您想要強制將記載的文件強制為該特定語言，則只提供語言代碼。

值	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

列舉型別

讀取順序演算法來排序傳回的文字行。 支持的閱讀順序包括：basic（default），自然。

值	Description
basic
natural

SourcePath

Object

源數據的 URI 或本機路徑。

名稱	類型	Description
source	string minLength: 0 maxLength: 2048	檔案來源路徑。