Entrepôt d’analyse des rapports

L’Entrepôt d’analyse des rapports stocke des données qui peuvent être utilisées pour analyser l’efficacité du traitement des documents dans le système. Grâce à ces données, vous pouvez identifier les documents qui nécessitent plus de temps pour la vérification manuelle et en comprendre les raisons. Les statistiques sont collectées pour les Compétences de processus qui comportent au moins une étape de relecture manuelle et incluent au moins une Compétence de document. Le système compare l’état initial du document avant la relecture manuelle à son état après traitement. L’Entrepôt d’analyse des rapports stocke les données suivantes :

Informations sur les modifications apportées aux documents
Informations sur les champs des documents :
- Le nombre de valeurs de champs extraites
- Le nombre de valeurs de champs modifiées
- Le statut de chaque champ (indiquant s’il est correct, s’il présente des problèmes de reconnaissance, s’il a été mal localisé ou s’il n’a pas été détecté)

Migration de v1 vers v2

Seul le chemin a changé, passant de « /v1/ » à « /v2/ ». Il n’y a aucune modification des champs de requête/réponse ni du comportement.

Téléchargement d’un rapport de données

Remarque : Seuls les utilisateurs ayant les rôles Tenant Administrator ou Processing Supervisor peuvent télécharger des rapports de données. Pour plus d’informations, voir Contrôle d’accès fondé sur les rôles (RBAC).

Pour obtenir des données depuis l’Entrepôt d’analyse des rapports, envoyez une requête GET à l’une des ressources suivantes, selon le type de rapport dont vous avez besoin :

Récupération des données sur les documents traités par une compétence Process

Récupération des données concernant les champs traités par les skills Process et Document

Le corps de la requête contient les paramètres suivants :

startDate. Premier jour de la période pour laquelle les données doivent être téléchargées (exemple de format : 2022-01-07T13:03:38, l’heure doit être en UTC). Il s’agit d’un paramètre obligatoire.
endDate. Dernier jour de la période pour laquelle les données doivent être téléchargées (exemple de format : 2022-09-07T13:03:38, l’heure doit être en UTC).
processSkillId. L’ID de la Process skill pour laquelle les données doivent être téléchargées. Il s’agit d’un paramètre obligatoire.
documentSkillId. L’ID de la Document skill pour laquelle les données doivent être téléchargées.

Remarque : Vous pouvez inclure ce paramètre uniquement dans la requête /api/reporting/v1/qa/process-skills/fields.

imageType. Le type d’image du document. Valeurs possibles : Unknown, Receipt, A4, BusinessCard, Book, Id, PassportRus, DiscountCard, BankCard, NotDocument, PassportPage.
imageColority. Indique si la première page du document est en couleur, en niveaux de gris ou en noir et blanc. Valeurs possibles : BlackWhite, Gray, Color.
imageSource. La source de l’image du document. Valeurs possibles : Unknown, Photo, Scan, Synthetic, Screenshot, Pdf.
wasCorrectedInManualReview. Indique si les champs du document ont été corrigés lors de la revue manuelle.
wasDocumentTypeChangedInManualReview. Indique si le type de document a été modifié lors de la revue manuelle.

Le fichier CSV obtenu contiendra les informations suivantes, organisées en colonnes.

Rapport sur les modifications apportées aux documents

Column	Description
`ProcessSkillId`	L’ID de la compétence Process.
`ProcessSkillVersion`	La version de la compétence Process.
`ProcessSkillName`	Le nom de la compétence Process.
`DocumentSkillId`	L’ID de la compétence Document.
`DocumentSkillVersion`	La version de la compétence Document.
`DocumentSkillName`	Le nom de la compétence Document.
`TransactionId`	L’ID de la transaction.
`HasManualReview`	Indique si le document a fait l’objet d’une revue manuelle. Valeurs possibles : 1 ou 0.
`DocumentId`	L’ID du document envoyé pour traitement.
`DocumentName`	Le nom du document envoyé pour traitement.
`PageSize`	La taille en pixels (largeur et hauteur) de la première page du document.
`ImageColority`	Indique si la première page du document est en couleur, en niveaux de gris ou en noir et blanc.
`ImageSource`	La source de l’image de la première page du document. Par exemple : scan, photo, fichier PDF, capture d’écran, etc.
`ImageType`	Le type d’image de la première page du document. Par exemple : A4, reçu, carte bancaire, etc.
`DPI`	Le nombre de points (ou pixels) sur la première page du document.
`TransactionParameter1..N`	Paramètres de transaction envoyés pour traitement. Si le document ne contient aucun paramètre de transaction, la valeur dans le rapport sera `null`.
`DimensionField1..MValue`	Champs de dimension envoyés pour traitement. Si le document ne contient aucun champ de dimension, la valeur dans le rapport sera `null`.
`DocumentSkillChanged`	Indique si le type de document a été modifié lors de la revue manuelle. Valeurs possibles : true, false.
`DocumentSkillIdUsedBeforeManualReview`	La compétence Document appliquée au document avant l’étape Manual Review.
`NumberOfExportedFields`	Le nombre de champs exportés dans le document.
`NumberOfChangedFields`	Le nombre de champs modifiés manuellement dans le document.

Les données de ce rapport seront conservées pendant 12 mois.

Rapport sur les modifications apportées aux champs

Column	Description
`ProcessSkillId`	L’ID de la compétence Process.
`ProcessSkillVersion`	La version de la compétence Process.
`ProcessSkillName`	Le nom de la compétence Process.
`DocumentSkillId`	L’ID de la compétence Document.
`DocumentSkillVersion`	La version de la compétence Document.
`DocumentSkillName`	Le nom de la compétence Document.
`TransactionId`	L’ID de la transaction.
`HasManualReview`	Indique si le document a fait l’objet d’une revue manuelle. Valeurs possibles : 1 ou 0.
`DocumentId`	L’ID du document envoyé pour traitement.
`DocumentName`	Le nom du document envoyé pour traitement.
`PageSize`	La taille en pixels (largeur et hauteur) de la première page du document.
`ImageColority`	Indique si la première page du document est en couleur, en niveaux de gris ou en noir et blanc.
`ImageSource`	La source de l’image de la première page du document. Par exemple : scan, photo, fichier PDF, capture d’écran, etc.
`ImageType`	Le type d’image de la première page du document. Par exemple : A4, reçu, carte bancaire, etc.
`DPI`	Le nombre de points (ou pixels) sur la première page du document.
`TransactionParameter1..N`	Paramètres de transaction envoyés pour traitement. Si le document ne contient aucun paramètre de transaction, la valeur dans le rapport sera `null`.
`DimensionField1..MValue`	Champs de dimension envoyés pour traitement. Si le document ne contient aucun champ de dimension, la valeur dans le rapport sera `null`.
`DocumentSkillChanged`	Indique si le type de document a été modifié lors de la revue manuelle. Valeurs possibles : true, false.
`DocumentSkillIdUsedBeforeManualReview`	La compétence Document appliquée au document avant l’étape Manual Review.
`NumberOfExportedFields`	Le nombre de champs exportés dans le document.
`NumberOfChangedFields`	Le nombre de champs modifiés manuellement dans le document.
`FieldID`	L’ID du champ du document.
`FieldName`	Le nom du champ du document.
`Correct`	Informations sur l’état de correction des champs non répétitifs et sur le nombre d’instances de champs répétitifs qui n’ont pas été corrigées. Valeurs possibles : - 1, si le champ non répétitif n’a pas été corrigé lors de la revue manuelle. - Le nombre d’instances d’un champ répétitif qui n’ont pas été corrigées lors de la revue manuelle.
`RecognitionIssue`	Informations sur les problèmes de reconnaissance survenus lors du traitement des champs du document. Valeurs possibles : - 1, si la valeur du champ non répétitif a été corrigée, mais pas la région. - Le nombre d’instances où les valeurs d’un champ répétitif ont été corrigées lors de la revue manuelle.
`DetectedIncorrectly`	Informations sur les corrections qui ont été effectuées lors de la revue manuelle. Valeurs possibles : - 1, si la région et la valeur d’un champ non répétitif ont été corrigées. - Le nombre d’instances où les régions et les valeurs d’un champ répétitif ont été corrigées lors de la revue manuelle.
`NotDetected`	Informations sur les valeurs de champ qui n’ont pas été extraites avant la revue manuelle. Valeurs possibles : - 1, si la valeur d’un champ non répétitif n’a pas été extraites avant la revue manuelle et a été créée par un validateur. - Le nombre d’instances des valeurs d’un champ répétitif qui ont été créées lors de la revue manuelle.
`IsInDocument`	Indique si le champ possède au moins une instance dans le document. Valeurs possibles : true, false.

Les données de ce rapport seront conservées pendant 14 jours. Les données obtenues au format CSV peuvent ensuite être analysées dans n’importe quel outil de BI.

Documentation Index

​Migration de v1 vers v2

​Téléchargement d’un rapport de données

​Récupération des données sur les documents traités par une compétence Process

​Récupération des données concernant les champs traités par les skills Process et Document

​Rapport sur les modifications apportées aux documents