提取结果类

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

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

定义

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

描述

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

成员

构造函数

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

方法

• AsClassificationResult() - 返回使用ExtractionResult对象中的信息生成的分类结果。
• “AsDataSet(bool includeConfidence = false)”- 返回“System.Data.DataSet”，其中包含“.Tables”集合中的多个“System.Data.DataTable”。该集合包含一个名为“简单字段”的表格，其中包含作为列的所有字段，以及字段的所有报告值（将作为表格中的值）。如果字段在“ExtractionResult”中不具有值，则系统不会报告任何值。如果表字段具有值，则系统会将其报告为“table”字符串。该字符串表示存在“DataTable”，且其字段名称包含作为列的列字段，以及各行的值（将作为“DataTable”中的值）。
• “AsDataSet(bool includeConfidence = false, bool includeOcrConfidence = false)”- 返回“System.Data.DataSet”，其中包含“.Tables”集合中的多个“System.Data.DataTable”。该集合包含一个名为“简单字段”的表格，其中包含作为列的所有字段，以及字段的所有报告值（将作为表格中的值）。如果字段在“ExtractionResult”中不具有值，则系统不会报告任何值。如果表字段具有值，则系统会将其报告为“table”字符串。该字符串表示存在“DataTable”，且其字段名称包含作为列的列字段，以及各行的值（将作为“DataTable”中的值）。
• Deserialize(string jsonString) - 一种静态方法，用于返回 ExtractionResult 类的新实例，其内容在输入字符串中已序列化。
• EnumerateValues(Func<ResultsValue, bool> condition = null) - 用于遍历结果文档中的所有值，包括表格单元格值。
• FlattenFields(Func<ResultsDataPoint, bool> condition = null) - 展平 ResultsDocument 中的字段，并根据条件对其进行筛选。
  警告：

  此方法已过时。

• “GetDocumentType()”- 返回包含“ExtractionResult”对象的“DocumentTypeId”的字符串。
• GetFields(Func<ResultsDataPoint, bool> condition = null) - 筛选 ResultsDocument 中满足条件的字段。
• GetField(string fieldId) - 返回具有指定字段 ID 的字段，如果不存在，则返回 null。
• GetSimpleFieldValues(string fieldId) - 为输入的fieldId返回简单字段值的列表。
• GetTable(string fieldId) - 返回具有指定 ID 的表格；如果不存在，则返回 null。
• GetTableFieldValue(string fieldId, int valueIndex = 0) - 返回一个表格字段值，其中包含必填fieldId的单元格值。默认情况下，valueIndex 设置为 0。
• IsAnyFieldOrTableCellMissing() - 确定是否有不包含值的数据点或表格单元格。
  备注：

  仅支持表字段的单个值。因此，“valueIndex”只能设为 0。

• GetValueCount(string fieldId) - 返回一个整数，其中包含与提供的 fieldId 关联的值的数量。
• “Serialize()”- 返回一个字符串，其中包含“ExtractionResult”对象的序列化表示。
• GetFieldValidatorNotes(string fieldId) - 返回包含具有指定字段 ID 的验证程序注释的字段值；如果不存在，则返回 null。
• SetFieldValidatorNotes(string fieldId, string validatorNotes) - 如果已为该字段激活注释，则为具有指定字段 ID 的字段设置验证程序注释。
• GetFieldValidatorNotesInfo(string fieldId) - 返回具有指定字段 ID 的字段的验证程序注释信息；如果不存在，则返回 null。
• SetFieldValidatorNotesInfo(string fieldId, string validatorNotesInfo) - 如果已为该字段激活注释，则为具有指定字段 ID 的字段设置验证程序注释。
• GetFieldValidatorNotesInfoByFieldName(string fieldName) - 返回具有指定字段名称的字段的验证程序注释信息；如果该字段不存在，则返回 null。
• SetFieldValidatorNotesInfoByFieldName(string fieldName, string validatorNotesInfo) - 如果已为该字段激活注释，则为具有指定字段名称的字段设置验证程序注释信息。

属性

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