Données du document

Les Données du document sont une ressource qui sert à la fois de variable d’entrée et de sortie dans vos workflows Document Understanding. L'objet Données du document contient toutes les informations nécessaires d'un seul document. Si vous classez un document, l’objet inclut le Type de document. Si vous extrayez des données, l'objet contient les champs extraits correspondants. Quelle que soit l'activité, les données de document contiennent systématiquement le texte du document et le DOM (modèle d'objet de document).

Avec les Données du document, vous pouvez : collecter toutes les informations nécessaires sur un document dans une seule variable, enregistrer des données dans chaque propriété de l'objet et les réutiliser pour d'autres activités du workflow.

Les données des documents contiennent des informations sur les attributs suivants :

• TypeDocument: fournit des données sur le type de document identifié, remplies par des activités telles que Classer un document (Classify Document) ou Créer une tâche de validation de classification ( Create Classification Validation Task).
• Données(Data) : contient les valeurs de champ extraites. Il est généré à la demande par la propriété Generate Data , qui génère un type de sortie de IDocumentData<ExtractorType>. Lorsque la propriété Générer des données est définie sur False, vous ne pouvez accéder aux valeurs de champ extraites que via des méthodes de type Get.
• DétailsFichier: contient des détails sur les IResource.
• Sous-documents ( SubDocuments): comprend une collection de données de document, remplies par des activités telles que Créer une tâche de validation de classification (Create Classification Validation Task).
• MétadonnéesDocument: contient des informations sur le traitement du document, telles que :
  • Langue détectée par texte
  • Champs extraits sous forme de table de données
  • DOM (Document Object Model): contient le modèle d'objet de document qui est utilisé par toutes les activités.
  La valeur DocumentMetadata est mise à jour par l'activité qui traite en premier le document. Une fois renseignées, les métadonnées sont partagées avec et utilisées par toutes les activités suivantes qui reçoivent l'objet Données du document (Document Data).
  Astuce : sauf si une activité est la première activité Document Understanding d'un workflow Studio, utilisez les Données du document en tant qu'entrée. Utilisez la variable Fichier (File) comme entrée uniquement si l'activité est la première partie Document Understanding d'un workflow Studio.

Comprendre et accéder aux données

Les données du document contiennent des informations détaillées sur les résultats de l'extraction. Les données peuvent être de deux types, selon que vous choisissez de les générer à la demande, afin de pouvoir les utiliser davantage dans votre workflow, ou de ne pas les générer, afin que vous puissiez y appliquer les méthodes get et set , conçues pour les implémentations avancées, afin d'augmenter la flexibilité.

La propriété Générer le type de données de l’activité Extraire les données du document vous permet de choisir si vous générez les données à la demande ou non. Référez-vous aux scénarios suivants :

• Lorsque vous définissez Générer le type de données sur True (le paramètre par défaut) : les sorties Données du document en tant que IDocumentData<ExtractorType>. Ces données sont générées à la demande et les modifications en fonction des modifications apportées à l’activité Extraire les données du document (Extract Document Data). Avec ce paramètre, vous ne pouvez pas modifier le type de document dans la station de validation, et JIT (Juste à temps) est sélectionné par défaut.
• Lorsque vous définissez Generate Data Type sur False: les sorties Document Data sont IDocumentData<DictionaryData>. Avec ce paramètre, la propriété Données du document (Document Data) ne sera plus générée et vous ne pourrez pas la parcourir.

  Vous pouvez accéder à ses données à l'aide de méthodes spécifiques, en vous basant sur l'ID de champ. Ces ID deviennent disponibles lors de la configuration du type de document ou lors de la récupération des informations à l'aide d'API. Visitez la page Modification ou ajout de nouveaux champs et Obtenir l'API de demande d'extraction pour plus d'informations.

  • Lorsque vous définissez Générer le type de données (Generate Data Type) sur False pour l'extraction générative, les champs récupérés correspondent aux noms fournis dans l'invite. Par exemple, si le nom du champ dans l'invite est défini comme a b c (y compris les espaces), vous devez utiliser le même que l'ID de champ lors de l'utilisation des méthodes spécifiques.

Transmettre des données de documents vers des activités

Lorsque vous utilisez Données du document, le premier objet de sortie est créé à partir de votre fichier d'entrée. Après avoir créé cet objet, nous vous recommandons de le transmettre à vos prochaines activités. En le passant à vos prochaines activités, vous pouvez réutiliser le Texte (Text) et le DOM de votre fichier d’origine. Cette approche vous évite de renumériser le fichier à chaque fois.

Utilisation des résultats d'extraction pour les champs à une ou plusieurs valeurs

Si vous configurez un champ de type de document pour qu’il soit à plusieurs valeurs, le système attend plusieurs valeurs. Un exemple pourrait être une question à choix multiples dans un formulaire. Les résultats apparaissent dans l'attribut à valeurs multiples du champ, renvoyé sous forme de liste. Si le champ de type de document est configuré pour être à valeur unique, le système renvoie le résultat dans l’attribut de valeur du champ par défaut.

Le tableau suivant vous montre comment les Données du document renvoient des champs à une et plusieurs valeurs :

Tableau 1. Les valeurs renvoyées par les Données du document pour les champs à valeur unique et à valeurs multiples

	ne comporte pas de valeur	A une valeur	Comporte deux valeurs ou plus	DocumentData.Data.FieldName.Value	DocumentData.Data.FieldName.MultiValues
Valeur unique	Oui (Yes)	Non (No)	S/O	""	null
Valeur unique	Non (No)	Oui (Yes)	S/O	<value that was identified><valeur identifiée>	null
Valeurs multiples	Oui (Yes)	Non (No)	Non (No)	""	[] (tableau vide)
Valeurs multiples	Non (No)	Oui (Yes)	Non (No)	<value that was identified><valeur identifiée>	[<tableau avec une valeur identique à .Value>]
Valeurs multiples	Non (No)	Non (No)	Oui (Yes)	<first value that was identified><première valeur identifiée>	[<tableau avec n valeurs, la première valeur étant identique à .Value>]

Renvoyer les champs extraits sous forme de table de données

Vous pouvez renvoyer les champs que vous avez extraits d'un document en tant que table de données, à l'aide de l'objet Données du document. Vous pouvez ensuite utiliser la variable TableDonnées (Data Table) à l'intérieur des activités Excel.

Pour renvoyer les champs extraits sous forme de table de données, choisissez la sortie ResultsAsDataTable pour l'activité Extraire les données du document (Extract Document Data) .

Propriétés

Les propriétés de la variable Données du document peuvent être renseignées et utilisées par une ou plusieurs activités. Selon l’activité renseignant la variable, les propriétés peuvent différer. Consultez la liste suivante :

• TypeDocument - L'activité Classer un document (Classify Document) remplit les valeurs suivantes :
  • DisplayName (utilisé pour les modèles personnalisés) : nom du type de document.
  • ID (utilisé pour les modèles prêts à l'emploi) : nom du type de document.
  • Confidence: confiance de classification.
  • URL: URL de la plage où le type de document est accessible ; cela peut être personnalisé ou prédéfini, référencé via le projet correspondant dans le centre Document Understanding.
• Champs ( Fields) - Extraire les données du document (Extract Document Data), Créer une tâche de validation (Create Validation Task), Créer une tâche de validation et attendre (Wait), Attendre la tâche de validation et reprendre (Resume) remplissent les valeurs suivantes :
  • Valeur du champ ( Field Value) : valeur d'extraction du champ.
  • Score de confiance de l'extraction : score de confiance de l'extraction, tel que fourni par le modèle.
  • Score de confiance OCR ( OCR Confidence Score) : score de confiance fourni par le moteur OCR.
• Détails du fichier ( File Details ) : les activités créant l'objet Données du document (Document Data), recevant un fichier en entrée, remplissent les valeurs suivantes :
  • Nom complet (Full Name): nom complet du fichier.
  • Extension: extension du fichier.
  • Page Range: la plage de pages du fichier.
• Sous-documents: collection de données de documents, remplies par l'activité Classer un document (Classify Document).
  Remarque : ce champ n'est pas renseigné actuellement et sera ajouté à l'avenir avec des fonctionnalités de validation de classification et de fractionnement.
• DocumentMetaData:
  • DOM: Le modèle d'objet de document, utilisé par toutes les activités. (renseigné par des activités créant l'objet Données du document (Document Data) et recevant un fichier en tant qu'entrée.)
  • Texte: tout le texte extrait. (renseigné par des activités créant l'objet Données du document (Document Data) et recevant un fichier en tant qu'entrée.)
  • Langue(Language) : langue détectée dans le document. (renseigné par des activités créant l'objet Données du document (Document Data) et recevant un fichier en tant qu'entrée.)
  • Confiance fractionnée: si le document est fractionné, il est renvoyé par le modèle de fractionnement. (rempli par l'activité Classer un document (Classify Document))
    Remarque : ce champ n'est pas renseigné actuellement et sera ajouté à l'avenir avec des fonctionnalités de validation de classification et de fractionnement.
  • Résultats en tant que tables de données: champs exportés en tant que table de données. (rempli par l’activité Extraire les données du document ).