提取结果类

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

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

定义

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

描述

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

成员

构造函数

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

方法

• AsClassificationResult() - Returns a ClassificationResult generated using the information from the ExtractionResult object.
• “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) - A static method that returns a new instance of the ExtractionResult class with the contents serialized in the input string.
• EnumerateValues(Func<ResultsValue, bool> condition = null) - Lets you iterate over all values in the results document, including table cell values.
• FlattenFields(Func<ResultsDataPoint, bool> condition = null) - Flattens the fields in the ResultsDocument and filters them based on the condition.
  警告：

  此方法已过时。

• “GetDocumentType()”- 返回包含“ExtractionResult”对象的“DocumentTypeId”的字符串。
• GetFields(Func<ResultsDataPoint, bool> condition = null) - Filters the fields in the ResultsDocument that satisfy the condition.
• GetField(string fieldId) - Returns the field with the specified field ID or null if it doesn't exist.
• GetSimpleFieldValues(string fieldId) - Returns a list of SimpleFieldValue for the input fieldId.
• GetTable(string fieldId) - Returns the table with the specified id or null if it doesn't exist.
• GetTableFieldValue(string fieldId, int valueIndex = 0) - Returns a TableFieldValue containing cell values for the required fieldId. By default, valueIndex is set to 0.
• IsAnyFieldOrTableCellMissing() - Determines whether there is any data point or table cell which doesn't have values.
  备注：

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

• GetValueCount(string fieldId) - Returns an integer containing the number of values associated with the provided fieldId.
• “Serialize()”- 返回一个字符串，其中包含“ExtractionResult”对象的序列化表示。
• GetFieldValidatorNotes(string fieldId) - Returns the field value containing validator notes with the specified field id, or null if it doesn't exist.
• SetFieldValidatorNotes(string fieldId, string validatorNotes) - Set the validator notes for the field with the specified field ID, if notes are activated for that field.
• GetFieldValidatorNotesInfo(string fieldId) - Returns the validator notes info for the field with the specified field id, or null if it doesn't exist.
• SetFieldValidatorNotesInfo(string fieldId, string validatorNotesInfo) - Set the validator notes for the field with the specified field ID, if notes are activated for that field.
• GetFieldValidatorNotesInfoByFieldName(string fieldName) - Returns the validator notes info for the field with the specified field name, or null if it doesn't exist.
• SetFieldValidatorNotesInfoByFieldName(string fieldName, string validatorNotesInfo) - Set the validator notes info for the field with the specified field name, if notes are activated for that field.

属性

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