Form Recognizer
トレーニング済みモデル (レイアウト、請求書、領収書、ID、ビジネス カード) や、一連の代表的なトレーニング フォームで作成したカスタム モデルに基づき、AI を活用してドキュメントを理解しながら、PDF または画像のドキュメントとフォームから、テキスト (印刷および手書きの OCR) と追加情報 (テーブル、チェックボックス、フィールド/キー値ペア) を抽出して構造化したデータにまとめます。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - 米国国防総省 (DoD) |
| Power Automate | Standard | 以下を除くすべての Power Automate 地域 : - 米国国防総省 (DoD) |
| Power Apps | - | 該当なし |
| お問い合わせ先 | |
|---|---|
| 件名 | マイクロソフト |
| [URL] | https://aka.ms/formrecognizer |
| メール | formrecog_contact@microsoft.com |
| Connector Metadata | |
|---|---|
| 発行者 | マイクロソフト |
| Web サイト | https://aka.ms/formrecognizer |
| プライバシー ポリシー | https://aka.ms/form-recognizer/privacy |
| カテゴリ | AI; ビジネス インテリジェンス |
Form Recognizer コネクタは、Cognitive Service Form Recognizer への統合を提供します。 フォーム、請求書、領収書、名刺、ID ドキュメントなどから情報を分析および抽出することができます。
前提条件
この統合を使用するには、Azure portal の Cognitive Service Form Recognizer リソースが必要です。 リソース リンクの作成。 エンドポイントとアプリケーションを認証するためのキーを取得します。 接続するには、アカウント キーとサイトの URL を入力し、接続の作成を選択します。 接続の運用コストについては、ここで詳細を確認してください。
資格情報の入手方法
- Azure portal で Form Recognizer リソースを開きます ([前提条件] を参照)。
- リソース管理の下にあるキーとエンドポイントを選択します
- エンドポイントとキーをコピーし、それらを使用して新しい接続を作成します。
コネクタの使用を開始する
Form Recognizer コネクタを試す最も簡単な方法は、事前構築済みモデル (請求書、領収書、名刺、または ID ドキュメントの分析) を使用することです。 ドキュメントの PDF または画像を提供します。 ドキュメントの種類に基づき、コネクタ操作を使用して分析し、検出されたフィールドを検査します。
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 内容 | 必要 |
|---|---|---|---|
| アカウント キー | securestring | Form Recognizer アカウント キー | 真 |
| エンドポイント URL | 文字列 | Form Recognizer エンドポイント URL (例 : https://your-formrecognizer-resource.cognitiveservices.azure.com/) | 真 |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| ID ドキュメントの分析 |
指定した ID ドキュメントからフィールド テキストとセマンティック値を抽出します。 |
| カスタム フォームの分析 |
指定したドキュメントから、キーと値のペア、テーブル、セマンティック値を抽出します。 |
| ドキュメント分類子でドキュメントを分類する (v3.1 API) |
ドキュメント分類子でドキュメントを分類します (v3.1 API)。 |
| レイアウトの分析 |
指定したドキュメントからテキストとレイアウト情報を抽出します。 |
| 事前ビルドまたはカスタム モデル用のドキュメント分析 (v3.x API) |
指定したドキュメントから、キーと値のペア、テーブル、セマンティック値を抽出します (v3.x API)。 |
| 名刺の分析 |
指定した名刺ドキュメントからフィールド テキストとセマンティック値を抽出します。 |
| 請求書の分析 |
指定した請求書ドキュメントからフィールド テキストとセマンティック値を抽出します。 |
| 領収書の分析 |
指定した領収書ドキュメントからフィールド テキストとセマンティック値を抽出します。 |
ID ドキュメントの分析
指定した ID ドキュメントからフィールド テキストとセマンティック値を抽出します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキストの詳細を含める
|
includeTextDetails | boolean |
テキスト行と要素参照を結果に含めます。 デフォルト : True (FR コネクタの場合のみ)。 |
|
|
ページ
|
pages | string |
複数ページにわたる PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力することで (例 '2, 5-7')、個別のページやページの範囲 (ページ 2 とページ 5-7 のように) から請求書情報を抽出します。 設定しない場合は、すべてのページを処理します。 |
|
|
ドキュメント/画像のファイル コンテンツ
|
inputFileContent | binary |
分析する PDF ドキュメントまたは画像 (JPG または PNG) ファイルです。 |
|
|
ドキュメント/画像の URL
|
inputFileUrl | string |
入力ファイル用の URL パス。 ドキュメント/画像ファイル コンテンツの代替。 |
戻り値
キュー登録済み分析操作の状態と結果。
カスタム フォームの分析
指定したドキュメントから、キーと値のペア、テーブル、セマンティック値を抽出します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モデル識別子
|
modelId | True | string |
形式 - uuid。 モデル識別子。 |
|
テキストの詳細を含める
|
includeTextDetails | boolean |
テキスト行と要素参照を結果に含めます。 デフォルト : True (FR コネクタの場合のみ)。 |
|
|
ページ
|
pages | string |
複数ページにわたる PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力することで (例 '2, 5-7')、個別のページやページの範囲 (ページ 2 とページ 5-7 のように) から請求書情報を抽出します。 設定しない場合は、すべてのページを処理します。 |
|
|
ドキュメント/画像のファイル コンテンツ
|
inputFileContent | binary |
分析する PDF ドキュメントまたは画像 (JPG または PNG) ファイルです。 |
|
|
ドキュメント/画像の URL
|
inputFileUrl | string |
入力ファイル用の URL パス。 ドキュメント/画像ファイル コンテンツの代替。 |
戻り値
キュー登録済み分析操作の状態と結果。
ドキュメント分類子でドキュメントを分類する (v3.1 API)
ドキュメント分類子でドキュメントを分類します (v3.1 API)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
分類子識別子
|
classifierId | True | string |
形式 - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}。 一意の分類子名。 |
|
Pages
|
pages | string |
複数ページにわたる PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力することで (例「2, 5-7」)、個別のページやページの範囲 (ページ 2 とページ 5-7 のように) から情報を抽出します。 設定しない場合は、すべてのページを処理します。 |
|
|
Locale
|
locale | string |
テキスト認識と文書分析のためのロケールヒント。 値には言語コードのみを含めることができます (例: "en"、"fr") または BCP 47 言語タグ (例: "en-US"). |
|
|
文字列インデックス タイプ
|
stringIndexType | string |
文字列のオフセットと長さの計算に使用されるメソッドです。 サポートされているオプション: textElements、unicodeCodePoint、utf16CodeUnit。 |
|
|
ドキュメント/画像のファイル コンテンツ
|
inputFileContent | binary |
分析する PDF ドキュメントまたは画像 (JPG、PNG、BMP、TIFF) ファイルです。 |
|
|
ドキュメント/画像の URL
|
inputFileUrl | string |
入力ファイル用の URL パス。 ドキュメント/画像ファイル コンテンツの代替。 |
戻り値
分析操作の状態と結果です。
レイアウトの分析
指定したドキュメントからテキストとレイアウト情報を抽出します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
pages | string |
複数ページにわたる PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力することで (例 '2, 5-7')、個別のページやページの範囲 (ページ 2 とページ 5-7 のように) から請求書情報を抽出します。 設定しない場合は、すべてのページを処理します。 |
|
|
言語
|
language | string |
ドキュメントが含むテキストの BCP-47 言語コード。 |
|
|
読み取り順序
|
readingOrder | string |
テキスト要素の抽出を処理する際に適用する、読み取り順序アルゴリズムを指定するオプションのパラメーター。 '基本' または '自然' のどちらかになります。 指定しない場合、デフォルトで基本になります。 |
|
|
ドキュメント/画像のファイル コンテンツ
|
inputFileContent | binary |
分析する PDF ドキュメントまたは画像 (JPG または PNG) ファイルです。 |
|
|
ドキュメント/画像の URL
|
inputFileUrl | string |
入力ファイル用の URL パス。 ドキュメント/画像ファイル コンテンツの代替。 |
戻り値
キュー登録済み分析操作の状態と結果。
事前ビルドまたはカスタム モデル用のドキュメント分析 (v3.x API)
指定したドキュメントから、キーと値のペア、テーブル、セマンティック値を抽出します (v3.x API)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Form Recognizer API のバージョン
|
api-version | True | string |
Form Recognizer API のバージョンです。 |
|
モデル識別子
|
modelId | True | string |
事前構築済みモデル: prebuilt-read、prebuilt-layout、prebuilt-document、prebuilt-businessCard、prebuilt-idDocument、prebuilt-invoice、prebuilt-receipt、prebuilt-tax.us.w2、prebuilt-vaccinationCard、prebuilt-healthInsuranceCard.us。 カスタム modelId 形式 - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. 一意のモデル名です。 |
|
Pages
|
pages | string |
複数ページにわたる PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力することで (例 '2, 5-7')、個別のページやページの範囲 (ページ 2 とページ 5-7 のように) から請求書情報を抽出します。 設定しない場合は、すべてのページを処理します。 |
|
|
Locale
|
locale | string |
テキスト認識と文書分析のためのロケールヒント。 値には言語コードのみを含めることができます (例: "en"、"fr") または BCP 47 言語タグ (例: "en-US"). |
|
|
文字列インデックス タイプ
|
stringIndexType | string |
文字列のオフセットと長さの計算に使用されるメソッドです。 サポートされているオプション: textElements、unicodeCodePoint、utf16CodeUnit。 |
|
|
オプションとプレミアムの機能
|
features | array |
オプションの分析機能の一覧です (ocrHighResolution、languages、barcodes, formulas、keyValuePairs、styleFont など)。 |
|
|
ドキュメント/画像のファイル コンテンツ
|
inputFileContent | binary |
分析する PDF ドキュメントまたは画像 (JPG、PNG、BMP、TIFF) ファイルです。 |
|
|
ドキュメント/画像の URL
|
inputFileUrl | string |
入力ファイル用の URL パス。 ドキュメント/画像ファイル コンテンツの代替。 |
戻り値
分析操作の状態と結果です。
名刺の分析
指定した名刺ドキュメントからフィールド テキストとセマンティック値を抽出します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキストの詳細を含める
|
includeTextDetails | boolean |
テキスト行と要素参照を結果に含めます。 デフォルト : True (FR コネクタの場合のみ)。 |
|
|
ページ
|
pages | string |
複数ページにわたる PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力することで (例 '2, 5-7')、個別のページやページの範囲 (ページ 2 とページ 5-7 のように) から請求書情報を抽出します。 設定しない場合は、すべてのページを処理します。 |
|
|
ロケール
|
locale | string |
請求書のロケールです。 サポートされているロケールは次のとおりです: en-US。 |
|
|
ドキュメント/画像のファイル コンテンツ
|
inputFileContent | binary |
分析する PDF ドキュメントまたは画像 (JPG または PNG) ファイルです。 |
|
|
ドキュメント/画像の URL
|
inputFileUrl | string |
入力ファイル用の URL パス。 ドキュメント/画像ファイル コンテンツの代替。 |
戻り値
キュー登録済み分析操作の状態と結果。
請求書の分析
指定した請求書ドキュメントからフィールド テキストとセマンティック値を抽出します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキストの詳細を含める
|
includeTextDetails | boolean |
テキスト行と要素参照を結果に含めます。 デフォルト : True (FR コネクタの場合のみ)。 |
|
|
ページ
|
pages | string |
複数ページにわたる PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力することで (例 '2, 5-7')、個別のページやページの範囲 (ページ 2 とページ 5-7 のように) から請求書情報を抽出します。 設定しない場合は、すべてのページを処理します。 |
|
|
ロケール
|
locale | string |
請求書のロケールです。 サポートされているロケールは次のとおりです: en-US。 |
|
|
ドキュメント/画像のファイル コンテンツ
|
inputFileContent | binary |
分析する PDF ドキュメントまたは画像 (JPG または PNG) ファイルです。 |
|
|
ドキュメント/画像の URL
|
inputFileUrl | string |
入力ファイル用の URL パス。 ドキュメント/画像ファイル コンテンツの代替。 |
戻り値
キュー登録済み分析操作の状態と結果。
領収書の分析
指定した領収書ドキュメントからフィールド テキストとセマンティック値を抽出します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキストの詳細を含める
|
includeTextDetails | boolean |
テキスト行と要素参照を結果に含めます。 デフォルト : True (FR コネクタの場合のみ)。 |
|
|
ページ
|
pages | string |
複数ページにわたる PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力することで (例 '2, 5-7')、個別のページやページの範囲 (ページ 2 とページ 5-7 のように) から請求書情報を抽出します。 設定しない場合は、すべてのページを処理します。 |
|
|
ロケール
|
locale | string |
請求書のロケールです。 サポートされているロケールは次のとおりです: en-US。 |
|
|
ドキュメント/画像のファイル コンテンツ
|
inputFileContent | binary |
分析する PDF ドキュメントまたは画像 (JPG または PNG) ファイルです。 |
|
|
ドキュメント/画像の URL
|
inputFileUrl | string |
入力ファイル用の URL パス。 ドキュメント/画像ファイル コンテンツの代替。 |
戻り値
キュー登録済み分析操作の状態と結果。
定義
OperationStatus
LayoutAnalyzeOperationResult
キュー登録済み分析操作の状態と結果。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | OperationStatus |
キューに登録した操作の状態。 |
|
createdDateTime
|
createdDateTime | string |
分析操作が送信された日時 (UTC) です。 |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
状態が最後に更新された日時 (UTC) です。 |
|
analyzeResult
|
analyzeResult | LayoutAnalyzeResult |
操作結果を分析します。 |
InvoiceAnalyzeOperationResult
キュー登録済み分析操作の状態と結果。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | OperationStatus |
キューに登録した操作の状態。 |
|
createdDateTime
|
createdDateTime | string |
分析操作が送信された日時 (UTC) です。 |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
状態が最後に更新された日時 (UTC) です。 |
|
analyzeResult
|
analyzeResult | InvoiceAnalyzeResult |
操作結果を分析します。 |
BusinessCardAnalyzeOperationResult
キュー登録済み分析操作の状態と結果。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | OperationStatus |
キューに登録した操作の状態。 |
|
createdDateTime
|
createdDateTime | string |
分析操作が送信された日時 (UTC) です。 |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
状態が最後に更新された日時 (UTC) です。 |
|
analyzeResult
|
analyzeResult | BusinessCardAnalyzeResult |
操作結果を分析します。 |
ReceiptAnalyzeOperationResult
キュー登録済み分析操作の状態と結果。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | OperationStatus |
キューに登録した操作の状態。 |
|
createdDateTime
|
createdDateTime | string |
分析操作が送信された日時 (UTC) です。 |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
状態が最後に更新された日時 (UTC) です。 |
|
analyzeResult
|
analyzeResult | ReceiptAnalyzeResult |
操作結果を分析します。 |
IdAnalyzeOperationResult
キュー登録済み分析操作の状態と結果。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | OperationStatus |
キューに登録した操作の状態。 |
|
createdDateTime
|
createdDateTime | string |
分析操作が送信された日時 (UTC) です。 |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
状態が最後に更新された日時 (UTC) です。 |
|
analyzeResult
|
analyzeResult | IdAnalyzeResult |
操作結果を分析します。 |
CustomFormsAnalyzeOperationResult
キュー登録済み分析操作の状態と結果。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | OperationStatus |
キューに登録した操作の状態。 |
|
createdDateTime
|
createdDateTime | string |
分析操作が送信された日時 (UTC) です。 |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
状態が最後に更新された日時 (UTC) です。 |
|
analyzeResult
|
analyzeResult | CustomFormsAnalyzeResult |
操作結果を分析します。 |
FormOperationError
操作中にエラーが報告されました。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メッセージ
|
message | string |
エラー メッセージ。 |
LayoutAnalyzeResult
操作結果を分析します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バージョン
|
version | string |
この結果で使用したスキーマのバージョン。 |
|
readResults
|
readResults | array of ReadResult |
入力から抽出したテキスト。 |
|
pageResults
|
pageResults | array of PageResult |
入力から抽出されたページ レベルの情報です。 |
|
エラー
|
errors | array of FormOperationError |
分析操作中に報告されたエラーの一覧です。 |
InvoiceAnalyzeResult
操作結果を分析します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バージョン
|
version | string |
この結果で使用したスキーマのバージョン。 |
|
readResults
|
readResults | array of ReadResult |
入力から抽出したテキスト。 |
|
pageResults
|
pageResults | array of PageResult |
入力から抽出されたページ レベルの情報です。 |
|
documentResults
|
documentResults | array of InvoiceDocumentResult |
入力から抽出されたドキュメント レベルの情報です。 |
|
エラー
|
errors | array of FormOperationError |
分析操作中に報告されたエラーの一覧です。 |
BusinessCardAnalyzeResult
操作結果を分析します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バージョン
|
version | string |
この結果で使用したスキーマのバージョン。 |
|
readResults
|
readResults | array of ReadResult |
入力から抽出したテキスト。 |
|
pageResults
|
pageResults | array of PageResult |
入力から抽出されたページ レベルの情報です。 |
|
documentResults
|
documentResults | array of BusinessCardDocumentResult |
入力から抽出されたドキュメント レベルの情報です。 |
|
エラー
|
errors | array of FormOperationError |
分析操作中に報告されたエラーの一覧です。 |
ReceiptAnalyzeResult
操作結果を分析します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バージョン
|
version | string |
この結果で使用したスキーマのバージョン。 |
|
readResults
|
readResults | array of ReadResult |
入力から抽出したテキスト。 |
|
pageResults
|
pageResults | array of PageResult |
入力から抽出されたページ レベルの情報です。 |
|
documentResults
|
documentResults | array of ReceiptDocumentResult |
入力から抽出されたドキュメント レベルの情報です。 |
|
エラー
|
errors | array of FormOperationError |
分析操作中に報告されたエラーの一覧です。 |
IdAnalyzeResult
操作結果を分析します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バージョン
|
version | string |
この結果で使用したスキーマのバージョン。 |
|
readResults
|
readResults | array of ReadResult |
入力から抽出したテキスト。 |
|
pageResults
|
pageResults | array of PageResult |
入力から抽出されたページ レベルの情報です。 |
|
documentResults
|
documentResults | array of IdDocumentResult |
入力から抽出されたドキュメント レベルの情報です。 |
|
エラー
|
errors | array of FormOperationError |
分析操作中に報告されたエラーの一覧です。 |
CustomFormsAnalyzeResult
操作結果を分析します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バージョン
|
version | string |
この結果で使用したスキーマのバージョン。 |
|
readResults
|
readResults | array of ReadResult |
入力から抽出したテキスト。 |
|
pageResults
|
pageResults | array of PageResult |
入力から抽出されたページ レベルの情報です。 |
|
documentResults
|
documentResults | array of CustomFormsDocumentResult |
入力から抽出されたドキュメント レベルの情報です。 |
|
エラー
|
errors | array of FormOperationError |
分析操作中に報告されたエラーの一覧です。 |
ReadResult
入力ドキュメントのページから抽出したテキスト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ページ
|
page | integer |
入力ドキュメントの 1 から始まるページ番号。 |
|
角度
|
angle | float |
-180 度から 180 度までの時計回りで表した、テキストの一般的な方向。 |
|
幅
|
width | float |
それぞれピクセル/インチで表した画像/PDF の幅。 |
|
height
|
height | float |
それぞれピクセル/インチで表した画像/PDF の高さ。 |
|
単位
|
unit | string |
幅、高さ、boundingBox プロパティで使用される単位。 画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "インチ" です。 |
|
行数
|
lines | array of TextLine |
includeTextDetails が true に設定されている場合の認識されたテキスト行のリスト。 返される行数は、1 ページあたり最大 300 行です。 行は上から下、左から右に並び替えられますが、場合によっては近接の方が優先されることもあります。 並べ替え順序は検出されたテキストによって異なるため、画像や OCR バージョンの更新によって異なる場合があります。 そのため、順序ではなく実際の行の場所に基づいてビジネス ロジックを構築してください。 |
TextLine
抽出したテキスト行を表すオブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テキスト
|
text | string |
この行が含むテキスト コンテンツ。 |
|
boundingBox
|
boundingBox | BoundingBox |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 8 つの数字が表すのは、テキストの方向に対して左上隅を基準に、時計回りに存在する 4 つの点です。 画像の場合、(x, y) 座標はピクセル単位で測定されます。 PDF の場合、(x, y) 座標はインチ単位で測定されます。 |
|
単語
|
words | array of TextWord |
テキスト行が含む単語の一覧。 |
TextWord
単語を表すオブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テキスト
|
text | string |
単語のテキスト コンテンツ。 |
|
boundingBox
|
boundingBox | BoundingBox |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 8 つの数字が表すのは、テキストの方向に対して左上隅を基準に、時計回りに存在する 4 つの点です。 画像の場合、(x, y) 座標はピクセル単位で測定されます。 PDF の場合、(x, y) 座標はインチ単位で測定されます。 |
|
信頼度
|
confidence | Confidence |
信頼度の値。 |
BoundingBox
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 8 つの数字が表すのは、テキストの方向に対して左上隅を基準に、時計回りに存在する 4 つの点です。 画像の場合、(x, y) 座標はピクセル単位で測定されます。 PDF の場合、(x, y) 座標はインチ単位で測定されます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
項目
|
float |
PageResult
1 件のページから情報を抽出しました。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ページ
|
page | integer |
ページ番号。 |
|
clusterId
|
clusterId | integer |
クラスター識別子。 |
|
keyValuePairs
|
keyValuePairs | array of KeyValuePair |
ページから抽出したキーと値のペアの一覧。 |
|
テーブル
|
tables | array of DataTable |
ページから抽出したデータ テーブルの一覧。 |
KeyValuePair
抽出したキーと値のペアに関する情報。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ラベル
|
label | string |
キーと値のペア エントリのユーザー定義ラベル。 |
|
キー
|
key | KeyValueElement |
キーと値のペアから抽出したキーや値に関する情報。 |
|
値
|
value | KeyValueElement |
キーと値のペアから抽出したキーや値に関する情報。 |
|
信頼度
|
confidence | Confidence |
信頼度の値。 |
KeyValueElement
キーと値のペアから抽出したキーや値に関する情報。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テキスト
|
text | string |
キーや値のテキスト コンテンツ。 |
|
boundingBox
|
boundingBox | BoundingBox |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 8 つの数字が表すのは、テキストの方向に対して左上隅を基準に、時計回りに存在する 4 つの点です。 画像の場合、(x, y) 座標はピクセル単位で測定されます。 PDF の場合、(x, y) 座標はインチ単位で測定されます。 |
|
要素
|
elements | array of ElementReference |
includeTextDetails に true を設定した場合に、このキーや値を構成するテキスト要素への参照一覧。 |
ElementReference
DataTable
ページに含まれる抽出したテーブルに関する情報。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
行
|
rows | integer |
行数。 |
|
列
|
columns | integer |
列数。 |
|
セル
|
cells | array of DataTableCell |
テーブルに含まれるセルの一覧。 |
DataTableCell
テーブルが含む抽出したセルに関する情報。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
rowIndex
|
rowIndex | integer |
セルの行インデックス。 |
|
columnIndex
|
columnIndex | integer |
セルの列インデックス。 |
|
rowSpan
|
rowSpan | integer |
このセルが占める行数。 |
|
columnSpan
|
columnSpan | integer |
このセルが占める列数。 |
|
テキスト
|
text | string |
このセルのテキスト コンテンツ。 |
|
boundingBox
|
boundingBox | BoundingBox |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 8 つの数字が表すのは、テキストの方向に対して左上隅を基準に、時計回りに存在する 4 つの点です。 画像の場合、(x, y) 座標はピクセル単位で測定されます。 PDF の場合、(x, y) 座標はインチ単位で測定されます。 |
|
要素
|
elements | array of ElementReference |
includeTextDetails に true を設定した場合に、この表のセルを構成するテキスト要素へのへの参照一覧。 |
|
isHeader
|
isHeader | boolean |
現在のセルがヘッダー セルかどうかを返します。 |
|
isFooter
|
isFooter | boolean |
現在のセルがフッター セルかどうかを返します。 |
InvoiceDocumentResult
入力ドキュメントに対する抽出フィールドのセットです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
docType
|
docType | string |
ドキュメントの種類です。 |
|
pageRange
|
pageRange | array of integer |
ドキュメントが見つかった最初と最後のページ番号です。 |
|
フィールド
|
fields | InvoiceFields |
2.1 の請求書フィールド。 |
BusinessCardDocumentResult
入力ドキュメントに対する抽出フィールドのセットです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
docType
|
docType | string |
ドキュメントの種類です。 |
|
pageRange
|
pageRange | array of integer |
ドキュメントが見つかった最初と最後のページ番号です。 |
|
フィールド
|
fields | BusinessCardFields |
2.1 の 名刺フィールド。 |
CustomFormsDocumentResult
入力ドキュメントに対する抽出フィールドのセットです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
docType
|
docType | string |
ドキュメントの種類です。 |
|
pageRange
|
pageRange | array of integer |
ドキュメントが見つかった最初と最後のページ番号です。 |
|
フィールド
|
_fields | array of CustomFormsFields |
fieldName と fieldValue のプロパティを持つフィールドを含む配列。 |
ReceiptDocumentResult
入力ドキュメントに対する抽出フィールドのセットです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
docType
|
docType | string |
ドキュメントの種類です。 |
|
pageRange
|
pageRange | array of integer |
ドキュメントが見つかった最初と最後のページ番号です。 |
|
フィールド
|
fields | ReceiptFields |
2.1 の領収書フィールド。 |
IdDocumentResult
入力ドキュメントに対する抽出フィールドのセットです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
docType
|
docType | string |
ドキュメントの種類です。 |
|
pageRange
|
pageRange | array of integer |
ドキュメントが見つかった最初と最後のページ番号です。 |
|
フィールド
|
fields | IdFields |
2.1 の ID ドキュメント フィールド。 |
CustomFormsFields
カスタム フォーム フィールド。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
フィールド名
|
fieldName | string | |
|
フィールド値
|
fieldValue | FieldValue |
予測したフィールド値オブジェクト。 |
InvoiceFields
2.1 の請求書フィールド。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
請求額 (テキスト)
|
AmountDue.text | string |
請求書に記載されている請求額を返します。 |
|
請求額 (数値)
|
AmountDue.valueNumber | number |
数値として書式設定します。 例 : 1234.98。 |
|
請求額の信頼度
|
AmountDue.confidence | float |
モデルの予測における信頼度を示します。 |
|
請求先住所
|
BillingAddress.text | string | |
|
請求先住所の信頼度
|
BillingAddress.confidence | float |
モデルの予測における信頼度を示します。 |
|
請求先住所の受取人
|
BillingAddressRecipient.text | string | |
|
請求先住所の受取人の信頼度
|
BillingAddressRecipient.confidence | float |
モデルの予測における信頼度を示します。 |
|
顧客住所
|
CustomerAddress.text | string | |
|
顧客住所の信頼度
|
CustomerAddress.confidence | float |
モデルの予測における信頼度を示します。 |
|
顧客住所の受取人
|
CustomerAddressRecipient.text | string | |
|
顧客住所の受取人の信頼度
|
CustomerAddressRecipient.confidence | float |
モデルの予測における信頼度を示します。 |
|
顧客 ID
|
CustomerId.text | string | |
|
顧客 ID の信頼度
|
CustomerId.confidence | float |
モデルの予測における信頼度を示します。 |
|
顧客名
|
CustomerName.text | string | |
|
顧客名の信頼度
|
CustomerName.confidence | float |
モデルの予測における信頼度を示します。 |
|
期限 (テキスト)
|
DueDate.text | string |
請求書に記載されている期限を返します。 |
|
期限 (日付)
|
DueDate.valueDate | date |
日付として書式設定します。 例 : 2019-05-31。 |
|
期限の信頼度
|
DueDate.confidence | float |
モデルの予測における信頼度を示します。 |
|
請求日 (テキスト)
|
InvoiceDate.text | string |
請求書に記載されている請求日を返します。 |
|
請求日 (日付)
|
InvoiceDate.valueDate | date |
日付として書式設定します。 例 : 2019-05-31。 |
|
請求日の信頼度
|
InvoiceDate.confidence | float |
モデルの予測における信頼度を示します。 |
|
請求書 ID
|
InvoiceId.text | string | |
|
請求書 ID の信頼度
|
InvoiceId.confidence | float |
モデルの予測における信頼度を示します。 |
|
請求書の合計 (テキスト)
|
InvoiceTotal.text | string |
請求書に記載されている請求書の合計を返します。 |
|
請求書の合計 (数値)
|
InvoiceTotal.valueNumber | number |
数値として書式設定します。 例 : 1234.98。 |
|
請求合計の信頼度
|
InvoiceTotal.confidence | float |
モデルの予測における信頼度を示します。 |
|
前回の未払残高 (テキスト)
|
PreviousUnpaidBalance.text | string |
請求書に記載されている前回の未払残高を返します。 |
|
前回の未払い残高 (数値)
|
PreviousUnpaidBalance.valueNumber | number |
数値として書式設定します。 例 : 1234.98。 |
|
前回の未払い残高の信頼度
|
PreviousUnpaidBalance.confidence | float |
モデルの予測における信頼度を示します。 |
|
発注書
|
PurchaseOrder.text | string | |
|
発注書の信頼度
|
PurchaseOrder.confidence | float |
モデルの予測における信頼度を示します。 |
|
送金先住所
|
RemittanceAddress.text | string | |
|
送金先住所の信頼度
|
RemittanceAddress.confidence | float |
モデルの予測における信頼度を示します。 |
|
送金先住所の受取人
|
RemittanceAddressRecipient.text | string | |
|
送金先住所の受取人の信頼度
|
RemittanceAddressRecipient.confidence | float |
モデルの予測における信頼度を示します。 |
|
サービス住所
|
ServiceAddress.text | string | |
|
サービス住所の信頼度
|
ServiceAddress.confidence | float |
モデルの予測における信頼度を示します。 |
|
サービス住所の受取人
|
ServiceAddressRecipient.text | string | |
|
サービス住所の受取人の信頼度
|
ServiceAddressRecipient.confidence | float |
モデルの予測における信頼度を示します。 |
|
サービス終了日 (テキスト)
|
ServiceEndDate.text | string |
請求書に記載されているサービス終了日を返します。 |
|
サービス終了日 (日付)
|
ServiceEndDate.valueDate | date |
日付として書式設定します。 例 : 2019-05-31。 |
|
サービス終了日の信頼度
|
ServiceEndDate.confidence | float |
モデルの予測における信頼度を示します。 |
|
サービス開始日 (テキスト)
|
ServiceStartDate.text | string |
請求書に記載されているサービス開始日を返します。 |
|
サービス開始日 (日付)
|
ServiceStartDate.valueDate | date |
日付として書式設定します。 例 : 2019-05-31。 |
|
サービス開始日の信頼度
|
ServiceStartDate.confidence | float |
モデルの予測における信頼度を示します。 |
|
送付先住所
|
ShippingAddress.text | string | |
|
送付先住所の信頼度
|
ShippingAddress.confidence | float |
モデルの予測における信頼度を示します。 |
|
送付先住所の受取人
|
ShippingAddressRecipient.text | string | |
|
送付先住所の受取人の信頼度
|
ShippingAddressRecipient.confidence | float |
モデルの予測における信頼度を示します。 |
|
小計 (テキスト)
|
SubTotal.text | string |
請求書に記載された小計を返します。 |
|
小計 (数値)
|
SubTotal.valueNumber | number |
数値として書式設定します。 例 : 1234.98。 |
|
小計の信頼度
|
SubTotal.confidence | float |
モデルの予測における信頼度を示します。 |
|
税額計 (テキスト)
|
TotalTax.text | string |
請求書に記載されている税額計を返します。 |
|
税額計 (数値)
|
TotalTax.valueNumber | number |
数値として書式設定します。 例 : 1234.98。 |
|
税額計の信頼度
|
TotalTax.confidence | float |
モデルの予測における信頼度を示します。 |
|
ベンダー住所
|
VendorAddress.text | string | |
|
ベンダー住所の信頼度
|
VendorAddress.confidence | float |
モデルの予測における信頼度を示します。 |
|
ベンダー住所の受取人
|
VendorAddressRecipient.text | string | |
|
ベンダー住所の受取人の信頼度
|
VendorAddressRecipient.confidence | float |
モデルの予測における信頼度を示します。 |
|
ベンダー名
|
VendorName.text | string | |
|
ベンダー名の信頼度
|
VendorName.confidence | float |
モデルの予測における信頼度を示します。 |
|
項目
|
Items.valueArray | array of object |
品目の配列 |
|
数量 (テキスト)
|
Items.valueArray.valueObject.Amount.text | string |
請求書に記載された数量を返します。 |
|
数量 (数値)
|
Items.valueArray.valueObject.Amount.valueNumber | number |
数値として書式設定します。 例 : 12。 |
|
数量の信頼度
|
Items.valueArray.valueObject.Amount.confidence | float |
モデルの予測における信頼度を示します。 |
|
内容
|
Items.valueArray.valueObject.Description.text | string | |
|
説明の信頼度
|
Items.valueArray.valueObject.Description.confidence | float |
モデルの予測における信頼度を示します。 |
|
数量 (テキスト)
|
Items.valueArray.valueObject.Quantity.text | string |
請求書に記載された数量を返します。 |
|
数量 (数値)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
数値として書式設定します。 例 : 12。 |
|
数量の信頼度
|
Items.valueArray.valueObject.Quantity.confidence | float |
モデルの予測における信頼度を示します。 |
|
単価 (テキスト)
|
Items.valueArray.valueObject.UnitPrice.text | string |
請求書に記載された単価を返します。 |
|
単価 (数値)
|
Items.valueArray.valueObject.UnitPrice.valueNumber | number |
数値として書式設定します。 例 : 12。 |
|
単価の信頼度
|
Items.valueArray.valueObject.UnitPrice.confidence | float |
モデルの予測における信頼度を示します。 |
|
製品コード
|
Items.valueArray.valueObject.ProductCode.text | string | |
|
製品コードの信頼度
|
Items.valueArray.valueObject.ProductCode.confidence | float |
モデルの予測における信頼度を示します。 |
|
単位
|
Items.valueArray.valueObject.Unit.text | string | |
|
単位の信頼度
|
Items.valueArray.valueObject.Unit.confidence | float |
モデルの予測における信頼度を示します。 |
|
日付 (テキスト)
|
Items.valueArray.valueObject.Date.text | string |
請求書に記載された日付を返します。 |
|
日付 (日付)
|
Items.valueArray.valueObject.Date.valueDate | date |
日付として書式設定します。 例 : 2019-05-31。 |
|
日付の信頼度
|
Items.valueArray.valueObject.Date.confidence | float |
モデルの予測における信頼度を示します。 |
|
税 (テキスト)
|
Items.valueArray.valueObject.Tax.text | string |
請求書に記載された税を返します。 |
|
税 (数値)
|
Items.valueArray.valueObject.Tax.valueNumber | number |
数値として書式設定します。 例 : 12。 |
|
税額の信頼度
|
Items.valueArray.valueObject.Tax.confidence | float |
モデルの予測における信頼度を示します。 |
BusinessCardFields
2.1 の 名刺フィールド。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
取引先担当者名
|
ContactNames.valueArray | array of object |
取引先担当者名の配列 |
|
名
|
ContactNames.valueArray.valueObject.FirstName.text | string | |
|
名の信頼度
|
ContactNames.valueArray.valueObject.FirstName.confidence | float |
モデルの予測における信頼度を示します。 |
|
姓
|
ContactNames.valueArray.valueObject.LastName.text | string | |
|
姓の信頼度
|
ContactNames.valueArray.valueObject.LastName.confidence | float |
モデルの予測における信頼度を示します。 |
|
会社名
|
CompanyNames.valueArray | array of object |
会社名の配列 |
|
会社名
|
CompanyNames.valueArray.text | string | |
|
会社名の信頼度
|
CompanyNames.valueArray.confidence | float |
モデルの予測における信頼度を示します。 |
|
部署
|
Departments.valueArray | array of object |
部署の配列 |
|
部署
|
Departments.valueArray.text | string | |
|
部署の信頼度
|
Departments.valueArray.confidence | float |
モデルの予測における信頼度を示します。 |
|
役職
|
JobTitles.valueArray | array of object |
役職の配列 |
|
役職
|
JobTitles.valueArray.text | string | |
|
役職の信頼度
|
JobTitles.valueArray.confidence | float |
モデルの予測における信頼度を示します。 |
|
メール
|
Emails.valueArray | array of object |
電子メールの配列 |
|
電子メール
|
Emails.valueArray.text | string | |
|
電子メールの信頼度
|
Emails.valueArray.confidence | float |
モデルの予測における信頼度を示します。 |
|
Web サイト
|
Websites.valueArray | array of object |
Web サイトの配列 |
|
Web サイト
|
Websites.valueArray.text | string | |
|
Web サイトの信頼度
|
Websites.valueArray.confidence | float |
モデルの予測における信頼度を示します。 |
|
住所
|
Addresses.valueArray | array of object |
住所の配列 |
|
住所
|
Addresses.valueArray.text | string | |
|
住所の信頼度
|
Addresses.valueArray.confidence | float |
モデルの予測における信頼度を示します。 |
|
携帯電話
|
MobilePhones.valueArray | array of object |
携帯電話番号の配列 |
|
携帯電話
|
MobilePhones.valueArray.text | string | |
|
携帯電話番号の信頼度
|
MobilePhones.valueArray.confidence | float |
モデルの予測における信頼度を示します。 |
|
FAX
|
Faxes.valueArray | array of object |
FAX の配列 |
|
FAX
|
Faxes.valueArray.text | string | |
|
FAX の信頼度
|
Faxes.valueArray.confidence | float |
モデルの予測における信頼度を示します。 |
|
勤務先電話番号
|
WorkPhones.valueArray | array of object |
勤務先電話番号の配列 |
|
勤務先電話番号
|
WorkPhones.valueArray.text | string | |
|
勤務先電話番号の信頼度
|
WorkPhones.valueArray.confidence | float |
モデルの予測における信頼度を示します。 |
|
その他の電話
|
OtherPhones.valueArray | array of object |
その他の電話番号の配列 |
|
その他の電話
|
OtherPhones.valueArray.text | string | |
|
その他の電話番号の信頼度
|
OtherPhones.valueArray.confidence | float |
モデルの予測における信頼度を示します。 |
ReceiptFields
2.1 の領収書フィールド。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
受領書タイプ
|
ReceiptType.text | string | |
|
領収書タイプの信頼度
|
ReceiptType.confidence | float |
モデルの予測における信頼度を示します。 |
|
店舗名
|
MerchantName.text | string | |
|
店舗名の信頼度
|
MerchantName.confidence | float |
モデルの予測における信頼度を示します。 |
|
店舗の電話番号
|
MerchantPhoneNumber.text | string | |
|
店舗の電話番号の信頼度
|
MerchantPhoneNumber.confidence | float |
モデルの予測における信頼度を示します。 |
|
店舗住所
|
MerchantAddress.text | string | |
|
店舗住所の信頼度
|
MerchantAddress.confidence | float |
モデルの予測における信頼度を示します。 |
|
取引の日時 (テキスト)
|
TransactionDate.text | string |
請求書に記載された取引日を返します。 |
|
取引の日付 (日付)
|
TransactionDate.valueDate | date |
日付として書式設定します。 例 : 2019-05-31。 |
|
トランザクションの日付の信頼度
|
TransactionDate.confidence | float |
モデルの予測における信頼度を示します。 |
|
取引の時間 (テキスト)
|
TransactionTime.text | string |
請求書に記載された取引時間を返します。 |
|
取引の時間 (時間)
|
TransactionTime.valueDate | time |
日付として書式設定します。 例 : 2019-05-31。 |
|
トランザクションの時刻の信頼度
|
TransactionTime.confidence | float |
モデルの予測における信頼度を示します。 |
|
合計 (テキスト)
|
Total.text | string |
請求書に記載された合計を返します。 |
|
合計 (数値)
|
Total.valueNumber | number |
数値として書式設定します。 例 : 1234.98。 |
|
合計の信頼度
|
Total.confidence | float |
モデルの予測における信頼度を示します。 |
|
小計 (テキスト)
|
Subtotal.text | string |
請求書に記載された小計を返します。 |
|
小計 (数値)
|
Subtotal.valueNumber | number |
数値として書式設定します。 例 : 1234.98。 |
|
小計の信頼度
|
Subtotal.confidence | float |
モデルの予測における信頼度を示します。 |
|
税 (テキスト)
|
Tax.text | string |
請求書に記載された税を返します。 |
|
税 (数値)
|
Tax.valueNumber | number |
数値として書式設定します。 例 : 1234.98。 |
|
税額の信頼度
|
Tax.confidence | float |
モデルの予測における信頼度を示します。 |
|
ヒント (テキスト)
|
Tip.text | string |
請求書に記載されたチップを返します。 |
|
ヒント (数値)
|
Tip.valueNumber | number |
数値として書式設定します。 例 : 1234.98。 |
|
チップの信頼度
|
Tip.confidence | float |
モデルの予測における信頼度を示します。 |
|
項目
|
Items.valueArray | array of object |
品目の配列 |
|
件名
|
Items.valueArray.valueObject.Name.text | string | |
|
名前の信頼度
|
Items.valueArray.valueObject.Name.confidence | float |
モデルの予測における信頼度を示します。 |
|
数量 (テキスト)
|
Items.valueArray.valueObject.Quantity.text | string |
請求書に記載された数量を返します。 |
|
数量 (数値)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
数値として書式設定します。 例 : 12。 |
|
数量の信頼度
|
Items.valueArray.valueObject.Quantity.confidence | float |
モデルの予測における信頼度を示します。 |
|
価格 (テキスト)
|
Items.valueArray.valueObject.Price.text | string |
請求書に記載された価格を返します。 |
|
価格 (数値)
|
Items.valueArray.valueObject.Price.valueNumber | number |
数値として書式設定します。 例 : 12。 |
|
価格の信頼度
|
Items.valueArray.valueObject.Price.confidence | float |
モデルの予測における信頼度を示します。 |
|
合計価格 (テキスト)
|
Items.valueArray.valueObject.TotalPrice.text | string |
請求書に記載された合計価格を返します。 |
|
合計価格 (数値)
|
Items.valueArray.valueObject.TotalPrice.valueNumber | number |
数値として書式設定します。 例 : 12。 |
|
合計価格の信頼度
|
Items.valueArray.valueObject.TotalPrice.confidence | float |
モデルの予測における信頼度を示します。 |
IdFields
2.1 の ID ドキュメント フィールド。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
国と地域
|
CountryRegion.valueCountryRegion | string | |
|
国と地域の信頼度
|
CountryRegion.confidence | float |
モデルの予測における信頼度を示します。 |
|
有効期限
|
DateOfExpiration.text | string |
請求書に記載された有効期限を返します。 |
|
有効期限 (日付)
|
DateOfExpiration.valueDate | date |
日付として書式設定します。 例 : 2019-05-31。 |
|
有効期限の信頼度
|
DateOfExpiration.confidence | float |
モデルの予測における信頼度を示します。 |
|
生年月日 (テキスト)
|
DateOfBirth.text | string |
請求書に記載された生年月日を返します。 |
|
生年月日 (日付)
|
DateOfBirth.valueDate | date |
日付として書式設定します。 例 : 2019-05-31。 |
|
生年月日の信頼度
|
DateOfBirth.confidence | float |
モデルの予測における信頼度を示します。 |
|
ドキュメント番号
|
DocumentNumber.text | string | |
|
ドキュメント番号の信頼度
|
DocumentNumber.confidence | float |
モデルの予測における信頼度を示します。 |
|
名
|
FirstName.text | string | |
|
名の信頼度
|
FirstName.confidence | float |
モデルの予測における信頼度を示します。 |
|
姓
|
LastName.text | string | |
|
姓の信頼度
|
LastName.confidence | float |
モデルの予測における信頼度を示します。 |
|
国籍
|
Nationality.valueCountryRegion | string | |
|
国籍の信頼度
|
Nationality.confidence | float |
モデルの予測における信頼度を示します。 |
|
性別
|
Sex.text | string | |
|
性別の信頼度
|
Sex.confidence | float |
モデルの予測における信頼度を示します。 |
|
コンピューターが読み取れる領域
|
MachineReadableZone.text | string | |
|
コンピューターが読み取れる領域の信頼度
|
MachineReadableZone.confidence | float |
モデルの予測における信頼度を示します。 |
|
ドキュメントの種類
|
DocumentType.text | string | |
|
ドキュメント タイプの信頼度
|
DocumentType.confidence | float |
モデルの予測における信頼度を示します。 |
|
住所
|
Address.text | string | |
|
住所の信頼度
|
Address.confidence | float |
モデルの予測における信頼度を示します。 |
|
リージョン
|
Region.text | string | |
|
地域の信頼度
|
Region.confidence | float |
モデルの予測における信頼度を示します。 |
FieldValue
予測したフィールド値オブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
種類
|
type | FieldValueType |
フィールド値のセマンティック データ型。 |
|
valueString
|
valueString | string |
文字列値。 |
|
valueDate
|
valueDate | date-time |
日付値。 |
|
valueTime
|
valueTime | date-time |
時間値。 |
|
valuePhoneNumber
|
valuePhoneNumber | string |
電話番号の値。 |
|
valueNumber
|
valueNumber | number |
浮動小数点値。 |
|
valueInteger
|
valueInteger | integer |
整数値。 |
|
テキスト
|
text | string | |
|
boundingBox
|
boundingBox | BoundingBox |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 8 つの数字が表すのは、テキストの方向に対して左上隅を基準に、時計回りに存在する 4 つの点です。 画像の場合、(x, y) 座標はピクセル単位で測定されます。 PDF の場合、(x, y) 座標はインチ単位で測定されます。 |
|
信頼度
|
confidence | Confidence |
信頼度の値。 |
|
要素
|
elements | array of ElementReference |
includeTextDetails に true を設定した場合に、このフィールドを構成するテキスト要素への参照一覧。 |
|
ページ
|
page | integer |
入力ドキュメントの 1 から始まるページ番号。 |
FieldValueType
信頼度
ApiVersion_V30
AnalyzeResultOperation_V30
分析操作の状態と結果です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ステータス
|
status | string |
操作の状態です。 |
|
createdDateTime
|
createdDateTime | date-time |
分析操作が送信された日時 (UTC) です。 |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time |
状態が最後に更新された日時 (UTC) です。 |
|
エラー
|
error | Error_V30 |
エラー情報です。 |
|
analyzeResult
|
analyzeResult | AnalyzeResult_V30 |
ドキュメントの分析結果です。 |
AnalyzeResult_V30
ドキュメントの分析結果です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
apiVersion
|
apiVersion | ApiVersion_V30 |
API のバージョンです。 |
|
modelId
|
modelId | ModelId_V30 |
一意のモデル名です。 |
|
stringIndexType
|
stringIndexType | StringIndexType_V30 |
文字列のオフセットと長さの計算に使用されるメソッドです。 |
|
コンテント
|
content | string |
すべてのテキスト要素とビジュアル要素の文字列表現を、読み取り順で連結します。 |
|
pages
|
pages | array of DocumentPage_V30 |
分析されたページです。 |
|
段落
|
paragraphs | array of DocumentParagraph_V30 |
抽出された段落です。 |
|
tables
|
tables | array of DocumentTable_V30 |
抽出されたテーブルです。 |
|
keyValuePairs
|
keyValuePairs | array of DocumentKeyValuePair_V30 |
抽出されたキー/値ペアです。 |
|
entities
|
entities | array of DocumentEntity_V30 |
抽出されたエンティティです。 |
|
スタイル
|
styles | array of DocumentStyle_V30 |
抽出されたフォント スタイルです。 |
|
言語
|
languages | array of DocumentLanguage_V30 |
検出された言語です。 |
|
documents
|
documents | array of Document_V30 |
抽出されたドキュメントです。 |
DocumentPage_V30
入力されたページから抽出したコンテンツ要素とレイアウト要素です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
kind
|
kind | string |
ドキュメント ページの種類です。 |
|
pageNumber
|
pageNumber | integer |
入力ドキュメントの 1 から始まるページ番号です。 |
|
角度
|
angle | number |
-180 度から 180 度までの時計回りで表した、コンテンツの一般的な方向です。 |
|
幅
|
width | number |
それぞれピクセル/インチで表した画像/PDF の幅。 |
|
height
|
height | number |
それぞれピクセル/インチで表した画像/PDF の高さ。 |
|
unit
|
unit | string |
幅、高さ、多角形プロパティで使用される単位。 画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "インチ" です。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツのページの場所です。 |
|
単語
|
words | array of DocumentWord_V30 |
ページから抽出された単語です。 |
|
selectionMarks
|
selectionMarks | array of DocumentSelectionMark_V30 |
ページから抽出された選択記号です。 |
|
images
|
images | array of DocumentImage_V30 |
ページから抽出された画像です。 |
|
明細行
|
lines | array of DocumentLine_V30 |
ページから抽出された行です。テキスト要素とビジュアル要素の両方を含む可能性があります。 |
|
バーコード
|
barcodes | array of DocumentBarcode_V31 |
ページから抽出されたバーコードです。 |
|
数式
|
formulas | array of DocumentFormula_V31 |
ページから抽出された式です。 |
DocumentWord_V30
連続した一連の文字で構成される単語オブジェクト。 中国語、日本語、韓国語などの、スペース区切りのない言語の場合は、各文字がそれぞれ単語として表されます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コンテント
|
content | string |
単語のテキスト コンテンツです。 |
|
多角形
|
polygon | BoundingPolygon_V30 |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 数値は、ポリゴンの向きに対して左から時計回りの順に (-180 度を含む) 各頂点の x、y 値を表します。 |
|
スパン
|
span | DocumentSpan_V30 |
オフセットと長さで指定された、連結されたコンテンツ プロパティの連続する領域です。 |
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
DocumentSelectionMark_V30
チェック ボックス、ラジオ ボタン、およびその他の選択を示している要素を表す選択記号オブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
州
|
state | DocumentSelectionMarkState_V30 |
選択記号の状態です。 |
|
多角形
|
polygon | BoundingPolygon_V30 |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 数値は、ポリゴンの向きに対して左から時計回りの順に (-180 度を含む) 各頂点の x、y 値を表します。 |
|
スパン
|
span | DocumentSpan_V30 |
オフセットと長さで指定された、連結されたコンテンツ プロパティの連続する領域です。 |
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
DocumentImage_V30
ページで画像オブジェクトが検出されました。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
多角形
|
polygon | BoundingPolygon_V30 |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 数値は、ポリゴンの向きに対して左から時計回りの順に (-180 度を含む) 各頂点の x、y 値を表します。 |
|
スパン
|
span | DocumentSpan_V30 |
オフセットと長さで指定された、連結されたコンテンツ プロパティの連続する領域です。 |
|
pageRef
|
pageRef | integer |
画像のコンテンツを含むグローバル ページ配列の 0 から始まるインデックスです。 |
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
DocumentSelectionMarkState_V30
DocumentStyle_V30
観察されたテキスト スタイルを表すオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
backgroundColor
|
backgroundColor | string |
#rrggbb の 16 進形式で表現された背景色です。 |
|
color
|
color | string |
#rrggbb の 16 進形式で表現された前景色です。 |
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
|
fontStyle
|
fontStyle | string |
フォント スタイル。 |
|
fontWeight
|
fontWeight | string |
フォントの太さ。 |
|
isHandwritten
|
isHandwritten | boolean |
コンテンツが手書きである。 |
|
similarFontFamily
|
similarFontFamily | string |
サポートされているフォント ファミリーのセットの中から視覚的に最も類似したフォント。代替フォントは CSS 規則に従っています (例: 「Arial, sans-serif」). |
|
スパン
|
spans | array of DocumentSpan_V30 |
連結されたコンテンツで、このスタイルが適用されるテキスト要素の場所です。 |
DocumentLanguage_V30
指定されたテキスト範囲で検出された言語を表すオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
locale
|
locale | string |
検出された言語。 値は ISO 639-1 言語コード (例: "en"、"fr") または BCP 47 言語タグ (例: "zh-Hans"). |
|
スパン
|
spans | array of DocumentSpan_V30 |
連結されたコンテンツで、この言語が適用されるテキスト要素の場所です。 |
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
DocumentLine_V30
隣接するコンテンツ要素のシーケンス (単語や選択記号など) で構成されるコンテンツ行オブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コンテント
|
content | string |
含まれる要素を読み取り順に連結したコンテンツです。 |
|
多角形
|
polygon | BoundingPolygon_V30 |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 数値は、ポリゴンの向きに対して左から時計回りの順に (-180 度を含む) 各頂点の x、y 値を表します。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツの行の場所です。 |
DocumentParagraph_V30
連続する行で構成され、一般的な方法で配置と間隔が調整された段落オブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
role
|
role | string |
段落のセマンティック ロールです。 |
|
コンテント
|
content | string |
段落を読み取り順に連結したコンテンツです。 |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
段落をカバーする境界領域です。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツの段落の場所です。 |
DocumentTable_V30
四角形のレイアウトで配置されたテーブルのセルで構成される、テーブル オブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
rowCount
|
rowCount | integer |
テーブルに含まれる行の数です。 |
|
columnCount
|
columnCount | integer |
テーブルに含まれる列の数です。 |
|
セル
|
cells | array of DocumentTableCell_V30 |
テーブルに含まれるセルです。 |
|
caption
|
caption | DocumentCaption_V30 |
テーブル キャプションの場所とコンテンツを表すオブジェクトです。 |
|
脚注
|
footnotes | array of DocumentFootnote_V30 |
テーブルに関連付けられている脚注です。 |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
テーブルをカバーする境界領域です。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツの、テーブルの場所です。 |
DocumentTableCell_V30
テーブルのセルの場所とコンテンツを表すオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
kind
|
kind | string |
テーブルのセルの種類です。 |
|
rowIndex
|
rowIndex | integer |
セルの行インデックス。 |
|
columnIndex
|
columnIndex | integer |
セルの列インデックス。 |
|
rowSpan
|
rowSpan | integer |
このセルが占める行数。 |
|
columnSpan
|
columnSpan | integer |
このセルが占める列数。 |
|
コンテント
|
content | string |
テーブルのセルを読み取り順に連結したコンテンツです。 |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
テーブルのセルをカバーする境界領域です。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツの、テーブルのセルの場所です。 |
DocumentCaption_V30
テーブル キャプションの場所とコンテンツを表すオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コンテント
|
content | string |
テーブル キャプションのコンテンツです。 |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
テーブル キャプションをカバーする境界領域です。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツのテーブル キャプションの場所です。 |
DocumentFootnote_V30
テーブルの脚注の場所とコンテンツを表すオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コンテント
|
content | string |
テーブルの脚注のコンテンツです。 |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
テーブルの脚注をカバーする境界領域です。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツのテーブル脚注の場所です。 |
DocumentKeyValuePair_V30
フィールド ラベル (キー) とフィールド値 (省略可) が別々に指定されたフォーム フィールドを表すオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
key
|
key | DocumentKeyValueElement_V30 |
フィールド キーまたはキー/値ペアの値を表すオブジェクトです。 |
|
価値
|
value | DocumentKeyValueElement_V30 |
フィールド キーまたはキー/値ペアの値を表すオブジェクトです。 |
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
DocumentKeyValueElement_V30
フィールド キーまたはキー/値ペアの値を表すオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コンテント
|
content | string |
読み取り順に連結された、キー/値の要素のコンテンツです。 |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
キー/値の要素をカバーする境界領域です。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツの、キー/値の要素の場所です。 |
DocumentEntity_V30
エンティティのさまざまなカテゴリを表すオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
category
|
category | string |
エンティティの種類です。 |
|
subCategory
|
subCategory | string |
エンティティのサブ タイプです。 |
|
コンテント
|
content | string |
エンティティのコンテンツです。 |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
エンティティをカバーする境界領域です。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツのエンティティの場所です。 |
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
DocumentBarcode_V31
バーコード オブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
|
kind
|
kind | string |
バーコードの種類です。 |
|
多角形
|
polygon | BoundingPolygon_V30 |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 数値は、ポリゴンの向きに対して左から時計回りの順に (-180 度を含む) 各頂点の x、y 値を表します。 |
|
スパン
|
span | DocumentSpan_V30 |
オフセットと長さで指定された、連結されたコンテンツ プロパティの連続する領域です。 |
|
価値
|
value | string |
バーコード値 |
DocumentFormula_V31
式のオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
|
kind
|
kind | string |
式の種類です。 |
|
多角形
|
polygon | BoundingPolygon_V30 |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 数値は、ポリゴンの向きに対して左から時計回りの順に (-180 度を含む) 各頂点の x、y 値を表します。 |
|
スパン
|
span | DocumentSpan_V30 |
オフセットと長さで指定された、連結されたコンテンツ プロパティの連続する領域です。 |
|
価値
|
value | string |
式を説明する LaTeX 式です。 |
Document_V30
ドキュメントの場所とセマンティック コンテンツを記述するオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
docType
|
docType | DocType_V30 |
ドキュメントの種類の名前です。 |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
ドキュメントをカバーする境界領域です。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツの、ドキュメントの場所です。 |
|
fields
|
fields | object |
名前付きフィールド値の辞書です。 |
|
Fields
|
_fields | array of DocumentFieldNameValue_V30 |
fieldName と fieldValue のプロパティを持つフィールドを含む配列。 |
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
BoundingPolygon_V30
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 数値は、ポリゴンの向きに対して左から時計回りの順に (-180 度を含む) 各頂点の x、y 値を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
number |
BoundingRegion_V30
入力で指定されたページの境界ポリゴンです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
pageNumber
|
pageNumber | integer |
境界領域を含むページの 1 から始まるページ番号です。 |
|
多角形
|
polygon | BoundingPolygon_V30 |
元画像の左上を基準に指定した座標を持つ、四角形の境界ボックス。 数値は、ポリゴンの向きに対して左から時計回りの順に (-180 度を含む) 各頂点の x、y 値を表します。 |
DocumentFieldType_V30
DocumentFieldNameValue_V30
フィールド名とその値が指定されたドキュメントのフィールド オブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
フィールド名
|
fieldName | string | |
|
fieldValue
|
fieldValue | DocumentField_V30 |
フィールド値のコンテンツと場所を表すオブジェクトです。 |
DocumentField_V30
フィールド値のコンテンツと場所を表すオブジェクトです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイプ
|
type | DocumentFieldType_V30 |
フィールド値のセマンティック データ型。 |
|
valueString
|
valueString | string |
文字列値。 |
|
valueDate
|
valueDate | date |
YYYY-MM-DD 形式の日付の値 (ISO 8601)。 |
|
valueTime
|
valueTime | time |
hh:mm:ss 形式の時間の値 (ISO 8601)。 |
|
valuePhoneNumber
|
valuePhoneNumber | string |
E.164 形式の電話番号の値 (例: +19876543210). |
|
valueNumber
|
valueNumber | number |
浮動小数点値。 |
|
valueInteger
|
valueInteger | integer |
整数値。 |
|
valueSelectionMark
|
valueSelectionMark | DocumentSelectionMarkState_V30 |
選択記号の状態です。 |
|
valueSignature
|
valueSignature | string |
署名のあり/なし。 |
|
valueCountryRegion
|
valueCountryRegion | string |
3 文字の国コード値 (ISO 3166-1 alpha-3)。 |
|
valueCurrency
|
valueCurrency | CurrencyValue_V30 |
通貨フィールドの値です。 |
|
valueAddress
|
valueAddress | AddressValue_V30 |
住所フィールドの値です。 |
|
valueBoolean
|
valueBoolean | boolean |
ブール値。 |
|
コンテント
|
content | string |
フィールドのコンテンツです。 |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
フィールドをカバーする境界領域です。 |
|
スパン
|
spans | array of DocumentSpan_V30 |
読み取り順に連結されたコンテンツのフィールドの場所です。 |
|
信頼度
|
confidence | Confidence_V30 |
予測の信頼度です。 |
Confidence_V30
DocType_V30
DocumentSpan_V30
オフセットと長さで指定された、連結されたコンテンツ プロパティの連続する領域です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
offset
|
offset | integer |
範囲で表されたコンテンツの 0 から始まるインデックスです。 |
|
length
|
length | integer |
範囲で表されたコンテンツ内の文字数です。 |
StringIndexType_V30
ModelId_V30
Error_V30
エラー情報です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
code
|
code | string |
エラー コードです。 |
|
message
|
message | string |
エラー メッセージ。 |
|
ターゲット
|
target | string |
エラーのターゲットです。 |
|
details
|
details | array of InnerError_V30 |
詳細なエラーのリストです。 |
|
innererror
|
innererror | InnerError_V30 |
エラーの詳細です。 |
InnerError_V30
エラーの詳細です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
code
|
code | string |
エラー コードです。 |
|
message
|
message | string |
エラー メッセージ。 |
CurrencyValue_V30
通貨フィールドの値です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
amount
|
amount | double |
通貨金額。 |
|
currencyCode
|
currencyCode | string |
ISO 4217 の通貨コード (解決された場合)。 |
|
currencySymbol
|
currencySymbol | string |
通貨記号ラベルです (存在する場合)。 |
AddressValue_V30
住所フィールドの値です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
houseNumber
|
houseNumber | string |
番地または建物番号です。 |
|
poBox
|
poBox | string |
私書箱番号。 |
|
道路
|
road | string |
町名。 |
|
市
|
city | string |
市区町村などの名前です。 |
|
州
|
state | string |
第 1 レベルの行政区画です。 |
|
郵便番号
|
postalCode | string |
メールの並べ替えに使用される郵便番号です。 |
|
countryRegion
|
countryRegion | string |
国または地域です。 |
|
streetAddress
|
streetAddress | string |
ストリート名レベルの住所です。市区町村、都道府県、国地域、郵便番号を除きます。 |
|
cityDistrict
|
cityDistrict | string |
都市の市区町間、例: ニューヨークのブルックリン、ロンドンのシティ・オブ・ウェストミンスター。 |
|
家屋
|
house | string |
建物名 (世界貿易センターなど)。 |
|
level
|
level | string |
階数 (3 階など)。 |
|
stateDistrict
|
stateDistrict | string |
特定のロケールで使用される第 2 レベルの行政区分です。 |
|
suburb
|
suburb | string |
非公式の町内の名前 (チャイナタウンなど)。 |
|
unit
|
unit | string |
アパートまたは事務所の番号。 |