Document

L’objet Document — propriétés et méthodes permettant de lire le document en cours de traitement, y compris les champs, les pages, les résultats de classification et les fichiers source.

Document représente le document en cours de traitement dans un script d’activité personnalisée — ses champs, ses pages, ses résultats de classification, ses fichiers source et ses résultats d’export.

Selon les étapes de traitement déjà terminées, certaines propriétés peuvent renvoyer des valeurs vides. Par exemple, seuls DocumentId et SourceFiles sont renseignés avant l’exécution d’une compétence. ResultClass est renseigné après l’exécution d’un Skill de classification. Fields est renseigné après l’extraction.

​

Propriétés

Name	Type	Access	Description
ClassConfidences	ClassConfidenceModel[]	Lecture seule	Les valeurs de confiance pour chaque classe.
DocumentId	string	Lecture seule	L’identifiant unique du document.
DocumentSkillId	string	Lecture seule	L’identifiant unique de la Compétence de document appliquée au document.
DocumentSkillName	string	Lecture seule	Le nom de la Compétence de document appliquée au document.
Fields	Field[]	Lecture seule	Champs détectés dans le document. Renseigné uniquement après l’exécution d’une Compétence de document.
IsResultClassConfident	bool	Lecture seule	true si la classe du document a été déterminée avec un niveau de confiance suffisant.
Pages	Page[]	Lecture seule	Les pages du document.
ResultClass	string	Lecture seule	La classe attribuée par le Skill de classification. Vide si le document n’a pas été classé.
RuleErrors	RuleError[]	Lecture seule	Erreurs des règles de validation de l’extraction des champs.
SourceFiles	BinaryFile[]	Lecture seule	Fichiers source du document. Contient l’image avant le prétraitement. Les métadonnées source (y compris les données EXIF) sont conservées pour les JPEG.
Exports	ResultFiles	Lecture/écriture	Résultats d’export du document.
RegistrationParameters	Record<string, Parameter>	Lecture seule	Dictionnaire des paramètres d’enregistrement du fichier source pour la première page — les clés sont les noms des paramètres et les valeurs sont des objets Parameter.

ClassConfidences et IsResultClassConfident sont renseignés uniquement lorsqu’un Skill de classification a été appliqué.

​

Méthodes

​

ToJsonString

string ToJsonString();

Renvoie les données du document sous la forme d’une chaîne au format JSON.

​

GetField

Field GetField(string fieldName);

Renvoie l’objet Field pour le champ spécifié.

​

Rubriques connexes

• Transaction
• Field
• Page
• BinaryFile
• Modèle objet
• Activité personnalisée