Feat/new checklist (#133)

* create new annotationReport type * handle only new annotationReport * save checklist only if not empty * extract checklist rendering * add viewer mode for checklist * put chekclist in accordion * make check clickable * show lines of concerned selected check * diplay context lines for checklist * styling * add checklist header * eslint * simplify annotationReportType * fix test * change 'label' to 'category' in nlp response * update storage-example * review changes --------- Co-authored-by: Antoine Jeanneney <antoine.jeanneney@justice.fr>
Cour-de-cassation · Oct 22, 2024 · dd89211 · dd89211
1 parent a328728
commit dd89211
Show file tree

Hide file tree

Showing 29 changed files with 679 additions and 160 deletions.
diff --git a/packages/courDeCassation/src/annotator/fetcher/api/nlpApiType.ts b/packages/courDeCassation/src/annotator/fetcher/api/nlpApiType.ts
@@ -1,5 +1,5 @@
 import { labelTreatmentsType } from 'sder';
-import { documentType, settingsType } from '@label/core';
+import { annotationReportType, documentType, settingsType } from '@label/core';
 
 export type { nlpApiType, nlpResponseType, nlpLossType, nlpVersion };
 
@@ -29,7 +29,7 @@ type nlpVersion = {
 
 type nlpResponseType = {
   entities: nlpAnnotationType[];
-  checklist: string[];
+  checklist?: annotationReportType['checklist'];
   newCategoriesToAnnotate?: string[];
   newCategoriesToUnAnnotate?: string[];
   additionalTermsToAnnotate?: string[];
@@ -42,7 +42,7 @@ type nlpAnnotationType = {
   text: string;
   start: number;
   end: number;
-  label: string;
+  category: string;
   source: string;
   score: number;
   entityId: string;

diff --git a/packages/courDeCassation/src/annotator/fetcher/api/nlpLocalApi.ts b/packages/courDeCassation/src/annotator/fetcher/api/nlpLocalApi.ts
@@ -37,7 +37,7 @@ function buildNlpLocalApi(): nlpApiType {
       return {
         ...annotations,
         entities: annotations.entities.filter((entity) =>
-          availableCategories.includes(entity.label),
+          availableCategories.includes(entity.category),
         ),
         checklist: annotations.checklist,
         newCategoriesToAnnotate: annotations.newCategoriesToAnnotate,

diff --git a/packages/courDeCassation/src/annotator/fetcher/mapper/nlpMapper.spec.ts b/packages/courDeCassation/src/annotator/fetcher/mapper/nlpMapper.spec.ts
@@ -26,7 +26,7 @@ const nlpAnnotations: nlpResponseType = {
       text: 'ANNOTATION1',
       start: 0,
       end: 11,
-      label: 'LABEL1',
+      category: 'LABEL1',
       source: 'NLP',
       score: 0.5,
       entityId: 'LABEL1_annotation1',
@@ -35,13 +35,13 @@ const nlpAnnotations: nlpResponseType = {
       text: 'ANNOTATION2',
       start: 12,
       end: 23,
-      label: 'LABEL2',
+      category: 'LABEL2',
       source: 'NLP',
       score: 0.6,
       entityId: 'LABEL2_annotation2',
     },
   ],
-  checklist: ['CHECK 1', 'CHECK 2'],
+  checklist: [],
   versions: nlpVersion,
 };
 
@@ -51,7 +51,7 @@ const nlpAnnotationsWithAdditionalTerms: nlpResponseType = {
       text: 'ANNOTATION1',
       start: 0,
       end: 11,
-      label: 'LABEL1',
+      category: 'LABEL1',
       source: 'NLP',
       score: 0.5,
       entityId: 'LABEL1_annotation1',
@@ -60,13 +60,80 @@ const nlpAnnotationsWithAdditionalTerms: nlpResponseType = {
       text: 'ANNOTATION2',
       start: 12,
       end: 23,
-      label: 'LABEL2',
+      category: 'LABEL2',
       source: 'NLP',
       score: 0.6,
       entityId: 'LABEL2_annotation2',
     },
   ],
-  checklist: ['CHECK 1', 'CHECK 2'],
+  checklist: [],
+  additionalTermsToUnAnnotate: ['blabla', 'toto'],
+  versions: nlpVersion,
+};
+
+const nlpAnnotationsWithChecklist: nlpResponseType = {
+  entities: [
+    {
+      text: 'ANNOTATION1',
+      start: 0,
+      end: 11,
+      category: 'LABEL1',
+      source: 'NLP',
+      score: 0.5,
+      entityId: 'LABEL1_annotation1',
+    },
+  ],
+  checklist: [
+    {
+      checkType: 'missing_something',
+      message: "Label est-il un bon logiciel d'annotation ?",
+      entities: [
+        {
+          text: 'Label',
+          start: 0,
+          end: 5,
+          category: 'myCategory',
+          source: 'source1',
+          score: 0.85,
+          entityId: 'myCategory',
+        },
+        {
+          text: 'Application',
+          start: 10,
+          end: 15,
+          category: 'myCategory',
+          source: 'source2',
+          score: 0.9,
+          entityId: 'myCategory_application',
+        },
+      ],
+      sentences: [
+        {
+          start: 0,
+          end: 50,
+        },
+      ],
+      metadata_text: ['Label', 'Applcation'],
+    },
+    {
+      checkType: 'other',
+      message:
+        "L'annotation [Antoine] est présente dans les catégories [développeur, data scientist] est-ce une erreur ?",
+      entities: [
+        {
+          text: 'Antoine',
+          start: 20,
+          end: 25,
+          category: 'developpeur',
+          source: 'nlp',
+          score: 1,
+          entityId: 'developpeur_antoine',
+        },
+      ],
+      sentences: undefined,
+      metadata_text: undefined,
+    },
+  ],
   additionalTermsToUnAnnotate: ['blabla', 'toto'],
   versions: nlpVersion,
 };
@@ -102,12 +169,62 @@ describe('nlpMapper', () => {
   describe('mapNlpAnnotationstoReport', () => {
     it('should convert the nlp annotations into an annotation report', () => {
       const annotationReport = nlpMapper.mapNlpAnnotationstoReport(
-        nlpAnnotations,
+        nlpAnnotationsWithChecklist,
         document,
       );
 
       expect(annotationReport).toEqual({
-        checklist: ['CHECK 1', 'CHECK 2'],
+        checklist: [
+          {
+            checkType: 'missing_something',
+            message: "Label est-il un bon logiciel d'annotation ?",
+            entities: [
+              {
+                text: 'Label',
+                start: 0,
+                end: 5,
+                category: 'myCategory',
+                source: 'source1',
+                score: 0.85,
+                entityId: 'myCategory',
+              },
+              {
+                text: 'Application',
+                start: 10,
+                end: 15,
+                category: 'myCategory',
+                source: 'source2',
+                score: 0.9,
+                entityId: 'myCategory_application',
+              },
+            ],
+            sentences: [
+              {
+                start: 0,
+                end: 50,
+              },
+            ],
+            metadata_text: ['Label', 'Applcation'],
+          },
+          {
+            checkType: 'other',
+            message:
+              "L'annotation [Antoine] est présente dans les catégories [développeur, data scientist] est-ce une erreur ?",
+            entities: [
+              {
+                text: 'Antoine',
+                start: 20,
+                end: 25,
+                category: 'developpeur',
+                source: 'nlp',
+                score: 1,
+                entityId: 'developpeur_antoine',
+              },
+            ],
+            sentences: undefined,
+            metadata_text: undefined,
+          },
+        ],
         documentId: document._id,
         _id: annotationReport._id,
       });

diff --git a/packages/courDeCassation/src/annotator/fetcher/mapper/nlpMapper.ts b/packages/courDeCassation/src/annotator/fetcher/mapper/nlpMapper.ts
@@ -21,7 +21,7 @@ function mapNlpAnnotationsToAnnotations(
 ): annotationType[] {
   return nlpAnnotations.entities.map((nlpAnnotation) =>
     annotationModule.lib.buildAnnotation({
-      category: nlpAnnotation.label,
+      category: nlpAnnotation.category,
       entityId: nlpAnnotation.entityId,
       start: nlpAnnotation.start,
       certaintyScore: nlpAnnotation.score,
@@ -35,7 +35,7 @@ function mapNlpAnnotationstoReport(
   document: documentType,
 ): annotationReportType {
   return annotationReportModule.lib.buildAnnotationReport({
-    checklist: nlpAnnotations.checklist,
+    checklist: nlpAnnotations.checklist ?? [],
     documentId: document._id,
   });
 }

diff --git a/packages/courDeCassation/src/annotator/fetcher/nlpFetcher.spec.ts b/packages/courDeCassation/src/annotator/fetcher/nlpFetcher.spec.ts
@@ -39,7 +39,7 @@ describe('nlpFetcher', () => {
           annotations.some(
             (annotation) =>
               annotation.start === nlpAnnotation.start &&
-              annotation.category === nlpAnnotation.label,
+              annotation.category === nlpAnnotation.category,
           ),
         ).toEqual(true);
       });

diff --git a/packages/courDeCassation/src/annotator/test/generator/nlpAnnotationsGenerator.ts b/packages/courDeCassation/src/annotator/test/generator/nlpAnnotationsGenerator.ts
@@ -24,7 +24,7 @@ function generateRandomNlpAnnotation() {
     start: start,
     end: start + random(8),
     score: Math.random(),
-    label: `LABEL`,
+    category: `LABEL`,
     source: `NLP`,
     entityId: `LABEL_${text.toLowerCase()}`,
   };

diff --git a/packages/courDeCassation/storage-example/annotations/123452.json b/packages/courDeCassation/storage-example/annotations/123452.json
@@ -1,5 +1,4 @@
 {
   "entities": [],
-  "check_needed": false,
   "checklist": []
 }