Classe RésultatExtraction

Espaces de noms : UiPath.DocumentProcessing.Contracts.Results

Assemblage : UiPath.DocumentProcessing.Contracts

Description

Classe publique qui représente un résultat d'extraction pour une partie d'un document.

Remarque : à partir du package UiPath.DocumentProcessing.Contracts v1.17, la méthode ExtractionResult.FlattenFields() a été marquée comme obsolète. Cette structure sera supprimée à l'avenir. La prise en charge des sous-champs au niveau de la valeur est obsolète et les champs de table sont désormais représentés à l'aide d'une nouvelle structure de données.

Membres

Constructeurs

• ExtractionResult() : initialise une nouvelle instance de la classe ExtractionResult sans arguments.

Méthodes

• AsClassificationResult() : renvoie un UiPath.DocumentProcessing.Contracts.Results.ClassificationResult généré à l'aide des informations de l'objet ExtractionResult .
• AsDataSet (<bool>) : renvoie un System.Data.DataSet contenant plusieurs System.Data.DataTable dans la collection .Tables . Cette collection contient une table appelée Champs simples, qui contient tous les champs en tant que colonnes et toutes les valeurs signalées pour un champ en tant que valeurs dans la table. Si un champ n'a pas de valeur dans ExtractionResult, aucune valeur n'est signalée. Si un champ de table a une valeur, elle est signalée sous la forme de la chaîne table, qui est un marqueur du fait qu'il existe un DataTable avec le nom du champ qui contient les champs de colonne en tant que colonnes et les valeurs pour chaque ligne en tant que valeurs dans le DataTable.
• AsDataSet (<bool>, <bool>) : renvoie un System.Data.DataSet contenant plusieurs System.Data.DataTable dans la collection .Tables . Cette collection contient une table appelée Champs simples, qui contient tous les champs en tant que colonnes et toutes les valeurs signalées pour un champ en tant que valeurs dans la table. Si un champ n'a pas de valeur dans ExtractionResult, aucune valeur n'est signalée. Si un champ de table a une valeur, elle est signalée sous la forme de la chaîne table, qui est un marqueur du fait qu'il existe un DataTable avec le nom du champ qui contient les champs de colonne en tant que colonnes et les valeurs pour chaque ligne en tant que valeurs dans le DataTable.
• Deserialize (<string> ) - Une méthode statique qui renvoie une nouvelle instance de la classe ExtractionResult avec le contenu sérialisé dans la chaîne d'entrée.
• EnumerateValues (System.Func<UiPath.DocumentProcessing.Contracts.Results.ResultsValue, <bool>) : permet d'itérer toutes les valeurs du document de résultats, y compris les valeurs de cellule du tableau.
• FlattenFields (System.Func<UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint, <bool>) : aplatit les champs dans UiPath.DocumentProcessing.Contracts.Results.ExtractionResult.ResultsDocument et les filtre en fonction de la condition. AVERTISSEMENT : obsolète.
• GetDocumentType() : renvoie une chaîne contenant le DocumentTypeId de l'objet ExtractionResult .
• GetFields (System.Func<UiPath.DocumentProcessing.Contracts.Results.ResultsDataPoint, <bool>) : filtre les champs dans UiPath.DocumentProcessing.Contracts.Results.ExtractionResult.ResultsDocument qui remplissent la condition.
• GetField (<string>) - Renvoie le champ avec l'ID de champ spécifié ou null s'il n'existe pas.
• GetSimpleFieldValues (<string>) : renvoie une liste de UiPath.DocumentProcessing.Contracts.Results.SimpleFieldValue pour l'entrée fieldId.
• GetTable (<string>) - Renvoie la table avec l'ID spécifié ou null s'il n'existe pas.
• GetTableFieldValue (<string>, <int>) : renvoie un UiPath.DocumentProcessing.Contracts.Results.TableFieldValue contenant les valeurs de cellule pour le fieldId requis. Par défaut, ce champ est défini sur 0.
• IsAnyFieldOrTableCellMissing() booléen ( bool ) - Détermine s'il existe un point de données ou une cellule de table qui n'a pas de valeurs.
  Remarque : Une seule valeur pour un champ de table est prise en charge. Le valueIndex ne peut donc être défini que sur 0.
• GetValueCount(<string>) : renvoie un entier contenant le nombre de valeurs associées au fieldIdfourni.
• Serialize() string- Renvoie une chaîne contenant la représentation sérialisée de l'objet ExtractionResult .
• GetFieldValidatorNotes(<fieldId>) - Renvoie la valeur du champ contenant les notes du validateur avec l'ID de champ spécifié, ou null s'il n'existe pas.
• SetFieldValidatorNotes(<fieldId>, <validatorNote>) - Définit la valeur de champ pour les notes de validateur avec l'ID de champ spécifié, si les notes sont activées pour ce champ.

Propriétés

• DocumentId chaîne : le nom du document pour lequel les résultats de l'extraction sont rapportés.
• ExtractorPayloads chaîne : informations supplémentaires fournies par les extracteurs.
• ResultsDocument chaîne : les détails de la structure de classification et d'extraction de données.
• ResultsVersion entier : la version de ExtractionResult signalée pour le document. Commence à 0 lorsque l'extraction automatique est effectuée et doit être augmenté de 1 chaque fois que le contenu de l'objet est modifié, à des fins de suivi.