diff --git a/annofabapi/dataclass/job.py b/annofabapi/dataclass/job.py new file mode 100644 index 00000000..9909a105 --- /dev/null +++ b/annofabapi/dataclass/job.py @@ -0,0 +1,45 @@ +# ruff: noqa: E501 +# pylint: disable=too-many-lines,trailing-whitespace + +""" +Deprecated: 2025-02-01 以降に廃止します +""" + +from dataclasses import dataclass +from typing import Any, Optional # pylint: disable=unused-import + +from dataclasses_json import DataClassJsonMixin + +from annofabapi.models import Errors, JobStatus, ProjectJobType + + +@dataclass +class ProjectJobInfo(DataClassJsonMixin): + """ """ + + project_id: str + """プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """ + + job_type: ProjectJobType + """""" + + job_id: str + """ジョブID。[値の制約についてはこちら。](#section/API-Convention/APIID) """ + + job_status: JobStatus + """""" + + job_execution: Optional[dict[str, Any]] + """ジョブの内部情報""" + + job_detail: Optional[dict[str, Any]] + """ジョブ結果の内部情報""" + + errors: Errors + """""" + + created_datetime: str + """作成日時""" + + updated_datetime: str + """更新日時""" diff --git a/annofabapi/dataclass/project.py b/annofabapi/dataclass/project.py new file mode 100644 index 00000000..6eeeaf2f --- /dev/null +++ b/annofabapi/dataclass/project.py @@ -0,0 +1,116 @@ +# ruff: noqa: E501 +# pylint: disable=too-many-lines,trailing-whitespace + +""" +Deprecated: 2025-02-01 以降に廃止します +""" + +from dataclasses import dataclass +from typing import Optional # pylint: disable=unused-import + +from dataclasses_json import DataClassJsonMixin + +from annofabapi.models import AssigneeRuleOfResubmittedTask, InputDataType, ProjectStatus, TaskAssignmentProperty, TaskAssignmentType + + +@dataclass +class ProjectSummary(DataClassJsonMixin): + """ + プロジェクトのサマリー情報 + """ + + last_tasks_updated_datetime: Optional[str] + """タスクの最終更新日時""" + + +@dataclass +class ProjectConfiguration(DataClassJsonMixin): + """ + プロジェクトの設定情報 + """ + + number_of_inspections: Optional[int] + """検査回数。 * 0回:教師付け -> 受入 * 1回:教師付け -> 検査 -> 受入 * n回(n >= 2):教師付け -> 検査1 -> ... -> 検査n -> 受入 """ + + assignee_rule_of_resubmitted_task: Optional[AssigneeRuleOfResubmittedTask] + """""" + + task_assignment_type: Optional[TaskAssignmentType] + """""" + + task_assignment_property: Optional[TaskAssignmentProperty] + """""" + + max_tasks_per_member: Optional[int] + """保留中のタスクを除き、1人(オーナー以外)に割り当てられるタスク数の上限。 """ + + max_tasks_per_member_including_hold: Optional[int] + """保留中のタスクを含めて、1人(オーナー以外)に割り当てられるタスク数上限の保留分。 割り当て時の上限チェックは、max_tasks_per_memberとこの数字の合計で行われます。 例えばmax_tasks_per_memberが10、max_tasks_per_member_including_holdが20の場合、保留中を含むタスク数の割り当て上限は30になります。 """ + + input_data_set_id_list: Optional[list[str]] + """システム内部用のプロパティ。 [putProject](#operation/putProject) APIでプロジェクトを更新する際は、[getProject](#operation/getProject) APIで取得した値を指定してください。 """ + + input_data_max_long_side_length: Optional[int] + """入力データ画像の長辺の最大値(未指定時は4096px)。 画像をアップロードすると、長辺がこの値になるように画像が自動で圧縮されます。 アノテーションの座標は、もとの解像度の画像でつけたものに復元されます。 大きな数値を設定すると入力データ画像のサイズが大きくなり、生産性低下やブラウザで画像を表示できない懸念があります。注意して設定してください。 """ + + sampling_inspection_rate: Optional[int] + """抜取検査率[%]。未指定の場合は100%として扱う。""" + + sampling_acceptance_rate: Optional[int] + """抜取受入率[%]。未指定の場合は100%として扱う。""" + + private_storage_aws_iam_role_arn: Optional[str] + """AWS IAMロール。S3プライベートストレージの認可で使います。 [S3プライベートストレージの認可の設定についてはこちら](/docs/faq/#m0b240)をご覧ください。 """ + + plugin_id: Optional[str] + """プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID) """ + + custom_task_assignment_plugin_id: Optional[str] + """プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID) """ + + custom_specs_plugin_id: Optional[str] + """プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID) """ + + extended_specs_plugin_id: Optional[str] + """プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID) """ + + editor_version: Optional[str] + """標準アノテーションエディタのバージョン。 * `stable` * 安定版。通常はこちらを利用してください。 * `preview` * 最新版。新機能やUI変更の先行リリース版。 プロジェクト更新時に未指定の場合は `stable` が指定されたものとみなします。 """ + + use_beginner_navigation: Optional[bool] + """true の場合、プロジェクトの画面でナビゲーションUIを表示します(ログインユーザーがプロジェクトオーナーの場合のみ)。 """ + + +@dataclass +class Project(DataClassJsonMixin): + """ """ + + project_id: str + """プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """ + + organization_id: str + """組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """ + + title: str + """プロジェクトのタイトル""" + + overview: Optional[str] + """プロジェクトの概要""" + + project_status: ProjectStatus + """""" + + input_data_type: InputDataType + """""" + + configuration: ProjectConfiguration + """""" + + created_datetime: str + """作成日時""" + + updated_datetime: str + """更新日時""" + + summary: ProjectSummary + """"""