ExtractionResult クラス

ExtractionResult は、ドキュメントの一部の抽出結果を表すパブリック クラスです。

定義

• 名前空間: UiPath.DocumentProcessing.Contracts.Results
• アセンブリ: UiPath.DocumentProcessing.Contracts

説明

ドキュメントの一部の抽出結果を表すパブリック クラスです。

手記： UiPath.DocumentProcessing.Contracts パッケージ v1.17 以降、 ExtractionResult.FlattenFields() メソッドは非推奨としてマークされています。 この構造は、今後削除される予定です。 値レベルのサブフィールドのサポートは非推奨となり、テーブル フィールドは新しいデータ構造を使用して表されるようになりました。

メンバー

コンストラクター

ExtractionResult() - 引数なしで ExtractionResult クラスの新しいインスタンスを初期化します。

メソッド

• AsClassificationResult() - ExtractionResult オブジェクトからの情報を使って生成される UiPath.DocumentProcessing.Contracts.Results.ClassificationResult を返します。
• AsDataSet (<bool>) - .Tablesコレクション内の複数のSystem.Data.DataTableを含むSystem.Data.DataSetを返します。このコレクションには、[ シンプル フィールド] という名前のテーブルが含まれており、このテーブルには、すべてのフィールドが列として含まれ、フィールドについて報告されたすべての値がテーブルの値として含まれています。 フィールドが ExtractionResultに値を持たない場合、値は報告されません。 テーブル フィールドに値がある場合、その値は文字列 tableとして報告されます。これは、列フィールドを列として含み、各行の値をDataTableの値として含むフィールド名のDataTableがあることを示すマーカーです。
• AsDataSet (<bool>, <bool>) - .Tablesコレクション内の複数のSystem.Data.DataTableを含むSystem.Data.DataSetを返します。このコレクションには、[ シンプル フィールド] という名前のテーブルが含まれており、このテーブルには、すべてのフィールドが列として含まれ、フィールドについて報告されたすべての値がテーブルの値として含まれています。 フィールドが ExtractionResultに値を持たない場合、値は報告されません。 テーブル フィールドに値がある場合、その値は文字列 tableとして報告されます。これは、列フィールドを列として含み、各行の値をDataTableの値として含むフィールド名のDataTableがあることを示すマーカーです。
• Deserialize (<string> ) - 内容が入力文字列にシリアル化された ExtractionResult クラスの新しいインスタンスを返す静的メソッドです。
• EnumerateValues (System.Func<UiPath.DocumentProcessing.Contracts.Results.ResultsValue, <bool>) - 表のセルの値を含む、結果ドキュメントのすべての値を反復処理できます。
• FlattenFields (System.Func<UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint, <bool>) - UiPath.DocumentProcessing.Contracts.Results.ExtractionResult.ResultsDocument 内のフィールドをフラット化し、条件に基づいてフィルター処理します。
  警告： このメソッドは互換性のために残されています。
• GetDocumentType() - ExtractionResult オブジェクトの DocumentTypeId を含む文字列を返します。
• GetFields (System.Func<UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint, <bool>) - 条件を満たすフィールドをフィルター処理 UiPath.DocumentProcessing.Contracts.Results.ExtractionResult.ResultsDocument 。
• GetField (<string>) - 指定したフィールド ID を持つフィールドを返すか、フィールドが存在しない場合は null を返します。
• GetSimpleFieldValues (<string>) - 入力fieldIdの UiPath.DocumentProcessing.Contracts.Results.SimpleFieldValue のリストを返します。
• GetTable (<string>) - 指定した ID の表を、表が存在しない場合は null で返します。
• GetTableFieldValue (<string>, <int>) - 必要なfieldIdのセル値を含む UiPath.DocumentProcessing.Contracts.Results.TableFieldValue を返します。既定では、このフィールドは 0 に設定されています。
• IsAnyFieldOrTableCellMissing() bool - 値を含まないデータ ポイントまたは表のセルがあるかどうかを判断します。
  メモ： 表フィールドの値は 1 つだけサポートされます。 したがって、 valueIndex は 0 にのみ設定できます。
• GetValueCount(<string>) - 指定された fieldIdに関連付けられた値の数を含む整数を返します。
• Serialize() string- ExtractionResult オブジェクトのシリアル化された表現を含む文字列を返します。
• GetFieldValidatorNotes(<fieldId>) - 指定されたフィールド ID を持つ検証メモを含むフィールド値を返します。存在しない場合は null を返します。
• SetFieldValidatorNotes(<fieldId>、 <validatorNote>) - 指定したフィールド ID を持つフィールドの検証者のコメントを設定します (そのフィールドに対してメモがアクティブ化されている場合)。
• GetFieldValidatorNotesInfo(<fieldId>) - 指定したフィールド ID を持つフィールドの検証者のコメント情報を返します。存在しない場合は null にします。
• SetFieldValidatorNotesInfo(<fieldId>、 <validatorNote>) - 指定したフィールド ID を持つフィールドの検証者のコメントを設定します (そのフィールドに対してメモがアクティブ化されている場合)。
• GetFieldValidatorNotesInfoByFieldName(<string>) - 指定したフィールド名を持つフィールドの検証者のコメント情報を返します。存在しない場合は null にします。
• SetFieldValidatorNotesInfoByFieldName(<string>、 <validatorNote>) - 指定したフィールド名を持つフィールドに対してメモがアクティブ化されている場合、そのフィールドの検証者のコメント情報を設定します。

プロパティ

• DocumentId String - 抽出結果を報告するドキュメントの名前です。
• ExtractorPayloads String - 抽出器によって提供される追加情報です。
• ResultsDocument UiPath.DocumentProcessing.Contracts.Results.ResultsDocument - 分類およびデータ抽出構造の詳細です。
• ResultsVersion Int - ドキュメントに対して報告される ExtractionResult のバージョンです。 自動抽出が実行されるときは 0 から開始し、追跡のためにオブジェクトの内容が変更されるたびに 1 ずつ増やす必要があります。