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 パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus2.api.cognitive.microsoft.com
language	query		Language	現在、 Afrikaans ('af')、アルバニア語 ('sq')、Asturian ('ast')、バスク語 ('eu')、ビスラマ ('bi')、ブレトン ('br')、カタロニア語 ('ca')、セブアーノ ('ceb')、チャモロ ('ch')、コーニッシュ ('kw')、クリマン タタール語 - ラテン文字 ('crh')、チェコ語 ('cs')、デンマーク語 ('da')、オランダ語 ('nl')、英語 ('en')、エストニア語 ('et')、フィジー語 ('fj')、フィリピン語 ('fil')、フィンランド語 ('fi')、フランス語 ('fr')、Friulian ('fur')、ガリシア語 ('gl')、ドイツ語 ('de')、ギルベルツェ語 ('gil')、グリーンランディク語 ('kl')、 Haitian Creole ('ht')、Hani ('hni')、Hmong Daw ('mww')、ハンガリー語 ('hu')、インドネシア語 ('id')、Interlingua ('ia')、Inuktitut ('iu')、アイルランド語 ('ga')、イタリア語 ('it')、日本語 ('ja')、Javanese ('jvm')、Kabuverdianu ('kea')、Kachin ('kac')、Kara-Kalpak ('kaa')、Kashubian ('csb')、Khasi ('kha')、韓国語 ('ko')、Kurdish - ラテン スクリプト ('ku')、K'iche' ('quc')、ルクセンブルク語 ('lb')、マレー語 ('ms')、Manx ('gv')、ネアポリタン ('nap')、ノルウェー語 ('no')、Occitan ('oc')、ポーランド語 ('pl') ポルトガル語 ('pt')、Romansh ('rm')、Scots ('sco')、Scottish Gaelic ('gd')、簡体字中国語 ('zh-Hans')、スロベニア語 ('sl')、スペイン語 ('es')、Swahili ('sw')、スウェーデン語 ('sv')、タタール語 - ラテン文字 ('tt')、Tetum ('tet')、繁体字中国語 ('zh-Hant')、繁体字中国語 ('zh-Hant') ')、トルコ語 ('tr')、Upper Sorbian ('hsb')、Uzbek ('uz')、Volapük ('vo')、Walser ('wae')、Western Frisian ('fy')、Yucatec Maya ('yua')、Zhuang ('za')、Zulu ('zu') はサポートされています (print – 73 言語と handwritten – English のみ)。 レイアウトでは、自動言語識別と多言語ドキュメントがサポートされているため、ドキュメントをその特定の言語として強制的に処理する場合にのみ言語コードを提供します。
pages	query		string[]	複数ページのドキュメントのカスタム ページ番号 (PDF/TIFF)、OCR 結果を取得するページの数を入力します。 ページの範囲には、ハイフンを使用します。 各ページまたは範囲をコンマで区切ります。
readingOrder	query		ReadingOrder	返されたテキスト行を並べ替える読み取り順序アルゴリズム。 サポートされている読み取り順序には、basic(default)、natural が含まれます。

要求ヘッダー

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

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string

要求本文

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

名前	型	説明
source	string	ファイル ソース のパス。

応答

名前	型	説明
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

定義

名前	説明
ErrorInformation
ErrorResponse
Language	現在、 Afrikaans ('af')、アルバニア語 ('sq')、Asturian ('ast')、バスク語 ('eu')、ビスラマ ('bi')、ブレトン ('br')、カタロニア語 ('ca')、セブアーノ ('ceb')、チャモロ ('ch')、コーニッシュ ('kw')、クリマン タタール語 - ラテン文字 ('crh')、チェコ語 ('cs')、デンマーク語 ('da')、オランダ語 ('nl')、英語 ('en')、エストニア語 ('et')、フィジー語 ('fj')、フィリピン語 ('fil')、フィンランド語 ('fi')、フランス語 ('fr')、Friulian ('fur')、ガリシア語 ('gl')、ドイツ語 ('de')、ギルベルツェ語 ('gil')、グリーンランディク語 ('kl')、 Haitian Creole ('ht')、Hani ('hni')、Hmong Daw ('mww')、ハンガリー語 ('hu')、インドネシア語 ('id')、Interlingua ('ia')、Inuktitut ('iu')、アイルランド語 ('ga')、イタリア語 ('it')、日本語 ('ja')、Javanese ('jvm')、Kabuverdianu ('kea')、Kachin ('kac')、Kara-Kalpak ('kaa')、Kashubian ('csb')、Khasi ('kha')、韓国語 ('ko')、Kurdish - ラテン スクリプト ('ku')、K'iche' ('quc')、ルクセンブルク語 ('lb')、マレー語 ('ms')、Manx ('gv')、ネアポリタン ('nap')、ノルウェー語 ('no')、Occitan ('oc')、ポーランド語 ('pl') ポルトガル語 ('pt')、Romansh ('rm')、Scots ('sco')、Scottish Gaelic ('gd')、簡体字中国語 ('zh-Hans')、スロベニア語 ('sl')、スペイン語 ('es')、Swahili ('sw')、スウェーデン語 ('sv')、タタール語 - ラテン文字 ('tt')、Tetum ('tet')、繁体字中国語 ('zh-Hant')、繁体字中国語 ('zh-Hant') ')、トルコ語 ('tr')、Upper Sorbian ('hsb')、Uzbek ('uz')、Volapük ('vo')、Walser ('wae')、Western Frisian ('fy')、Yucatec Maya ('yua')、Zhuang ('za')、Zulu ('zu') はサポートされています (print – 73 言語と handwritten – English のみ)。 レイアウトでは、自動言語識別と多言語ドキュメントがサポートされているため、ドキュメントをその特定の言語として強制的に処理する場合にのみ言語コードを提供します。
ReadingOrder	返されたテキスト行を並べ替える読み取り順序アルゴリズム。 サポートされている読み取り順序には、basic(default)、natural が含まれます。
SourcePath	ソース データへの URI またはローカル パス。

ErrorInformation

名前	型	説明
code	string
message	string

ErrorResponse

名前	型	説明
error	ErrorInformation

Language

現在、 Afrikaans ('af')、アルバニア語 ('sq')、Asturian ('ast')、バスク語 ('eu')、ビスラマ ('bi')、ブレトン ('br')、カタロニア語 ('ca')、セブアーノ ('ceb')、チャモロ ('ch')、コーニッシュ ('kw')、クリマン タタール語 - ラテン文字 ('crh')、チェコ語 ('cs')、デンマーク語 ('da')、オランダ語 ('nl')、英語 ('en')、エストニア語 ('et')、フィジー語 ('fj')、フィリピン語 ('fil')、フィンランド語 ('fi')、フランス語 ('fr')、Friulian ('fur')、ガリシア語 ('gl')、ドイツ語 ('de')、ギルベルツェ語 ('gil')、グリーンランディク語 ('kl')、 Haitian Creole ('ht')、Hani ('hni')、Hmong Daw ('mww')、ハンガリー語 ('hu')、インドネシア語 ('id')、Interlingua ('ia')、Inuktitut ('iu')、アイルランド語 ('ga')、イタリア語 ('it')、日本語 ('ja')、Javanese ('jvm')、Kabuverdianu ('kea')、Kachin ('kac')、Kara-Kalpak ('kaa')、Kashubian ('csb')、Khasi ('kha')、韓国語 ('ko')、Kurdish - ラテン スクリプト ('ku')、K'iche' ('quc')、ルクセンブルク語 ('lb')、マレー語 ('ms')、Manx ('gv')、ネアポリタン ('nap')、ノルウェー語 ('no')、Occitan ('oc')、ポーランド語 ('pl') ポルトガル語 ('pt')、Romansh ('rm')、Scots ('sco')、Scottish Gaelic ('gd')、簡体字中国語 ('zh-Hans')、スロベニア語 ('sl')、スペイン語 ('es')、Swahili ('sw')、スウェーデン語 ('sv')、タタール語 - ラテン文字 ('tt')、Tetum ('tet')、繁体字中国語 ('zh-Hant')、繁体字中国語 ('zh-Hant') ')、トルコ語 ('tr')、Upper Sorbian ('hsb')、Uzbek ('uz')、Volapük ('vo')、Walser ('wae')、Western Frisian ('fy')、Yucatec Maya ('yua')、Zhuang ('za')、Zulu ('zu') はサポートされています (print – 73 言語と handwritten – English のみ)。 レイアウトでは、自動言語識別と多言語ドキュメントがサポートされているため、ドキュメントをその特定の言語として強制的に処理する場合にのみ言語コードを提供します。

名前	型	説明
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

返されたテキスト行を並べ替える読み取り順序アルゴリズム。 サポートされている読み取り順序には、basic(default)、natural が含まれます。

名前	型	説明
basic	string
natural	string

SourcePath

ソース データへの URI またはローカル パス。

名前	型	説明
source	string	ファイル ソース のパス。