Merge pull request #116 from doccano/enhancement/add-score-field-to-e…

…xample-model

Add score field to example model

doccano_client/cli/active_learning/manager.py

@@ -67,6 +67,6 @@ def execute_active_learning(
             )
             print("Update confidence scores...")
             for score, example_id in tqdm(zip(scores, example_ids)):
-                client.update_example(project_id, example_id, meta={"confidence": score})
+                client.update_example(project_id, example_id, score=score)
             print("Update completed.")
         time.sleep(10)

doccano_client/client.py

@@ -561,34 +561,36 @@ def count_examples(self, project_id: int) -> int:
         """
         return self.example.count(project_id)
 
-    def create_example(self, project_id: int, text: str, meta: Dict[str, Any] = None) -> Example:
+    def create_example(self, project_id: int, text: str, score: float = 100, meta: Dict[str, Any] = None) -> Example:
         """Create a new example.
 
         Args:
             project_id (int): The id of the project.
             text (str): The text of the example.
+            score (float): The confidence score of the example. Defaults to 100.
             meta (Dict[str, Any]): The meta data of the example.
 
         Returns:
             Example: The created example.
         """
-        return self.example.create(project_id, text, meta)
+        return self.example.create(project_id, text, score, meta)
 
     def update_example(
-        self, project_id: int, example_id: int, text: str = None, meta: Dict[str, Any] = None
+        self, project_id: int, example_id: int, text: str = None, score: float = None, meta: Dict[str, Any] = None
     ) -> Example:
         """Update an example.
 
         Args:
             project_id (int): The id of the project.
             example_id (int): The id of the example.
             text (str): The text of the example.
+            score (float): The confidence score of the example.
             meta (Dict[str, Any]): The meta data of the example.
 
         Returns:
             Example: The updated example.
         """
-        return self.example.update(project_id, example_id, text, meta)
+        return self.example.update(project_id, example_id, text, score, meta)
 
     def delete_example(self, project_id: int, example_id: int):
         """Delete an example.

doccano_client/models/example.py

@@ -14,3 +14,4 @@ class Example(BaseModel):
     is_confirmed: bool = False
     filename: str = ""
     upload_name: str = ""
+    score: float = 100

doccano_client/usecase/example.py

@@ -47,28 +47,31 @@ def create(
         self,
         project_id: int,
         text: str,
+        score: float = 100.0,
         meta: Dict[str, Any] = None,
     ) -> Example:
         """Create a new example
 
         Args:
             project_id (int): The id of the project
             text (str): The text of the example
+            score (float): The confidence score of the example
             meta (Dict[str, Any]): The meta data of the example
 
         Returns:
             Example: The created example
         """
         if meta is None:
             meta = {}
-        example = Example(text=text, meta=meta)
+        example = Example(text=text, score=score, meta=meta)
         return self._repository.create(project_id, example)
 
     def update(
         self,
         project_id: int,
         example_id: int,
         text: str = None,
+        score: float = None,
         meta: Dict[str, Any] = None,
     ) -> Example:
         """Update a example
@@ -77,6 +80,7 @@ def update(
             project_id (int): The id of the project
             example_id (int): The id of the example
             text (str): The text of the example
+            score (float): The confidence score of the example
             meta (Dict[str, Any]): The meta data of the example
 
         Returns:
@@ -86,6 +90,7 @@ def update(
         example = Example(
             id=example_id,
             text=text if text is not None else example.text,
+            score=score if score is not None else example.score,
             meta=meta if meta is not None else example.meta,
         )
         return self._repository.update(project_id, example)