Analyze Form

[ フォームを分析] アクティビティは、Form Recognizer の Analyze Form API を使用して、指定したトレーニング モデル ( [モデル ID ]) を使用して、指定したドキュメント ( [ファイル パス ] または [ファイル URL ]) からキーと値のペアと表データを抽出します。

フォームの分析操作の完了後、アクティビティは結果を AnalyzeOperationResult オブジェクト ([応答オブジェクト]) と Page[] オブジェクト ([ページ]) に出力します。 どちらの出力も、後続のアクティビティ (条件付きロジックなど) の入力変数として使用できます。

動作のしくみ

以下の手順とメッセージ シーケンス ダイアグラムは、設計時 (つまり、アクティビティの依存関係と入/出力プロパティ) から実行時に至るまでの、アクティビティの動作のしくみの例を示したものです。

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [ Azure フォーム認識器スコープ] アクティビティを追加します。
3. [Azure フォーム 認識スコープ] アクティビティ内に [フォームを分析] アクティビティを追加します。
4. [入力] セクションのプロパティに値を 入力 します。
5. [ 出力 ] セクションのプロパティの AnalyzeOperationResult と Page[] 型変数を作成し、入力します。

6. アクティビティを実行します。

   • 入力したプロパティは、 フォームの分析 API に渡されます。
   • API は、出力プロパティ変数に AnalyzeFormResponse と FormPage[] の値を返します。
     
     

     

     
     

プロパティ

以下のプロパティの値は、このアクティビティを UiPath Studio でプロジェクトに追加するときに指定します。

共通

表示名

アクティビティの表示名です。

属性	詳細
入力	String
Required	はい
既定値	Analyze Form
許容値	String または String 型変数を入力します。
備考	N/A

Timeout

分析の領収書操作が完了するまでの待機時間 (ミリ秒単位) を指定します。この時間を超えるとエラーがスローされます。

属性	詳細
入力	Int32
Required	はい
既定値	30,000 ミリ秒 ((30 秒) 表示されません)。
許容値	Int32 または Int32 型変数を入力します。
備考	N/A

入力

ファイル パス

分析するフォーム ドキュメントのローカル パスです。

属性	詳細
入力	String
Required	はい ( ファイル URL が空の場合)
既定値	空
許容値	String または String 型変数を入力します。
備考	サポートされているフォームドキュメントの形式: .json、 。Pdf 。Jpg 。Png と .tiff (他のすべての形式の種類は無視されます)。

ファイル URL

分析するフォーム ドキュメントの URL です。

属性	詳細
入力	String
Required	はい ( ファイル パス が空の場合)
既定値	空
許容値	String または String 型変数を入力します。
備考	サポートされているフォームドキュメントの形式: .json、 。Pdf 。Jpg 。Png と .tiff (他のすべての形式の種類は無視されます)。

モデル ID

フォームの分析に使用するトレーニング モデルの識別子です。

属性	詳細
入力	String
Required	はい
既定値	空
許容値	String または String 型変数を入力します。
備考	[ モデル ID] の値を取得するには、モデル識別子を出力するアクティビティを追加するか外部プロセスを実行します (例: [ モデルをトレーニング]、[モデルを 取得])。

オプション

IncludeTextDetails

選択すると、テキスト行と要素の参照が結果に含まれます。

属性	詳細
入力	チェックボックス
Required	いいえ
既定値	非選択
許容値	選択または非選択
備考	N/A

その他

プライベート (Private)

選択すると、変数と引数の値が Verbose レベルでログ記録されなくなります。

属性	詳細
入力	チェックボックス
Required	いいえ
既定値	非選択
許容値	選択または非選択
備考	N/A

出力

Response Object

逆シリアル化されたオブジェクトとしての操作の応答です。

属性	詳細
入力	AnalyzeOperationResult
Required	いいえ (後続のアクティビティで出力データを使用する必要があります)
既定値	空
許容値	AnalyzeOperationResult 型変数を入力します。
備考	JSON 文字列表現を取得するには、 ToString メソッドを使用します。 モデルでフィールドが見つからない場合、null 値が返されます。

ページ数

ページから抽出されたキーと値のペアと表の情報を含むフォーム分析の結果。

属性	詳細
入力	Page[]
Required	いいえ (後続のアクティビティで出力データを使用する必要があります)
既定値	空
許容値	Page[] 型変数を入力します。
備考	各 Page オブジェクトには、 KeyValuePairs と Tables のプロパティが含まれます。