ExtractionResultHandler クラス

V1 ナビゲーターの ExtractionResultHandler エントリ ポイントと、コンストラクター、ファクトリ メソッド、変換メソッド、および継承するフィールド ナビゲーション メンバー。

定義

• 名前空間: UiPath.DocumentProcessing.Contracts.Extensions.Navigator.V1
• アセンブリ: UiPath.DocumentProcessing.Contracts
• 継承: ComponentCollectionFacade

説明

ExtractionResultHandler は V1 ナビゲーターのエントリ ポイントです。厳密に型指定された方法を使用して、生の ResultsDataPoint オブジェクトと ResultsValue オブジェクトを手動でキャストすることなく、 ExtractionResult のフィールドを流暢に移動および編集できます。

ハンドラーは ExtractionResult から作成され、フィールド コレクションを ExtractionResult.ResultsDocument.Fieldsでラップします。継承されたナビゲーション メソッドは、型指定されたファサードとして各フィールドに到達します。

• BasicDataPoint および BasicValue などの基本フィールド。
• TableDataPoint、TableValue、TableRow などのテーブル。
• フィールド グループ: FieldGroupDataPoint および FieldGroupValue
• WildcardDataPoint として、型が不明なフィールド

ハンドラーは ComponentCollectionFacade から継承するため、[継承されたメンバー] に一覧表示されているナビゲーション メソッドはハンドラーで直接使用できます。

メンバー

コンストラクター

コンストラクター	説明
ExtractionResultHandler(ExtractionResult extractionResult)	指定した抽出結果のフィールドに対する新しいナビゲーターを初期化します (ResultsDocument.Fields)。

ファクトリと変換方法

このセクションのすべてのメソッドは staticです。

メソッド	戻り値	説明
FromExtractionResult(ExtractionResult extractionResult)	ExtractionResultHandler	抽出結果からナビゲーターを作成します。
FromTable(ResultsDataPoint tableDataPoint)	表のデータ ポイント	表のデータ ポイントを表のファサードでラップします。
FromFieldGroup(ResultsDataPoint fieldGroupDataPoint)	フィールド グループのデータ ポイント	フィールド グループのデータ ポイントをフィールド グループのファサードでラップします。
FromBasicDataPoint(ResultsDataPoint basicDataPoint)	BasicDataPoint	基本データ ポイントを基本フィールドのファサードにラップします。
FromDataPoint(ResultsDataPoint dataPoint)	ワイルドカード データ ポイント	任意のデータ ポイントをワイルドカードのファサードでラップします。
FromFieldGroupValue(ResultsValue resultsValue)	フィールド グループの値	フィールド グループの値をフィールド グループの値のファサードでラップします。
FromTableValue(ResultsValue tableValue)	表の値	テーブル値をテーブル値ファサードでラップします。
FromTableRow(ResultsValue tableRow)	表の行	表の行の値を表の行のファサードでラップします。
FromBasicValue(ResultsValue basicValue)	基本値	基本値を基本値のファサードでラップします。

継承されたメンバー

次のメソッドは ComponentCollectionFacade から継承され、 ExtractionResultHandlerで直接使用できます。fieldLookup パラメーターと tableLookup パラメーターは、FieldLookupBase のフィールド検索解決ルールに従います。

メソッド	戻り値	説明
GetFields(Func<ResultsDataPoint, bool> condition = null, bool recursive = false)	ワイルドカード データ ポイント コレクション	conditionに一致するフィールド、または がnullの場合はすべてのフィールドcondition返します。recursive がtrueの場合、入れ子になったフィールドが含まれます。
GetSimpleFields()	BasicDataPoint[]	すべての基本 (非複合) フィールドを返します。
GetSimpleField(string fieldLookup)	BasicDataPoint	ルックアップに一致する基本フィールドを返します。
GetTables()	表のデータ ポイント[]	すべての表フィールドを返します。
GetTable(string tableLookup)	表のデータ ポイント	ルックアップに一致する表フィールドを返します。
GetTableValue(string tableLookup)	表の値	ルックアップに一致するテーブル フィールドの値を返します。
GetFieldGroups()	フィールド グループのデータ ポイント[]	すべてのフィールド グループ フィールドを返します。
GetFieldGroup(string fieldLookup)	フィールド グループのデータ ポイント	ルックアップに一致するフィールド グループ フィールドを返します。
GetFieldGroupValue(string fieldLookup, int index)	フィールド グループの値	ルックアップに一致するフィールドの index にあるフィールド グループのインスタンスを返します。

例

[ ドキュメント データを抽出] アクティビティの [ データ型を生成] プロパティがオフになっている場合は、 プロパティ を使用してアクティビティの出力から直接ハンドラーを取得できますHandler var handler = DocumentData.Data.Handler;。

次の例では、 ExtractionResult からハンドラーを作成し、ナビゲーション メソッドを使用して日付値、フィールド グループ インスタンス、およびその子フィールドの 1 つを読み取ります。

using UiPath.DocumentProcessing.Contracts.Taxonomy;
using UiPath.DocumentProcessing.Contracts.Extensions.Navigator.V1;

// Create a navigator over the fields of an extraction result.
var handler = new ExtractionResultHandler(extractionResult);

// Get all date values across the document (recursive to include nested fields).
foreach (var dateField in handler.GetFields(dp => dp.FieldType == FieldType.Date, recursive: true).BasicFields)
{
    foreach (var dateValue in dateField.Values)
    {
        Console.WriteLine($"{dateField.FieldName}: {dateValue.Value}");
    }
}

// Get the 3rd instance of the "ShippingDetails" field group (index is zero-based).
var shippingInstance = handler.GetFieldGroupValue("ShippingDetails", 2);

// From that instance, read a child field value.
var city = shippingInstance.GetSimpleField("City");
string cityText = city?.Value?.Value;