Skip to content

Commit d6bfdb7

Browse files
yuji38kwmtyuji38kwmt
authored
Merge pull request #114 from kurusugawa-computer/annofab-v0.70.0
Annofab v0.70.0対応
2 parents e90e98f + 06696f7 commit d6bfdb7

File tree

9 files changed

+175
-57
lines changed

9 files changed

+175
-57
lines changed

‎annofabapi/__version__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '0.24.3'
1+
__version__ = '0.25.0'

‎annofabapi/dataclass/project.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class ProjectSummary:
2424
2525
"""
2626
last_tasks_updated_datetime: Optional[str]
27-
""""""
27+
"""タスクの最終更新日時"""
2828

2929

3030
@dataclass_json
@@ -77,15 +77,15 @@ class Project:
7777
""""""
7878

7979
title: str
80-
""""""
80+
"""プロジェクトのタイトル"""
8181

8282
overview: Optional[str]
83-
""""""
83+
"""プロジェクトの概要"""
8484

85-
project_status: Optional[ProjectStatus]
85+
project_status: ProjectStatus
8686
""""""
8787

88-
input_data_type: Optional[InputDataType]
88+
input_data_type: InputDataType
8989
""""""
9090

9191
configuration: ProjectConfiguration

‎annofabapi/dataclass/task.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ class TaskHistory:
3838
ended_datetime: Optional[str]
3939
""""""
4040

41-
accumulated_labor_time_milliseconds: Optional[str]
41+
accumulated_labor_time_milliseconds: str
4242
"""累計実作業時間（ISO 8601 duration）"""
4343

44-
phase: Optional[TaskPhase]
44+
phase: TaskPhase
4545
""""""
4646

47-
phase_stage: Optional[int]
47+
phase_stage: int
4848
""""""
4949

5050
account_id: Optional[str]
@@ -60,10 +60,10 @@ class TaskHistoryShort:
6060
phase: TaskPhase
6161
""""""
6262

63-
phase_stage: Optional[int]
63+
phase_stage: int
6464
""""""
6565

66-
account_id: Optional[str]
66+
account_id: str
6767
""""""
6868

6969

@@ -82,20 +82,20 @@ class Task:
8282
phase: TaskPhase
8383
""""""
8484

85-
phase_stage: Optional[int]
85+
phase_stage: int
8686
""""""
8787

8888
status: TaskStatus
8989
""""""
9090

91-
input_data_id_list: Optional[List[str]]
92-
""""""
91+
input_data_id_list: List[str]
92+
"""タスクに含まれる入力データのID"""
9393

9494
account_id: Optional[str]
9595
""""""
9696

9797
histories_by_phase: Optional[List[TaskHistoryShort]]
98-
""""""
98+
"""簡易的なタスク履歴（あるフェーズを誰が担当したか）"""
9999

100100
work_time_span: int
101101
"""累計実作業時間(ミリ秒)"""

‎annofabapi/generated_api.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ def get_annotation_archive(self, project_id: str, query_params: Optional[Dict[st
325325
v2 (str): このクエリパラメータのキーだけを指定（`?v2`）、または値 `true` も指定（`?v2=true`）すると、アノテーションJSONのファイル名は `{入力データID}.json` になります。 この v2 形式は、入力データ名がファイル名の長さ上限を上回ってもよいように再設計されたものです。 以前の v1 形式（アノテーションJSONのファイル名は `{入力データ名}.json` ）はいずれ廃止され、クエリパラメータ `v2` があってもなくても v2 形式に置き換わる予定です。
326326
327327
Returns:
328-
Tuple[InlineResponse2004, requests.Response]
328+
Tuple[InlineResponse2009, requests.Response]
329329
330330
331331
"""
@@ -380,7 +380,7 @@ def get_archive_full_with_pro_id(self, project_id: str, **kwargs) -> Tuple[Any,
380380
project_id (str): プロジェクトID (required)
381381
382382
Returns:
383-
Tuple[InlineResponse2004, requests.Response]
383+
Tuple[InlineResponse2009, requests.Response]
384384
385385
386386
"""
@@ -644,7 +644,7 @@ def get_input_data_list(self, project_id: str, query_params: Optional[Dict[str,
644644
limit (int): 1ページあたりの取得するデータ件数
645645
646646
Returns:
647-
Tuple[InlineResponse2009, requests.Response]
647+
Tuple[InlineResponse20010, requests.Response]
648648
649649
650650
"""
@@ -1652,7 +1652,7 @@ def post_project_tasks_update(self, project_id: str, **kwargs) -> Tuple[Any, req
16521652
authorizations: ProjectOwner
16531653
16541654
1655-
プロジェクト内のタスク全件ファイルの更新を開始します。 ファイルの更新時間は、データ量に応じて数分～数十分程度かかります。 タスク全件ファイルは毎日AM 02:00 JSTに自動更新されます。 本APIを用いると、自動更新を待たずに更新を要求できます。 ただし、タスク全件ファイル以外は更新されません。 タスク全件ファイルについては、[getProjectTasksUrl](#operation/getProjectTasksUrl) APIを参照ください。
1655+
プロジェクト内のタスク全件ファイルの更新を開始します。 ファイルの更新時間は、データ量に応じて数分～数十分程度かかります。 本APIを実行すると、バックグラウンドジョブが登録されます。ジョブは [getProjectJob](#operation/getProjectJob) APIで確認できます（ジョブ種別は`gen-tasks-list`）。 タスク全件ファイルは毎日AM 02:00 JSTに自動更新されます。 本APIを用いると、自動更新を待たずに更新を要求できます。 ただし、タスク全件ファイル以外は更新されません。 タスク全件ファイルについては、[getProjectTasksUrl](#operation/getProjectTasksUrl) APIを参照ください。
16561656
16571657
Args:
16581658
project_id (str): プロジェクトID (required)
@@ -1680,7 +1680,7 @@ def put_project(self, project_id: str, request_body: Optional[Any] = None,
16801680
Args:
16811681
project_id (str): プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) (required)
16821682
request_body (Any): Request Body
1683-
put_project_request (PutProjectRequest): (required)
1683+
put_project_request (PutProjectRequest):
16841684
16851685
Returns:
16861686
Tuple[Project, requests.Response]

‎annofabapi/models.py

+36-24
Original file line numberDiff line numberDiff line change
@@ -779,7 +779,7 @@ class AnnotationType(Enum):
779779

780780
class AssigneeRuleOfResubmittedTask(Enum):
781781
"""
782-
* `no_assignee` - 以前の担当者で固定せず、未割当てにします。 * `fixed` - 以前の担当者が再度担当します。以前の担当者がいない(1回目の検査/受入)場合は未割当てになります。
782+
再提出されたタスクの検査/受入担当者の割当方法 * `no_assignee` - 以前の担当者で固定せず、未割当てにします。 * `fixed` - 以前の担当者が再度担当します。以前の担当者がいない(1回目の検査/受入)場合は未割当てになります。
783783
"""
784784

785785
NO_ASSIGNEE = "no_assignee"
@@ -1693,6 +1693,27 @@ class GraphType(Enum):
16931693
16941694
"""
16951695

1696+
InlineResponse20010 = Dict[str, Any]
1697+
"""
1698+
1699+
1700+
Kyes of Dict
1701+
1702+
* list: List[InputData]
1703+
現在のページ番号に含まれる0件以上の入力データです。
1704+
* page_no: float
1705+
現在のページ番号です。
1706+
* total_page_no: float
1707+
指定された条件にあてはまる検索結果の総ページ数。検索条件に当てはまる入力データが0件であっても、総ページ数は1となります。
1708+
* total_count: float
1709+
検索結果の総件数。
1710+
* over_limit: bool
1711+
検索結果が1万件を超えた場合にtrueとなる。
1712+
* aggregations: List[AggregationResult]
1713+
Aggregationによる集約結果。
1714+
1715+
"""
1716+
16961717
InlineResponse2002 = Dict[str, Any]
16971718
"""
16981719
@@ -1820,18 +1841,8 @@ class GraphType(Enum):
18201841
18211842
Kyes of Dict
18221843
1823-
* list: List[InputData]
1824-
現在のページ番号に含まれる0件以上の入力データです。
1825-
* page_no: float
1826-
現在のページ番号です。
1827-
* total_page_no: float
1828-
指定された条件にあてはまる検索結果の総ページ数。検索条件に当てはまる入力データが0件であっても、総ページ数は1となります。
1829-
* total_count: float
1830-
検索結果の総件数。
1831-
* over_limit: bool
1832-
検索結果が1万件を超えた場合にtrueとなる。
1833-
* aggregations: List[AggregationResult]
1834-
Aggregationによる集約結果。
1844+
* url: str
1845+
認証済み一時URL
18351846
18361847
"""
18371848

@@ -1912,7 +1923,7 @@ class InputDataOrder(Enum):
19121923

19131924
class InputDataType(Enum):
19141925
"""
1915-
プロジェクトの作成時のみ指定可能（未指定の場合は image）です。更新時は無視されます
1926+
アノテーションする入力データの種類。プロジェクトの作成時のみ指定可能（未指定の場合は `image`）です。更新時は無視されます。 * `image` - 画像 * `movie` - 動画
19161927
"""
19171928

19181929
IMAGE = "image"
@@ -2725,9 +2736,9 @@ class PricePlan(Enum):
27252736
* organization_id: str
27262737
27272738
* title: str
2728-
2739+
プロジェクトのタイトル
27292740
* overview: str
2730-
2741+
プロジェクトの概要
27312742
* project_status: ProjectStatus
27322743
27332744
* input_data_type: InputDataType
@@ -2811,9 +2822,9 @@ class PricePlan(Enum):
28112822
* dest_project_id: str
28122823
プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)
28132824
* dest_title: str
2814-
2825+
コピー先プロジェクトのタイトル
28152826
* dest_overview: str
2816-
2827+
コピー先プロジェクトの概要
28172828
* copy_inputs: bool
28182829
「入力データ」をコピーするかどうかを指定します。
28192830
* copy_tasks: bool
@@ -2901,6 +2912,7 @@ class ProjectMemberStatus(Enum):
29012912

29022913
class ProjectStatus(Enum):
29032914
"""
2915+
プロジェクトの状態 * `active` - プロジェクトが進行中 * `suspended` - プロジェクトが停止中
29042916
"""
29052917

29062918
ACTIVE = "active"
@@ -2914,7 +2926,7 @@ class ProjectStatus(Enum):
29142926
Kyes of Dict
29152927
29162928
* last_tasks_updated_datetime: str
2917-
2929+
タスクの最終更新日時
29182930
29192931
"""
29202932

@@ -3045,9 +3057,9 @@ class ProjectStatus(Enum):
30453057
Kyes of Dict
30463058
30473059
* title: str
3048-
3060+
プロジェクトのタイトル
30493061
* overview: str
3050-
3062+
プロジェクトの概要
30513063
* status: ProjectStatus
30523064
30533065
* input_data_type: InputDataType
@@ -3277,11 +3289,11 @@ class SupplementaryDataType(Enum):
32773289
* status: TaskStatus
32783290
32793291
* input_data_id_list: List[str]
3280-
3292+
タスクに含まれる入力データのID
32813293
* account_id: str
32823294
32833295
* histories_by_phase: List[TaskHistoryShort]
3284-
3296+
簡易的なタスク履歴（あるフェーズを誰が担当したか）
32853297
* work_time_span: int
32863298
累計実作業時間(ミリ秒)
32873299
* number_of_rejections: int
@@ -3354,7 +3366,7 @@ class TaskAssignmentType(Enum):
33543366
* task_generate_rule: OneOfTaskGenerateRuleByCountTaskGenerateRuleByDirectoryTaskGenerateRuleByInputDataCsv
33553367
* `TaskGenerateRuleByCount`: 1つのタスクに割りあてる入力データの個数を指定してタスクを生成します。 * `TaskGenerateRuleByDirectory`: 入力データ名をファイルパスに見立て、ディレクトリ単位でタスクを生成します。 * `TaskGenerateRuleByInputDataCsv`: 各タスクへの入力データへの割当を記入したCSVへのS3上のパスを指定してタスクを生成します。
33563368
* project_last_updated_datetime: str
3357-
プロジェクトの最終更新日時。タスク生成の排他制御に使用。
3369+
プロジェクトの最終更新日時（[getProject](#operation/getProject) APIのレスポンス `updated_datetime`）。タスク生成の排他制御に使用。
33583370
33593371
"""
33603372

0 commit comments

Comments
 (0)