次の方法で共有

Azure AI ドキュメント インテリジェンス (フォーム認識エンジン)

PDF、画像、Microsoft Office ドキュメント、フォームからテキスト (印刷および手書き OCR) と追加情報 (テーブル、チェックボックス、フィールド、キー値のペア) を抽出し、事前トレーニング済みのモデル (レイアウト、請求書、領収書、ID、名刺) または AI を利用したドキュメント理解を使用して代表的なトレーニング フォームのセットによって作成されたカスタム モデルに基づいて構造化データに抽出します。

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Standard 次を除くすべての Power Automate リージョン :
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - 米国国防総省 (DoD)
Power Apps - 利用できません
Power Automate（パワーオートメート） Standard 次を除くすべての Power Automate リージョン :
     - 米国国防総省 (DoD)
お問い合わせ
名前 Microsoft
URL https://aka.ms/formrecognizer
Email formrecog_contact@microsoft.com
コネクタ メタデータ
Publisher Microsoft
Website https://aka.ms/formrecognizer
プライバシー ポリシー https://aka.ms/form-recognizer/privacy
カテゴリ 人工知能;ビジネス インテリジェンス

Azure AI ドキュメント インテリジェンス (旧称 Form Recognizer) コネクタは、 Azure AI ドキュメント インテリジェンスへの統合を提供します。 フォーム、請求書、領収書、名刺、ID ドキュメント、およびその他の複数のドキュメントの種類から情報を分析および抽出できます。

[前提条件]

この統合を使用するには、Azure portal で Azure AI ドキュメント インテリジェンス リソース が必要です。 リソース リンクを作成します。 アプリケーションを認証するためのエンドポイントとキーを取得します。 接続するには、アカウント キーとサイト URL を指定し、[接続の 作成] を選択します。 接続の操作コストについては、 こちらをご覧ください。

資格情報を取得する方法

  1. Azure portal でドキュメント インテリジェンス リソースを開きます ( 前提条件を参照)。
  2. [リソース管理] で [キーとエンドポイント] を選択する
  3. エンドポイントとキーをコピーし、それらを使用して新しい接続を作成します。

コネクタの概要

ドキュメント インテリジェンス コネクタを試す最も簡単な方法は、事前構築済みのモデル (事前構築済みの請求書、事前構築済みのレイアウトなど) を使用することです。 文書の PDF または画像を入力します。 ドキュメントの種類に基づいてコネクタ操作を使用して分析し、検出されたフィールドを検査します。 モデルとサポートされている機能の完全な一覧 については、こちらをご覧ください。

接続を作成する

コネクタでは、次の認証の種類がサポートされています。
API キー Document Intellignce リソース名と API キーを指定します。 すべてのリージョン 共有可能
ロジック アプリのマネージド ID LogicApps マネージド ID を使用して接続を作成する LOGICAPPS のみ 共有可能
Microsoft Entra ID 統合 Microsoft Entra ID を使用してアクセスする すべてのリージョン 共有不可
既定 [非推奨] このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。 すべてのリージョン 共有不可

API キー

認証 ID: keyBasedAuth

適用対象: すべてのリージョン

Document Intellignce リソース名と API キーを指定します。

これは共有可能な接続です。 電源アプリが別のユーザーと共有されている場合は、接続も共有されます。 詳細については、 キャンバス アプリのコネクタの概要 - Power Apps |Microsoft Docs

名前 タイプ Description 必須
アカウント キー securestring ドキュメント インテリジェンス アカウント キー 正しい
エンドポイント URL 文字列 ドキュメント インテリジェンス エンドポイント URL (例: https://your-documentintelligence-resource.cognitiveservices.azure.com/) 正しい

Logic Apps マネージド ID

認証 ID: managedIdentityAuth

適用: LOGICAPPS のみ

LogicApps マネージド ID を使用して接続を作成する

これは共有可能な接続です。 電源アプリが別のユーザーと共有されている場合は、接続も共有されます。 詳細については、 キャンバス アプリのコネクタの概要 - Power Apps |Microsoft Docs

名前 タイプ Description 必須
LogicApps マネージド ID managedIdentity Logic Apps マネージド ID を使用してサインインする 正しい
エンドポイント URL 文字列 ドキュメント インテリジェンス エンドポイント URL (例: https://your-documentintelligence-resource.cognitiveservices.azure.com/) 正しい

Microsoft Entra ID 統合

認証 ID: oauth

適用対象: すべてのリージョン

Microsoft Entra ID を使用してアクセスする

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
エンドポイント URL 文字列 ドキュメント インテリジェンス エンドポイント URL (例: https://your-documentintelligence-resource.cognitiveservices.azure.com/) 正しい

既定 [非推奨]

適用対象: すべてのリージョン

このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
アカウント キー securestring ドキュメント インテリジェンス アカウント キー 正しい
エンドポイント URL 文字列 ドキュメント インテリジェンス エンドポイント URL (例: https://your-documentintelligence-resource.cognitiveservices.azure.com/) 正しい

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 1200 60 秒

アクション

ID ドキュメントの分析 (非推奨) [非推奨]

特定の ID ドキュメントからフィールド テキストとセマンティック値を抽出します (非推奨)。
カスタム フォームの分析 (非推奨) [非推奨]

特定のドキュメントからキーと値のペア、テーブル、およびセマンティック値を抽出します (非推奨)。
ドキュメント分類子を使用してドキュメントを分類する (v3.1 API)

ドキュメント分類子 (v3.1 API) を使用してドキュメントを分類します。
ドキュメント分類子を使用してドキュメントを分類する (v4.x API)

ドキュメント分類子 (v4.x API) を使用してドキュメントを分類します。
レイアウトの分析 (非推奨) [非推奨]

特定のドキュメントからテキストとレイアウト情報を抽出します (非推奨)。
レシートの分析 (非推奨) [非推奨]

特定のレシート ドキュメントからフィールド テキストとセマンティック値を抽出します (非推奨)。
事前構築済みモデルまたはカスタム モデルのドキュメントの分析 (v3.x API)

特定のドキュメント (v3.x API) からキーと値のペア、テーブル、およびセマンティック値を抽出します。
事前構築済みモデルまたはカスタム モデルのドキュメントの分析 (v4.x API)

特定のドキュメント (v4.x API) からキーと値のペア、テーブル、およびセマンティック値を抽出します。
名刺の分析 (非推奨) [非推奨]

特定の名刺ドキュメントからフィールド テキストとセマンティック値を抽出します (非推奨)。
請求書の分析 (非推奨) [非推奨]

特定の請求書ドキュメントからフィールド テキストとセマンティック値を抽出します (非推奨)。

ID ドキュメントの分析 (非推奨) [非推奨]

操作 ID:
AnalyzeIdDocumentAsync

特定の ID ドキュメントからフィールド テキストとセマンティック値を抽出します (非推奨)。

パラメーター

名前 キー 必須 型 説明
テキストの詳細を含める
 includeTextDetails boolean

結果にテキスト行と要素参照を含めます。 既定値: True (FR コネクタの場合のみ)。
ページ
 pages string

複数ページの PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力して(例: '2, 5-7')、個々のページとページの範囲 (ページ 2、ページ 5 から 7 など) から請求書情報を抽出します。 設定されていない場合は、すべてのページが処理されます。
ドキュメント/イメージ ファイルの内容
 inputFileContent binary

分析する PDF ドキュメントまたは画像 (JPG または PNG) ファイル。
ドキュメント/イメージの URL
 inputFileUrl string

入力ファイルの URL パス。 ドキュメント/イメージ ファイル コンテンツの代わりに使用できます。

戻り値

キューに登録された分析操作の状態と結果。

Body
IdAnalyzeOperationResult

カスタム フォームの分析 (非推奨) [非推奨]

操作 ID:
AnalyzeWithCustomForm

特定のドキュメントからキーと値のペア、テーブル、およびセマンティック値を抽出します (非推奨)。

パラメーター

名前 キー 必須 型 説明
モデル識別子
 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 パス。 ドキュメント/イメージ ファイル コンテンツの代わりに使用できます。

戻り値

キューに登録された分析操作の状態と結果。

Body
CustomFormsAnalyzeOperationResult

ドキュメント分類子を使用してドキュメントを分類する (v3.1 API)

操作 ID:
ClassifyDocumentV31

ドキュメント分類子 (v3.1 API) を使用してドキュメントを分類します。

パラメーター

名前 キー 必須 型 説明
分類子識別子
 classifierId True string

形式 - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}。 一意の分類子名。
ページ
 pages string

複数ページの PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力して(例: '2, 5-7')、個々のページとページの範囲 (ページ 2、5 から 7 など) から情報を抽出します。 設定されていない場合は、すべてのページが処理されます。
ロケール
 locale string

テキスト認識とドキュメント分析のロケール ヒント。 値には、言語コード (例: "en"、"fr") または BCP 47 言語タグ (例: "en-US") のみを含むことができます。
文字列インデックスの種類
 stringIndexType string

文字列のオフセットと長さを計算するために使用されるメソッド。 サポートされているオプション: textElements、unicodeCodePoint、utf16CodeUnit。
ドキュメント/イメージ ファイルの内容
 inputFileContent binary

分析する PDF ドキュメントまたは画像 (JPG、PNG、BMP、TIFF) ファイル。
ドキュメント/イメージの URL
 inputFileUrl string

入力ファイルの URL パス。 ドキュメント/イメージ ファイル コンテンツの代わりに使用できます。

戻り値

分析操作の状態と結果。

Body
AnalyzeResultOperation_V30

ドキュメント分類子を使用してドキュメントを分類する (v4.x API)

操作 ID:
ClassifyDocumentV40

ドキュメント分類子 (v4.x API) を使用してドキュメントを分類します。

パラメーター

名前 キー 必須 型 説明
ドキュメント インテリジェンス API のバージョン
 api-version True string

ドキュメント インテリジェンス API のバージョン。
分類子識別子
 classifierId True string

形式 - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}。 一意の分類子名。
ドキュメント/イメージ ファイルの内容
 inputFileContent binary

分析する PDF ドキュメントまたは画像 (JPG、PNG、BMP、TIFF) ファイル。
ドキュメント/イメージの URL
 inputFileUrl string

入力ファイルの URL パス。 ドキュメント/イメージ ファイル コンテンツの代わりに使用できます。
分割モード
 split string

ファイル分割の動作。
ページ
 pages string

複数ページの PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力して(例: '2, 5-7')、個々のページとページの範囲 (ページ 2、5 から 7 など) から情報を抽出します。 設定されていない場合は、すべてのページが処理されます。
ロケール
 locale string

テキスト認識とドキュメント分析のロケール ヒント。 値には、言語コード (例: "en"、"fr") または BCP 47 言語タグ (例: "en-US") のみを含むことができます。
文字列インデックスの種類
 stringIndexType string

文字列のオフセットと長さを計算するために使用されるメソッド。 サポートされているオプション: textElements、unicodeCodePoint、utf16CodeUnit。

戻り値

分析操作の状態と結果。

Body
AnalyzeResultOperation_V30

レイアウトの分析 (非推奨) [非推奨]

操作 ID:
AnalyzeLayoutAsync

特定のドキュメントからテキストとレイアウト情報を抽出します (非推奨)。

パラメーター

名前 キー 必須 型 説明
ページ
 pages string

複数ページの PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力して(例: '2, 5-7')、個々のページとページの範囲 (ページ 2、ページ 5 から 7 など) から請求書情報を抽出します。 設定されていない場合は、すべてのページが処理されます。
Language
 language string

ドキュメント内のテキストの BCP-47 言語コード。
読み取り順序
 readingOrder string

抽出テキスト要素を並べ替えるときに適用する読み取り順序アルゴリズムを指定する省略可能なパラメーター。 "basic" または "natural" を指定できます。 指定しない場合、既定値は basic になります。
ドキュメント/イメージ ファイルの内容
 inputFileContent binary

分析する PDF ドキュメントまたは画像 (JPG または PNG) ファイル。
ドキュメント/イメージの URL
 inputFileUrl string

入力ファイルの URL パス。 ドキュメント/イメージ ファイル コンテンツの代わりに使用できます。

戻り値

キューに登録された分析操作の状態と結果。

Body
LayoutAnalyzeOperationResult

レシートの分析 (非推奨) [非推奨]

操作 ID:
AnalyzeReceiptAsync

特定のレシート ドキュメントからフィールド テキストとセマンティック値を抽出します (非推奨)。

パラメーター

名前 キー 必須 型 説明
テキストの詳細を含める
 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 パス。 ドキュメント/イメージ ファイル コンテンツの代わりに使用できます。

戻り値

キューに登録された分析操作の状態と結果。

Body
ReceiptAnalyzeOperationResult

事前構築済みモデルまたはカスタム モデルのドキュメントの分析 (v3.x API)

操作 ID:
AnalyzeDocumentV30

特定のドキュメント (v3.x API) からキーと値のペア、テーブル、およびセマンティック値を抽出します。

パラメーター

名前 キー 必須 型 説明
ドキュメント インテリジェンス API のバージョン
 api-version True string

ドキュメント インテリジェンス API のバージョン。
モデル識別子
 modelId True string

事前構築済み modelIds: 事前構築済み読み取り、事前構築済みレイアウト、事前構築済みドキュメント、事前構築済み businessCard、事前構築済み idDocument、事前構築済み請求書、事前構築済みレシート、事前構築済みの tax.us.w2、prebuilt-vaccinationCard、prebuilt-healthInsuranceCard.us。 カスタム modelId 形式 - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}。 一意のモデル名。
ページ
 pages string

複数ページの PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力して(例: '2, 5-7')、個々のページとページの範囲 (ページ 2、ページ 5 から 7 など) から請求書情報を抽出します。 設定されていない場合は、すべてのページが処理されます。
ロケール
 locale string

テキスト認識とドキュメント分析のロケール ヒント。 値には、言語コード (例: "en"、"fr") または BCP 47 言語タグ (例: "en-US") のみを含むことができます。
文字列インデックスの種類
 stringIndexType string

文字列のオフセットと長さを計算するために使用されるメソッド。 サポートされているオプション: textElements、unicodeCodePoint、utf16CodeUnit。
オプション機能と Premium 機能
 features array

オプションの分析機能の一覧 (ocrHighResolution、言語、バーコード、数式、keyValuePairs、styleFont など)。
ドキュメント/イメージ ファイルの内容
 inputFileContent binary

分析する PDF ドキュメントまたは画像 (JPG、PNG、BMP、TIFF) ファイル。
ドキュメント/イメージの URL
 inputFileUrl string

入力ファイルの URL パス。 ドキュメント/イメージ ファイル コンテンツの代わりに使用できます。

戻り値

分析操作の状態と結果。

Body
AnalyzeResultOperation_V30

事前構築済みモデルまたはカスタム モデルのドキュメントの分析 (v4.x API)

操作 ID:
AnalyzeDocumentV40

特定のドキュメント (v4.x API) からキーと値のペア、テーブル、およびセマンティック値を抽出します。

パラメーター

名前 キー 必須 型 説明
ドキュメント インテリジェンス API のバージョン
 api-version True string

ドキュメント インテリジェンス API のバージョン。
モデル識別子
 modelId True string

事前構築済み modelIds: 事前構築済み読み取り、 事前構築済みレイアウト、事前構築済み businessCard、事前構築済み idDocument、事前構築済み請求書、事前構築済みレシート、事前構築済み tax.us.w2、事前構築済み vat.us.w2、prebuilt-healthInsuranceCard.us、事前構築済み tax.us.1098、事前構築済み tax.us.1098E、事前構築済み tax.us.1098T、事前構築済み契約など。カスタム modelId 形式 - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}。 一意のモデル名。
ドキュメント/イメージ ファイルの内容
 inputFileContent binary

分析する PDF ドキュメントまたは画像 (JPG、PNG、BMP、TIFF) ファイル。
ドキュメント/イメージの URL
 inputFileUrl string

入力ファイルの URL パス。 ドキュメント/イメージ ファイル コンテンツの代わりに使用できます。
ページ
 pages string

複数ページの PDF および TIFF ドキュメントのページ選択。ページ番号と範囲をコンマで区切って入力して(例: '2, 5-7')、個々のページとページの範囲 (ページ 2、ページ 5 から 7 など) から請求書情報を抽出します。 設定されていない場合は、すべてのページが処理されます。
ロケール
 locale string

テキスト認識とドキュメント分析のロケール ヒント。 値には、言語コード (例: "en"、"fr") または BCP 47 言語タグ (例: "en-US") のみを含むことができます。
文字列インデックスの種類
 stringIndexType string

文字列のオフセットと長さを計算するために使用されるメソッド。 サポートされているオプション: textElements、unicodeCodePoint、utf16CodeUnit。
オプション機能と Premium 機能
 features array

オプションの分析機能の一覧 (ocrHighResolution、言語、バーコード、数式、keyValuePairs、styleFont、queryFields など)。
クエリ フィールド
 queryFields array

抽出する追加フィールドの一覧。 例: "NumberOfGuests,StoreNumber"
出力コンテンツの形式
 outputContentFormat string

分析結果の最上位コンテンツの形式。

戻り値

分析操作の状態と結果。

Body
AnalyzeResultOperation_V30

名刺の分析 (非推奨) [非推奨]

操作 ID:
AnalyzeBusinessCardAsync

特定の名刺ドキュメントからフィールド テキストとセマンティック値を抽出します (非推奨)。

パラメーター

名前 キー 必須 型 説明
テキストの詳細を含める
 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 パス。 ドキュメント/イメージ ファイル コンテンツの代わりに使用できます。

戻り値

キューに登録された分析操作の状態と結果。

Body
BusinessCardAnalyzeOperationResult

請求書の分析 (非推奨) [非推奨]

操作 ID:
AnalyzeInvoice

特定の請求書ドキュメントからフィールド テキストとセマンティック値を抽出します (非推奨)。

パラメーター

名前 キー 必須 型 説明
テキストの詳細を含める
 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 パス。 ドキュメント/イメージ ファイル コンテンツの代わりに使用できます。

戻り値

キューに登録された分析操作の状態と結果。

Body
InvoiceAnalyzeOperationResult

定義

OperationStatus

キューに登録された操作の状態。

キューに登録された操作の状態。

string

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
 page integer

入力ドキュメント内の 1 から始まるページ番号。
角
 angle float

時計回りの方向のテキストの一般的な向き。(-180, 180] の間の度数で測定されます。
width
 width float

イメージ/PDF の幅 (ピクセル/インチ単位)。
高さ
 height float

画像/PDF の高さ (ピクセル/インチ単位)。
ユニット
 unit string

幅、高さ、および boundingBox プロパティで使用される単位。 画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "inch" です。
台詞
 lines array of TextLine

includeTextDetails が true に設定されている場合、認識されるテキスト行の一覧。 返される行の最大数は、1 ページあたり 300 行です。 行は上から下、左から右に並べ替えられますが、場合によっては近接性が高い優先順位で扱われます。 並べ替え順序は検出されたテキストに依存するため、画像や OCR バージョンの更新によって変更される可能性があります。 したがって、ビジネス ロジックは、順序ではなく、実際の行の場所に基づいて構築する必要があります。

TextLine

抽出されたテキスト行を表すオブジェクト。

名前 パス 型 説明
SMS 送信
 text string

行のテキスト コンテンツ。
boundingBox
 boundingBox BoundingBox

元の画像の左上を基準にして座標を指定した四角形の境界ボックス。 8 つの数値は、テキストの向きを基準にして左上隅から時計回りに 4 つのポイントを表します。 画像の場合、(x, y) 座標はピクセル単位で測定されます。 PDF の場合、(x, y) 座標はインチ単位で測定されます。
words
 words array of TextWord

テキスト行内の単語の一覧。

TextWord

単語を表すオブジェクト。

名前 パス 型 説明
SMS 送信
 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
 page integer

ページ番号。
clusterId
 clusterId integer

クラスター識別子。
keyValuePairs (キー値ペア)
 keyValuePairs array of KeyValuePair

ページから抽出されたキーと値のペアの一覧。
tables
 tables array of DataTable

ページから抽出されたデータ テーブルの一覧。

KeyValuePair

抽出されたキーと値のペアに関する情報。

名前 パス 型 説明
ラベル
 label string

キー/値ペア エントリのユーザー定義ラベル。
キー
 key KeyValueElement

キーと値のペアで抽出されたキーまたは値に関する情報。
value
 value KeyValueElement

キーと値のペアで抽出されたキーまたは値に関する情報。
信頼度
 confidence Confidence

信頼度の値。

KeyValueElement

キーと値のペアで抽出されたキーまたは値に関する情報。

名前 パス 型 説明
SMS 送信
 text string

キーまたは値のテキスト コンテンツ。
boundingBox
 boundingBox BoundingBox

元の画像の左上を基準にして座標を指定した四角形の境界ボックス。 8 つの数値は、テキストの向きを基準にして左上隅から時計回りに 4 つのポイントを表します。 画像の場合、(x, y) 座標はピクセル単位で測定されます。 PDF の場合、(x, y) 座標はインチ単位で測定されます。
元素
 elements array of ElementReference

includeTextDetails が true に設定されている場合、このキーまたは値を構成するテキスト要素への参照のリスト。

ElementReference

行または単語への参照。

行または単語への参照。

string

DataTable

ページに含まれる抽出されたテーブルに関する情報。

名前 パス 型 説明
行
 rows integer

行数。
columns
 columns integer

列の数。
細胞
 cells array of DataTableCell

テーブルに含まれるセルの一覧。

DataTableCell

テーブル内の抽出されたセルに関する情報。

名前 パス 型 説明
rowIndex
 rowIndex integer

セルの行インデックス。
columnIndex
 columnIndex integer

セルの列インデックス。
rowスパン
 rowSpan integer

このセルがまたがる行の数。
columnSpan
 columnSpan integer

このセルがまたがる列の数。
SMS 送信
 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
 fields InvoiceFields

2.1 の請求書フィールド。

BusinessCardDocumentResult

入力ドキュメントに対応する抽出されたフィールドのセット。

名前 パス 型 説明
docType
 docType string

ドキュメントの種類。
pageRange
 pageRange array of integer

ドキュメントが見つかった最初と最後のページ番号。
fields
 fields BusinessCardFields

2.1 の BusinessCard フィールド。

CustomFormsDocumentResult

入力ドキュメントに対応する抽出されたフィールドのセット。

名前 パス 型 説明
docType
 docType string

ドキュメントの種類。
pageRange
 pageRange array of integer

ドキュメントが見つかった最初と最後のページ番号。
Fields
 _fields array of CustomFormsFields

fieldName プロパティと fieldValue プロパティを持つフィールドの配列。

ReceiptDocumentResult

入力ドキュメントに対応する抽出されたフィールドのセット。

名前 パス 型 説明
docType
 docType string

ドキュメントの種類。
pageRange
 pageRange array of integer

ドキュメントが見つかった最初と最後のページ番号。
fields
 fields ReceiptFields

2.1 のレシートフィールド。

IdDocumentResult

入力ドキュメントに対応する抽出されたフィールドのセット。

名前 パス 型 説明
docType
 docType string

ドキュメントの種類。
pageRange
 pageRange array of integer

ドキュメントが見つかった最初と最後のページ番号。
fields
 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

モデルが予測にどの程度自信を持っているか。
Description
 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 の BusinessCard フィールド。

名前 パス 型 説明
連絡先名
 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
 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

電子メールの配列
Email
 Emails.valueArray.text string
電子メールの信頼度
 Emails.valueArray.confidence float

モデルが予測にどの程度自信を持っているか。
Web サイト
 Websites.valueArray array of object

Web サイトの配列
Website
 Websites.valueArray.text string
Web サイトの信頼度
 Websites.valueArray.confidence float

モデルが予測にどの程度自信を持っているか。
Addresses
 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 の配列
ファクス
 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

モデルが予測にどの程度自信を持っているか。
Price (テキスト)
 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
 Nationality.valueCountryRegion string
国籍の信頼度
 Nationality.confidence float

モデルが予測にどの程度自信を持っているか。
Sex
 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

整数値。
SMS 送信
 text string
boundingBox
 boundingBox BoundingBox

元の画像の左上を基準にして座標を指定した四角形の境界ボックス。 8 つの数値は、テキストの向きを基準にして左上隅から時計回りに 4 つのポイントを表します。 画像の場合、(x, y) 座標はピクセル単位で測定されます。 PDF の場合、(x, y) 座標はインチ単位で測定されます。
信頼度
 confidence Confidence

信頼度の値。
元素
 elements array of ElementReference

includeTextDetails が true に設定されている場合、このフィールドを構成するテキスト要素への参照のリスト。
page
 page integer

入力ドキュメント内の 1 から始まるページ番号。

FieldValueType

フィールド値のセマンティック データ型。

フィールド値のセマンティック データ型。

string

信頼度

信頼度の値。

信頼度の値。

float

ApiVersion_V30

API バージョン。

API バージョン。

string

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

すべてのテキスト要素とビジュアル要素の文字列表現を読み取り順に連結します。
コンテンツフォーマット
 contentFormat ContentFormat_V40

分析された結果のコンテンツの形式。
pages
 pages array of DocumentPage_V30

分析されたページ。
段落
 paragraphs array of DocumentParagraph_V30

抽出された段落。
tables
 tables array of DocumentTable_V30

抽出されたテーブル。
計数
 figures array of DocumentFigure_V40

抽出された図。
セクション
 sections array of DocumentSection_V40

抽出されたセクション。
keyValuePairs (キー値ペア)
 keyValuePairs array of DocumentKeyValuePair_V30

抽出されたキーと値のペア。
エンティティ
 entities array of DocumentEntity_V30

抽出されたエンティティ。
スタイル
 styles array of DocumentStyle_V30

抽出されたフォント スタイル。
言語
 languages array of DocumentLanguage_V30

検出された言語。
書類
 documents array of Document_V30

抽出されたドキュメント。
警告
 warnings array of Warning_V40

発生した警告の一覧。

DocumentPage_V30

入力からページから抽出されたコンテンツ要素とレイアウト要素。

名前 パス 型 説明
kind
 kind string

ドキュメント ページの種類。
pageNumber
 pageNumber integer

入力ドキュメント内の 1 から始まるページ番号。
角
 angle number

時計回りの方向のコンテンツの一般的な向き。(-180, 180] の間の度数で測定されます。
width
 width number

イメージ/PDF の幅 (ピクセル/インチ単位)。
高さ
 height number

画像/PDF の高さ (ピクセル/インチ単位)。
ユニット
 unit string

幅、高さ、および多角形のプロパティで使用される単位。 画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "inch" です。
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内のページの場所。
words
 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
 formulas array of DocumentFormula_V31

ページから抽出された数式。

DocumentWord_V30

連続する文字シーケンスで構成される単語オブジェクト。 中国語、日本語、韓国語などのスペース区切り以外の言語の場合、各文字は独自の単語として表されます。

名前 パス 型 説明
コンテンツ
 content string

単語のテキスト コンテンツ。
多角形
 polygon BoundingPolygon_V30

ページの左上を基準にして座標を指定した境界ポリゴン。 この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
span
 span DocumentSpan_V30

オフセットと長さとして指定された、連結されたコンテンツ プロパティの連続した領域。
信頼度
 confidence Confidence_V30

予測の信頼度。

DocumentSelectionMark_V30

チェック ボックス、ラジオ ボタン、および選択範囲を示すその他の要素を表す選択マーク オブジェクト。

名前 パス 型 説明
状態
 state DocumentSelectionMarkState_V30

選択マークの状態。
多角形
 polygon BoundingPolygon_V30

ページの左上を基準にして座標を指定した境界ポリゴン。 この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
span
 span DocumentSpan_V30

オフセットと長さとして指定された、連結されたコンテンツ プロパティの連続した領域。
信頼度
 confidence Confidence_V30

予測の信頼度。

DocumentImage_V30

ページで検出された画像オブジェクト。

名前 パス 型 説明
多角形
 polygon BoundingPolygon_V30

ページの左上を基準にして座標を指定した境界ポリゴン。 この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
span
 span DocumentSpan_V30

オフセットと長さとして指定された、連結されたコンテンツ プロパティの連続した領域。
pageRef
 pageRef integer

イメージの内容を含むグローバル ページ配列の 0 から始まるインデックス。
信頼度
 confidence Confidence_V30

予測の信頼度。

DocumentSelectionMarkState_V30

選択マークの状態。

選択マークの状態。

string

DocumentStyle_V30

観察されたテキスト スタイルを表すオブジェクト。

名前 パス 型 説明
backgroundColor
 backgroundColor string

背景色 #rrggbb 16 進数の形式で表示されます。.
color
 color string

前景色 (#rrggbb 16 進形式)。
fontStyle
 fontStyle string

フォント スタイル。
fontWeight
 fontWeight string

フォントの太さ。
isHandwritten
 isHandwritten boolean

コンテンツが手書きです。
similarFontFamily
 similarFontFamily string

サポートされている一連のフォント ファミリの中から視覚的に最も似たフォントで、CSS 規則 (例: "Arial, sans-serif") に従ってフォールバック フォントを使用します。
spans
 spans array of DocumentSpan_V30

スタイルが適用される連結コンテンツ内のテキスト要素の場所。
信頼度
 confidence Confidence_V30

予測の信頼度。

DocumentLanguage_V30

特定のテキスト スパンで検出された言語を表すオブジェクト。

名前 パス 型 説明
ロケール
 locale string

検出された言語。 値には、ISO 639-1 言語コード (例: "en"、"fr") または BCP 47 言語タグ (例: "zh-Hans") を指定できます。
spans
 spans array of DocumentSpan_V30

言語が適用される連結コンテンツ内のテキスト要素の場所。
信頼度
 confidence Confidence_V30

予測の信頼度。

DocumentLine_V30

隣接するコンテンツ要素のシーケンス (単語や選択記号など) で構成されるコンテンツ行オブジェクトです。

名前 パス 型 説明
コンテンツ
 content string

読み取り順序で含まれる要素の連結されたコンテンツ。
多角形
 polygon BoundingPolygon_V30

ページの左上を基準にして座標を指定した境界ポリゴン。 この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内の行の場所。

DocumentParagraph_V30

一般的に、一般的な配置と間隔を持つ連続した行で構成される段落オブジェクト。

名前 パス 型 説明
ロール
 role string

段落のセマンティック ロール。
コンテンツ
 content string

読み取り順に段落の連結されたコンテンツ。
boundingRegions
 boundingRegions array of BoundingRegion_V30

段落をカバーする境界領域。
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内の段落の場所。

DocumentTable_V30

四角形のレイアウトに配置されたテーブル セルで構成されるテーブル オブジェクト。

名前 パス 型 説明
rowCount
 rowCount integer

テーブル内の行数。
columnCount
 columnCount integer

テーブル内の列の数。
細胞
 cells array of DocumentTableCell_V30

テーブル内に含まれるセル。
キャプション
 caption DocumentCaption_V30

表のキャプションの場所と内容を表すオブジェクト。
脚注
 footnotes array of DocumentFootnote_V30

テーブルに関連付けられている脚注。
boundingRegions
 boundingRegions array of BoundingRegion_V30

テーブルをカバーする境界領域。
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内のテーブルの場所。

DocumentTableCell_V30

テーブル セルの場所と内容を表すオブジェクト。

名前 パス 型 説明
kind
 kind string

[テーブル] セルの種類。
rowIndex
 rowIndex integer

セルの行インデックス。
columnIndex
 columnIndex integer

セルの列インデックス。
rowスパン
 rowSpan integer

このセルがまたがる行の数。
columnSpan
 columnSpan integer

このセルがまたがる列の数。
コンテンツ
 content string

表のセルの内容を読み取り順に連結しました。
boundingRegions
 boundingRegions array of BoundingRegion_V30

テーブル セルをカバーする境界領域。
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内のテーブル セルの場所。

DocumentCaption_V30

表のキャプションの場所と内容を表すオブジェクト。

名前 パス 型 説明
コンテンツ
 content string

表のキャプションの内容。
boundingRegions
 boundingRegions array of BoundingRegion_V30

テーブルキャプションをカバーする境界領域。
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内のテーブル キャプションの場所。

DocumentFootnote_V30

表の脚注の場所と内容を表すオブジェクト。

名前 パス 型 説明
コンテンツ
 content string

表脚注の内容。
boundingRegions
 boundingRegions array of BoundingRegion_V30

表の脚注をカバーする境界領域。
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内の表脚注の場所。

DocumentKeyValuePair_V30

個別のフィールド ラベル (キー) とフィールド値 (空の場合があります) を持つフォーム フィールドを表すオブジェクト。

名前 パス 型 説明
キー
 key DocumentKeyValueElement_V30

キーと値のペアのフィールド キーまたは値を表すオブジェクト。
value
 value DocumentKeyValueElement_V30

キーと値のペアのフィールド キーまたは値を表すオブジェクト。
信頼度
 confidence Confidence_V30

予測の信頼度。

DocumentKeyValueElement_V30

キーと値のペアのフィールド キーまたは値を表すオブジェクト。

名前 パス 型 説明
コンテンツ
 content string

読み取り順序でキーと値の要素の連結されたコンテンツ。
boundingRegions
 boundingRegions array of BoundingRegion_V30

キーと値の要素をカバーする境界領域。
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内のキーと値の要素の場所。

DocumentEntity_V30

エンティティのさまざまなカテゴリを表すオブジェクト。

名前 パス 型 説明
カテゴリ
 category string

エンティティの種類です。
サブカテゴリ
 subCategory string

エンティティのサブタイプ。
コンテンツ
 content string

エンティティのコンテンツ。
boundingRegions
 boundingRegions array of BoundingRegion_V30

エンティティをカバーする境界領域。
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内のエンティティの場所。
信頼度
 confidence Confidence_V30

予測の信頼度。

DocumentBarcode_V31

バーコード オブジェクト。

名前 パス 型 説明
信頼度
 confidence Confidence_V30

予測の信頼度。
kind
 kind string

バーコードの種類。
多角形
 polygon BoundingPolygon_V30

ページの左上を基準にして座標を指定した境界ポリゴン。 この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
span
 span DocumentSpan_V30

オフセットと長さとして指定された、連結されたコンテンツ プロパティの連続した領域。
value
 value string

バーコード値

DocumentFormula_V31

数式オブジェクト。

名前 パス 型 説明
信頼度
 confidence Confidence_V30

予測の信頼度。
kind
 kind string

数式の種類。
多角形
 polygon BoundingPolygon_V30

ページの左上を基準にして座標を指定した境界ポリゴン。 この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
span
 span DocumentSpan_V30

オフセットと長さとして指定された、連結されたコンテンツ プロパティの連続した領域。
value
 value string

式を記述する LaTex 式。

DocumentFigure_V40

文書内の図形を表すオブジェクト。

名前 パス 型 説明
boundingRegions
 boundingRegions array of BoundingRegion_V30

図をカバーする境界領域。
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内の図の位置。
元素
 elements array of DocumentElement_V40

図表番号または脚注を除く、図の子要素。
キャプション
 caption DocumentCaption_V30

表のキャプションの場所と内容を表すオブジェクト。
脚注
 footnotes array of DocumentFootnote_V30

図に関連付けられている脚注の一覧。
id
 id string

図 ID。

DocumentSection_V40

ドキュメント内のセクションを表すオブジェクト。

名前 パス 型 説明
spans
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内のセクションの場所。
元素
 elements array of DocumentElement_V40

セクションの子要素。

DocumentElement_V40

ドキュメントの要素 (段落、テーブル、セクションなど) を参照する JSON ポインター。

ドキュメントの要素 (段落、テーブル、セクションなど) を参照する JSON ポインター。

string

Warning_V40

エラー オブジェクト。

名前 パス 型 説明
コード
 code string

サーバー定義の警告コードのセットの 1 つ。
メッセージ
 message string

警告の人間が判読できる表現。
ターゲット
 target string

エラーのターゲット。

ContentFormat_V40

分析された結果のコンテンツの形式。

分析された結果のコンテンツの形式。

string

Document_V30

ドキュメントの場所とセマンティック コンテンツを記述するオブジェクト。

名前 パス 型 説明
docType
 docType DocType_V30

ドキュメントの種類の名前。
boundingRegions
 boundingRegions array of BoundingRegion_V30

ドキュメントをカバーする境界領域。
spans
 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

フィールド値のセマンティック データ型。

フィールド値のセマンティック データ型。

string

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
 spans array of DocumentSpan_V30

読み取り順序の連結されたコンテンツ内のフィールドの場所。
信頼度
 confidence Confidence_V30

予測の信頼度。

Confidence_V30

予測の信頼度。

予測の信頼度。

number

DocType_V30

ドキュメントの種類の名前。

ドキュメントの種類の名前。

string

DocumentSpan_V30

オフセットと長さとして指定された、連結されたコンテンツ プロパティの連続した領域。

名前 パス 型 説明
オフセット
 offset integer

スパンで表されるコンテンツの 0 から始まるインデックス。
length
 length integer

スパンで表されるコンテンツ内の文字数。

StringIndexType_V30

文字列のオフセットと長さを計算するために使用されるメソッド。

文字列のオフセットと長さを計算するために使用されるメソッド。

string

ModelId_V30

一意のモデル名。

一意のモデル名。

string

Error_V30

エラー情報。

名前 パス 型 説明
コード
 code string

エラー コード。
メッセージ
 message string

エラー メッセージ。
ターゲット
 target string

エラーのターゲットです。
details
 details array of InnerError_V30

詳細なエラーの一覧。
innererror
 innererror InnerError_V30

詳細なエラー。

InnerError_V30

詳細なエラー。

名前 パス 型 説明
コード
 code string

エラー コード。
メッセージ
 message string

エラー メッセージ。

CurrencyValue_V30

通貨フィールドの値。

名前 パス 型 説明
量
 amount double

通貨金額。
通貨コード
 currencyCode string

解決済みの通貨コード (ISO 4217) がある場合。
currencySymbol
 currencySymbol string

通貨記号ラベル (存在する場合)。

AddressValue_V30

アドレス フィールドの値。

名前 パス 型 説明
houseNumber
 houseNumber string

住宅番号または建物番号。
poBox
 poBox string

オフィスボックス番号を転記します。
道路
 road string

番地。
city
 city string

都市、町、村などの名前。
状態
 state string

第 1 レベルの管理部門。
postalCode
 postalCode string

メールの並べ替えに使用する郵便番号。
countryRegion
 countryRegion string

国または地域。
住所
 streetAddress string

市区町村、都道府県、国番号、郵便番号を除く、番地レベルの住所。
cityDistrict
 cityDistrict string

ニューヨーク市のブルックリンやロンドンのウェストミンスター市など、都市内の地区または自治区。
家
 house string

ビルド名 (ワールド トレード センターなど)。
レベル
 level string

フロア番号 (3F など)。
stateDistrict
 stateDistrict string

特定のロケールで使用される第 2 レベルの管理部門。
郊外
 suburb string

中華街のような非公式の近所の名前。
ユニット
 unit string

アパート番号またはオフィス番号。