提取结果类

ExtractionResult是一个公共类，表示文档某一部分的提取结果。

定义

• 命名空间: UiPath.DocumentProcessing.Contracts.Results
• 程序集: UiPath.DocumentProcessing.Contracts

描述

此为表示文档某一部分提取结果的公共类。

备注：

Starting with UiPath.DocumentProcessing.Contracts package v1.17, the ExtractionResult.FlattenFields() method has been marked as obsolete. This structure will be removed in the future. Support for sub-fields at value level is obsolete and table fields are now represented using a new data structure.

成员

构造函数

“ExtractionResult()”- 初始化“ExtractionResult”类的新实例（不含参数）。

方法

• “AsClassificationResult()”- 返回使用“ExtractionResult”对象的信息生成的“UiPath.DocumentProcessing.Contracts.Results.ClassificationResult”。
• AsDataSet (<bool>) - Returns a System.Data.DataSet containing multiple System.Data.DataTable in the .Tables collection. This collection contains a table called Simple Fields, that contains all fields as columns and all reported values for a field as values in the table. If a field has no value in the ExtractionResult, then no value is reported. If a table field has a value, it is reported as the string table, which is a marker of the fact that there is a DataTable with the field name that contains column fields as columns, and values for each row as values in the DataTable.
• AsDataSet (<bool>, <bool>) - Returns a System.Data.DataSet containing multiple System.Data.DataTable in the .Tables collection. This collection contains a table called Simple Fields, that contains all fields as columns and all reported values for a field as values in the table. If a field has no value in the ExtractionResult, then no value is reported. If a table field has a value, it is reported as the string table, which is a marker of the fact that there is a DataTable with the field name that contains column fields as columns, and values for each row as values in the 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中的字段，并根据条件进行筛选。
  警告：

  This method is obsolete.

• “GetDocumentType()”- 返回包含“ExtractionResult”对象的“DocumentTypeId”的字符串。
• GetFields ( System.Func<UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint, <bool> ) - 筛选UiPath.DocumentProcessing.Contracts.Results.ExtractionResult.ResultsDocument中满足条件的字段。
• “ GetField ”(“ <string> ”) - 返回具有指定字段 ID 的字段；如果不存在，则返回“ null ”。
• GetSimpleFieldValues (<string>) - Returns a list of UiPath.DocumentProcessing.Contracts.Results.SimpleFieldValue for the input fieldId.
• “ GetTable ”(“ <string> ”) - 返回具有指定 ID 的表格；如果该表格不存在，则返回 null。
• GetTableFieldValue (<string>, <int>) - Returns a UiPath.DocumentProcessing.Contracts.Results.TableFieldValue containing cell values for the required fieldId. By default, this field is set to 0.
• IsAnyFieldOrTableCellMissing() bool - 确定是否有任何数据点或表格单元格不包含值。
  备注：

  仅支持表字段的单个值。因此，“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，以进行跟踪。