提取结果类

命名空间： 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（<字符串>）- 为输入的 fieldId 返回 UiPath.DocumentProcessing.Contracts.Results.SimpleFieldValue 的列表。
• GetTable (<string>) - 返回具有指定 ID 的表；如果不存在，则返回 null。
• GetTableFieldValue（<字符串>、<整型>）- 为必填 fieldId 返回包含单元格值的 UiPath.DocumentProcessing.Contracts.Results.TableFieldValue。默认情况下，此字段设置为 0。
• IsAnyFieldOrTableCellMissing() 布尔值 - 确定是否有任何数据点或表格单元格没有值。
  注意: 仅支持表格字段的单个值。 因此， valueIndex 只能设置为 0。
• GetValueCount(<string>) - 返回一个整数，其中包含与所提供的 fieldId关联的值的数量。
• Serialize() 字符串- 返回包含 ExtractionResult 对象的序列化表示形式的字符串。
• GetFieldValidatorNotes ( <fieldId> ) - 返回包含具有指定字段 ID 的验证程序备注的字段值；如果不存在，则返回 null。
• SetFieldValidatorNotes （ <fieldId> 、 <validatorNote> ）- 如果已为该字段激活注释，则为具有指定字段 ID 的验证程序注释设置字段值。

属性

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