提取结果类

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> ”）- 返回在“ System.Data.DataSet .Tables ”集合中包含多个“ System.Data.DataTable ”的“”。 此集合包含一个名为简单字段的表，该表包含所有字段作为列，并将某个字段的所有报告值包含作为表中的值。 如果ExtractionResult中没有值的字段，则不会报告任何值。 如果表格字段具有值，则该值会报告为字符串table ，它表明以下事实：存在一个DataTable ，其字段名称包含作为列的列字段，每一行的值作为值在DataTable中。
• “ AsDataSet ”（“ <bool>, <bool> ”）- 返回在“ System.Data.DataSet .Tables ”集合中包含多个“ System.Data.DataTable ”的“”。 此集合包含一个名为简单字段的表，该表包含所有字段作为列，并将某个字段的所有报告值包含作为表中的值。 如果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> ”) - 返回一个UiPath.DocumentProcessing.Contracts.Results.TableFieldValue ，其中包含所需fieldId的单元格值。 默认情况下，此字段设置为 0。
• IsAnyFieldOrTableCellMissing() bool - 确定是否有任何数据点或表格单元格不包含值。
  注意: 仅支持表格字段的单个值。 因此， valueIndex 只能设置为 0。
• “ GetValueCount ”（“ <string> ”）- 返回一个整数，其中包含与提供的“ fieldId ”相关的值数量。
• Serialize() string - 返回包含ExtractionResult对象序列化表示的字符串。
• GetFieldValidatorNotes ( <fieldId> ) - 返回包含具有指定字段 ID 的验证程序说明的字段值；如果不存在，则返回 null。
• SetFieldValidatorNotes （ <fieldId>和<validatorNote> ）- 如果已为该字段激活注释，则为具有指定字段 ID 的验证程序注释设置字段值。

属性

• DocumentId String - 要为其报告提取结果的文档的名称。
• ExtractorPayloads String - 提取程序提供的其他信息。
• ResultsDocument UiPath.DocumentProcessing.Contracts.Results.ResultsDocument - 分类和数据提取结构的详细信息。
• ResultsVersion Int - 为文档报告的ExtractionResult的版本。 执行自动提取时从 0 开始，每次更改对象内容时应增加 1，以进行跟踪。