Merge pull request #119 from kurusugawa-computer/annofab-v0.71.0

Annofab v0.71.0に対応する

Author: yuji38kwmt

annofabapi/__version__.py

@@ -1 +1 @@
-__version__ = '0.25.2'
+__version__ = '0.26.0'

annofabapi/dataclass/annotation.py

@@ -225,13 +225,13 @@ class SimpleAnnotation:
     """入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
     input_data_name: str
-    """"""
+    """入力データ名"""
 
     details: List[SimpleAnnotationDetail]
-    """"""
+    """矩形、ポリゴン、全体アノテーションなど個々のアノテーションの配列。"""
 
-    updated_datetime: str
-    """"""
+    updated_datetime: Optional[str]
+    """更新日時。アノテーションが一つもない場合（教師付作業が未着手のときなど）は、未指定。"""
 
 
 @dataclass_json

annofabapi/dataclass/annotation_specs.py

@@ -40,6 +40,19 @@ class Keybind:
     """"""
 
 
+@dataclass_json
+@dataclass
+class PositionForMinimumBoundingBoxInsertion:
+    """
+    `annotation_type` が `bounding_box` かつ `min_warn_rule` が `and` または `or` の場合のみ、挿入する最小矩形アノテーションの原点を指定できます。 画像左上の座標が「x=0, y=0」です。 未指定、もしくは「画像外に飛び出たアノテーション」を許可していないにも関わらず飛び出してしまう場合は、表示範囲の中央に挿入されます。 「スキャンした帳票の記入欄」や「定点カメラで撮影した製品ラベル」など、アノテーションしたい位置やサイズが多くの画像で共通している場合に便利です。  `annotation_type` が `bounding_box` 以外の場合は必ず未指定となります。 
+    """
+    x: int
+    """"""
+
+    y: int
+    """"""
+
+
 @dataclass_json
 @dataclass
 class LabelV1BoundingBoxMetadata:
@@ -64,6 +77,9 @@ class LabelV1BoundingBoxMetadata:
     min_vertices: Optional[int]
     """"""
 
+    position_for_minimum_bounding_box_insertion: Optional[PositionForMinimumBoundingBoxInsertion]
+    """"""
+
     tolerance: Optional[int]
     """"""
 

annofabapi/dataclass/input.py

@@ -61,6 +61,9 @@ class InputData:
     resized_resolution: Optional[Resolution]
     """"""
 
+    input_duration: Optional[float]
+    """入力データが動画の場合、動画の長さ（秒）。小数点以下はミリ秒以下を表します。  動画の長さが取得できなかった場合、あるいは入力データが画像の場合は値なし。 """
+
     updated_datetime: str
     """"""
 

annofabapi/generated_api.py

@@ -389,6 +389,31 @@ def get_archive_full_with_pro_id(self, project_id: str, **kwargs) -> Tuple[Any,
         keyword_params: Dict[str, Any] = {}
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
+    def get_editor_annotation(self, project_id: str, task_id: str, input_data_id: str,
+                              **kwargs) -> Tuple[Any, requests.Response]:
+        """タスク/入力データのアノテーション一括取得
+
+
+        authorizations: AllProjectMember
+
+
+        [putAnnotation](#operation/putAnnotation)が要求する構造のアノテーションを取得します。 このAPIは、[putAnnotation](#operation/putAnnotation)をより利用しやすくする目的で提供しています。 機械学習などで利用する成果物としてのアノテーションを取得するには、以下をご利用いただけます。  * [getAnnotation](#operation/getAnnotation): 特定のタスク - 入力データのアノテーション取得 * [getAnnotationArchive](#operation/getAnnotationArchive): プロジェクト全体のアノテーション（ZIP） 
+
+        Args:
+            project_id (str):  プロジェクトID (required)
+            task_id (str):  タスクID (required)
+            input_data_id (str):  入力データID (required)
+
+        Returns:
+            Tuple[Annotation, requests.Response]
+
+
+        """
+        url_path = f'/projects/{project_id}/tasks/{task_id}/inputs/{input_data_id}/annotation'
+        http_method = 'GET'
+        keyword_params: Dict[str, Any] = {}
+        return self._request_wrapper(http_method, url_path, **keyword_params)
+
     def post_annotation_archive_update(self, project_id: str, **kwargs) -> Tuple[Any, requests.Response]:
         """アノテーションZIP更新開始
 
@@ -1786,6 +1811,7 @@ def get_account_statistics(self, project_id: str, **kwargs) -> Tuple[Any, reques
         authorizations: AllProjectMember
 
 
+        ユーザごと、日ごとに集計した以下のデータを取得します。 * 教師付を担当したタスクが完了状態になった回数 * 教師付を担当したタスクが差し戻された回数 * 作業時間 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -1807,6 +1833,7 @@ def get_inspection_statistics(self, project_id: str, **kwargs) -> Tuple[Any, req
         authorizations: AllProjectMember
 
 
+        ラベルごと、定型指摘ごとに集計した検査コメント数を取得します。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -1871,6 +1898,7 @@ def get_task_phase_statistics(self, project_id: str, **kwargs) -> Tuple[Any, req
         authorizations: AllProjectMember
 
 
+        日ごと、フェーズごとに集計した以下のデータを取得します。 * 累積作業時間 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -1892,6 +1920,7 @@ def get_task_statistics(self, project_id: str, **kwargs) -> Tuple[Any, requests.
         authorizations: AllProjectMember
 
 
+        日ごと、タスクフェーズごと、タスクステータスごとに集計した以下のデータを取得します。 * タスク数 * 累計作業時間 
 
         Args:
             project_id (str):  プロジェクトID (required)

annofabapi/models.py

@@ -1870,6 +1870,8 @@ class GraphType(Enum):
     
 * resized_resolution: Resolution
     
+* input_duration: float
+    入力データが動画の場合、動画の長さ（秒）。小数点以下はミリ秒以下を表します。  動画の長さが取得できなかった場合、あるいは入力データが画像の場合は値なし。 
 * updated_datetime: str
     
 * sign_required: bool
@@ -2364,6 +2366,8 @@ class JobType(Enum):
     
 * min_vertices: int
     
+* position_for_minimum_bounding_box_insertion: PositionForMinimumBoundingBoxInsertion
+    
 * tolerance: int
     
 
@@ -2714,6 +2718,19 @@ class OrganizationMemberStatus(Enum):
 * y: int
     
 
+"""
+
+PositionForMinimumBoundingBoxInsertion = Dict[str, Any]
+"""
+`annotation_type` が `bounding_box` かつ `min_warn_rule` が `and` または `or` の場合のみ、挿入する最小矩形アノテーションの原点を指定できます。 画像左上の座標が「x=0, y=0」です。 未指定、もしくは「画像外に飛び出たアノテーション」を許可していないにも関わらず飛び出してしまう場合は、表示範囲の中央に挿入されます。 「スキャンした帳票の記入欄」や「定点カメラで撮影した製品ラベル」など、アノテーションしたい位置やサイズが多くの画像で共通している場合に便利です。  `annotation_type` が `bounding_box` 以外の場合は必ず未指定となります。 
+
+Kyes of Dict
+
+* x: int
+    
+* y: int
+    
+
 """
 
 
@@ -3142,11 +3159,11 @@ class ProjectStatus(Enum):
 * input_data_id: str
     入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) 
 * input_data_name: str
-    
+    入力データ名
 * details: List[SimpleAnnotationDetail]
-    
+    矩形、ポリゴン、全体アノテーションなど個々のアノテーションの配列。
 * updated_datetime: str
-    
+    更新日時。アノテーションが一つもない場合（教師付作業が未着手のときなど）は、未指定。
 
 """
 

generate/generate.sh

@@ -130,6 +130,7 @@ cat partial-header/dataclass/common.py partial-header/dataclass/annotation.py  \
 
 # Annotation Specs
 declare -a model_files=(${MODELS_DIR}/keybind.py \
+ ${MODELS_DIR}/position_for_minimum_bounding_box_insertion.py \
  ${MODELS_DIR}/label_v1_bounding_box_metadata.py \
  ${MODELS_DIR}/label_v1_segmentation_metadata.py \
  ${MODELS_DIR}/internationalization_message_messages.py \