annofabapi.dataclass module

annofabapi.dataclass.annotation module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.annotation.AdditionalData(additional_data_definition_id: str, flag: Optional[bool], integer: Optional[int], comment: Optional[str], choice: Optional[str])[source]
additional_data_definition_id: str

属性ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

choice: Optional[str]

選択肢ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

comment: Optional[str]

additional_data_definition`の`type`が`text,`comment`,`link` または `tracking`のときの属性値。

flag: Optional[bool]

`additional_data_definition`の`type`が`flag`のときの属性値。

integer: Optional[int]

`additional_data_definition`の`type`が`integer`のときの属性値。

class annofabapi.dataclass.annotation.Annotation(project_id: str, task_id: str, input_data_id: str, details: List[annofabapi.dataclass.annotation.AnnotationDetail], updated_datetime: Optional[str])[source]
details: List[annofabapi.dataclass.annotation.AnnotationDetail]

矩形、ポリゴン、全体アノテーションなど個々のアノテーションの配列。

input_data_id: str

入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID)

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

task_id: str

タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID)

updated_datetime: Optional[str]

更新日時

class annofabapi.dataclass.annotation.AnnotationDetail(annotation_id: str, account_id: str, label_id: str, is_protected: bool, data_holding_type: annofabapi.models.AnnotationDataHoldingType, data: Optional[Union[str, Dict[str, Any]]], path: Optional[str], etag: Optional[str], url: Optional[str], additional_data_list: List[annofabapi.dataclass.annotation.AdditionalData], created_datetime: Optional[str], updated_datetime: Optional[str])[source]
account_id: str

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

additional_data_list: List[annofabapi.dataclass.annotation.AdditionalData]

属性情報。 アノテーション属性の種類(additional_data_definition`の`type)によって、属性値を格納するプロパティは変わります。 | 属性の種類 | additional_data_definition`の`type | 属性値を格納するプロパティ | |------------|————————-|----------------------| | ON/OFF | flag | flag | | 整数 | integer | integer | | 自由記述(1行)| text | comment | | 自由記述(複数行)| comment | comment | | トラッキングID | tracking | comment | | アノテーションリンク | link | comment | | 排他選択(ラジオボタン) |choice | choice | | 排他選択(ドロップダウン) | select | choice |

annotation_id: str

アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID) `annotation_type`が`classification`の場合は label_id と同じ値が格納されます。

created_datetime: Optional[str]

作成日時

data: Optional[Union[str, Dict[str, Any]]]
data_holding_type: annofabapi.models.AnnotationDataHoldingType
etag: Optional[str]

外部ファイルに保存されたアノテーションのETag。`data_holding_type`が`inner`の場合、または[putAnnotation](#operation/putAnnotation) APIのリクエストボディに渡す場合は未指定です。

is_protected: bool

`true`の場合、アノテーションをアノテーションエディタ上での削除から保護できます。 外部から取り込んだアノテーションに属性を追加するときなどに指定すると、データの削除を防げます。

label_id: str

ラベルID。[値の制約についてはこちら。](#section/API-Convention/APIID)

path: Optional[str]

外部ファイルに保存されたアノテーションのパス。`data_holding_type`が`inner`の場合は未指定です。 レスポンスの場合は`annotation_id`と同じ値が格納されます。 [putAnnotation](#operation/putAnnotation) APIのリクエストボディに渡す場合は、[createTempPath](#operation/createTempPath) APIで取得できる一時データ保存先S3パスを格納してください。 更新しない場合は、[getEditorAnnotation](#operation/getEditorAnnotation) APIで取得した`path`をそのまま渡せます。 外部ファイルのフォーマットは下表の通りです。 <table> <tr><th>annotation_type</th><th>形式</th></tr> <tr><td>segmentation / segmentation_v2 </td><td>PNG画像。塗りつぶした部分は<code>rgba(255, 255, 255, 1) </code>、塗りつぶしていない部分は<code>rgba(0, 0, 0, 0) </code>。</td></tr> </table>

updated_datetime: Optional[str]

更新日時

url: Optional[str]

外部ファイルに保存されたアノテーションの認証済み一時URL。`data_holding_type`が`inner`の場合、または[putAnnotation](#operation/putAnnotation) APIのリクエストボディに渡す場合は未指定です。

class annofabapi.dataclass.annotation.FullAnnotation(project_id: str, task_id: str, task_phase: annofabapi.models.TaskPhase, task_phase_stage: int, task_status: annofabapi.models.TaskStatus, input_data_id: str, input_data_name: str, details: List[annofabapi.dataclass.annotation.FullAnnotationDetail], updated_datetime: Optional[str], annotation_format_version: str)[source]
annotation_format_version: str

//semver.org/)にもとづきます。 JSONに出力されるアノテーションフォーマットのバージョンは、アノテーションZIPが作成される時点のものが使われます。 すなわち、1.0.0`の時点のタスクで作成したアノテーションであっても、フォーマットが `1.0.1 に上がった次のZIP作成時では 1.0.1 となります。 バージョンを固定してZIPを残しておきたい場合は、プロジェクトが完了した時点でZIPをダウンロードして保管しておくか、またはプロジェクトを「停止中」にします。

Type

アノテーションフォーマットのバージョンです。 アノテーションフォーマットとは、プロジェクト個別のアノテーション仕様ではなく、Annofabのアノテーション構造のことです。 したがって、アノテーション仕様を更新しても、このバージョンは変化しません。 バージョンの読み方と更新ルールは、業界慣習の[Semantic Versioning](https

details: List[annofabapi.dataclass.annotation.FullAnnotationDetail]

矩形、ポリゴン、全体アノテーションなど個々のアノテーションの配列

input_data_id: str

入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID)

input_data_name: str

入力データ名

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

task_id: str

タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID)

task_phase: annofabapi.models.TaskPhase
task_phase_stage: int

タスクのフェーズのステージ番号

task_status: annofabapi.models.TaskStatus
updated_datetime: Optional[str]

更新日時。アノテーションが一つもない場合(教師付作業が未着手のときなど)は、未指定。

class annofabapi.dataclass.annotation.FullAnnotationAdditionalData(additional_data_definition_id: str, additional_data_definition_name: Dict[str, Any], type: annofabapi.models.AdditionalDataDefinitionType, value: Dict[str, Any])[source]

属性情報

additional_data_definition_id: str

属性ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

additional_data_definition_name: Dict[str, Any]
type: annofabapi.models.AdditionalDataDefinitionType
value: Dict[str, Any]
class annofabapi.dataclass.annotation.FullAnnotationDataBoundingBox(left_top: annofabapi.dataclass.annotation.Point, right_bottom: annofabapi.dataclass.annotation.Point, type: str)[source]
left_top: annofabapi.dataclass.annotation.Point
right_bottom: annofabapi.dataclass.annotation.Point
type: str

BoundingBox

class annofabapi.dataclass.annotation.FullAnnotationDataClassification(type: str)[source]
type: str

Classification

class annofabapi.dataclass.annotation.FullAnnotationDataPoints(points: List[annofabapi.dataclass.annotation.Point], type: str)[source]
points: List[annofabapi.dataclass.annotation.Point]

頂点の座標値

type: str

Points

class annofabapi.dataclass.annotation.FullAnnotationDataRange(begin: float, end: float, type: str)[source]
begin: float

開始時間(ミリ秒)

end: float

終了時間(ミリ秒)

type: str

Range

class annofabapi.dataclass.annotation.FullAnnotationDataSegmentation(data_uri: str, type: str)[source]
data_uri: str

塗りつぶし画像のパス。 塗りつぶし画像のファイル形式はPNGです。塗りつぶされた部分の色は`rgba(255, 255, 255, 1)`、塗りつぶされていない部分の色は`rgba(0, 0, 0, 0)`です。

type: str

Segmentation

class annofabapi.dataclass.annotation.FullAnnotationDataSegmentationV2(data_uri: str, type: str)[source]
data_uri: str

塗りつぶし画像のパス。 塗りつぶし画像のファイル形式はPNGです。塗りつぶされた部分の色は`rgba(255, 255, 255, 1)`、塗りつぶされていない部分の色は`rgba(0, 0, 0, 0)`です。

type: str

SegmentationV2

class annofabapi.dataclass.annotation.FullAnnotationDataSinglePoint(point: annofabapi.dataclass.annotation.Point, type: str)[source]
point: annofabapi.dataclass.annotation.Point
type: str

SinglePoint

class annofabapi.dataclass.annotation.FullAnnotationDetail(annotation_id: str, user_id: str, label_id: str, label_name: Dict[str, Any], annotation_type: str, data_holding_type: annofabapi.models.AnnotationDataHoldingType, data: Any, additional_data_list: List[annofabapi.dataclass.annotation.FullAnnotationAdditionalData])[source]
additional_data_list: List[annofabapi.dataclass.annotation.FullAnnotationAdditionalData]

属性情報。

annotation_id: str

アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID) `annotation_type`が`classification`の場合は label_id と同じ値が格納されます。

annotation_type: str
data: Any
data_holding_type: annofabapi.models.AnnotationDataHoldingType
label_id: str

ラベルID。[値の制約についてはこちら。](#section/API-Convention/APIID)

label_name: Dict[str, Any]
user_id: str

ユーザーID。[値の制約についてはこちら。](#section/API-Convention/APIID)

class annofabapi.dataclass.annotation.Point(x: int, y: int)[source]

点の座標値

x: int

X座標の値[ピクセル]

y: int

Y座標の値[ピクセル]

class annofabapi.dataclass.annotation.SimpleAnnotation(annotation_format_version: str, project_id: str, task_id: str, task_phase: annofabapi.models.TaskPhase, task_phase_stage: int, task_status: annofabapi.models.TaskStatus, input_data_id: str, input_data_name: str, details: List[annofabapi.dataclass.annotation.SimpleAnnotationDetail], updated_datetime: Optional[str])[source]
annotation_format_version: str

//semver.org/)にもとづきます。 JSONに出力されるアノテーションフォーマットのバージョンは、アノテーションZIPが作成される時点のものが使われます。 すなわち、1.0.0`の時点のタスクで作成したアノテーションであっても、フォーマットが `1.0.1 に上がった次のZIP作成時では 1.0.1 となります。 バージョンを固定してZIPを残しておきたい場合は、プロジェクトが完了した時点でZIPをダウンロードして保管しておくか、またはプロジェクトを「停止中」にします。

Type

アノテーションフォーマットのバージョンです。 アノテーションフォーマットとは、プロジェクト個別のアノテーション仕様ではなく、Annofabのアノテーション構造のことです。 したがって、アノテーション仕様を更新しても、このバージョンは変化しません。 バージョンの読み方と更新ルールは、業界慣習の[Semantic Versioning](https

details: List[annofabapi.dataclass.annotation.SimpleAnnotationDetail]

矩形、ポリゴン、全体アノテーションなど個々のアノテーションの配列。

input_data_id: str

入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID)

input_data_name: str

入力データ名

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

task_id: str

タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID)

task_phase: annofabapi.models.TaskPhase
task_phase_stage: int

タスクのフェーズのステージ番号

task_status: annofabapi.models.TaskStatus
updated_datetime: Optional[str]

更新日時。アノテーションが一つもない場合(教師付作業が未着手のときなど)は、未指定。

class annofabapi.dataclass.annotation.SimpleAnnotationDetail(label: str, annotation_id: str, data: Any, attributes: Dict[str, Any])[source]
annotation_id: str

個々のアノテーションにつけられたIDです。

attributes: Dict[str, Any]

各属性の値 * 選択肢を定義している場合、その選択肢の表示名 (英語) * それ以外は属性値そのまま (文字列、数値、論理値)

Type

キーと値が以下のようになっている辞書構造です。 * キー

Type

アノテーション仕様で設定した属性名 (英語) * 値

data: Any
label: str

アノテーション仕様で設定したラベル名 (英語) です。

class annofabapi.dataclass.annotation.SingleAnnotation(project_id: str, task_id: str, input_data_id: str, detail: annofabapi.dataclass.annotation.SingleAnnotationDetail, updated_datetime: str)[source]
detail: annofabapi.dataclass.annotation.SingleAnnotationDetail
input_data_id: str

入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID)

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

task_id: str

タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID)

updated_datetime: str

更新日時

class annofabapi.dataclass.annotation.SingleAnnotationDetail(annotation_id: str, account_id: str, label_id: str, data_holding_type: annofabapi.models.AnnotationDataHoldingType, data: Optional[Any], etag: Optional[str], url: Optional[str], additional_data_list: List[annofabapi.dataclass.annotation.AdditionalData], created_datetime: str, updated_datetime: str)[source]

アノテーション情報

account_id: str

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

additional_data_list: List[annofabapi.dataclass.annotation.AdditionalData]

属性情報。 アノテーション属性の種類(additional_data_definition`の`type)によって、属性値を格納するプロパティは変わります。 | 属性の種類 | additional_data_definition`の`type | 属性値を格納するプロパティ | |------------|————————-|----------------------| | ON/OFF | flag | flag | | 整数 | integer | integer | | 自由記述(1行)| text | comment | | 自由記述(複数行)| comment | comment | | トラッキングID | tracking | comment | | アノテーションリンク | link | comment | | 排他選択(ラジオボタン) |choice | choice | | 排他選択(ドロップダウン) | select | choice |

annotation_id: str

アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID) `annotation_type`が`classification`の場合は label_id と同じ値が格納されます。

created_datetime: str

作成日時

data: Optional[Any]
data_holding_type: annofabapi.models.AnnotationDataHoldingType
etag: Optional[str]

data_holding_typeがouterの場合のみ存在し、データのETagが格納される

label_id: str

ラベルID。[値の制約についてはこちら。](#section/API-Convention/APIID)

updated_datetime: str

更新日時

url: Optional[str]

data_holding_typeがouterの場合のみ存在し、データへの一時URLが格納される

annofabapi.dataclass.annotation_specs module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV1(additional_data_definition_id: str, read_only: Optional[bool], name: Optional[annofabapi.dataclass.annotation_specs.InternationalizationMessage], default: Optional[Union[bool, int, str]], keybind: Optional[List[annofabapi.dataclass.annotation_specs.Keybind]], type: annofabapi.models.AdditionalDataDefinitionType, choices: Optional[List[annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV1Choices]], regex: Optional[str], label_ids: Optional[List[str]], required: Optional[bool], metadata: Optional[Dict[str, str]])[source]
additional_data_definition_id: str

属性ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

choices: Optional[List[annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV1Choices]]

ドロップダウンまたはラジオボタンの選択肢

default: Optional[Union[bool, int, str]]
keybind: Optional[List[annofabapi.dataclass.annotation_specs.Keybind]]

ショートカットキー

label_ids: Optional[List[str]]

リンク属性において、リンク先として指定可能なラベルID(空の場合制限なし)

metadata: Optional[Dict[str, str]]

ユーザーが自由に登録できるkey-value型のメタデータです。

name: Optional[annofabapi.dataclass.annotation_specs.InternationalizationMessage]
read_only: Optional[bool]

読み込み専用

regex: Optional[str]

属性の値が、指定した正規表現に一致している必要があります。

required: Optional[bool]

リンク属性において、入力を必須とするかどうか

type: annofabapi.models.AdditionalDataDefinitionType
class annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV1Choices(choice_id: str, name: annofabapi.dataclass.annotation_specs.InternationalizationMessage, keybind: Optional[List[annofabapi.dataclass.annotation_specs.Keybind]])[source]
choice_id: str

選択肢ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

keybind: Optional[List[annofabapi.dataclass.annotation_specs.Keybind]]

ショートカットキー

name: annofabapi.dataclass.annotation_specs.InternationalizationMessage
class annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV2(additional_data_definition_id: str, read_only: Optional[bool], name: annofabapi.dataclass.annotation_specs.InternationalizationMessage, default: Optional[Union[bool, int, str]], keybind: Optional[List[annofabapi.dataclass.annotation_specs.Keybind]], type: annofabapi.models.AdditionalDataDefinitionType, choices: Optional[List[annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV1Choices]], metadata: Optional[Dict[str, str]])[source]
additional_data_definition_id: str

属性ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

choices: Optional[List[annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV1Choices]]

ドロップダウンまたはラジオボタンの選択肢

default: Optional[Union[bool, int, str]]
keybind: Optional[List[annofabapi.dataclass.annotation_specs.Keybind]]

ショートカットキー

metadata: Optional[Dict[str, str]]

ユーザーが自由に登録できるkey-value型のメタデータです。

name: annofabapi.dataclass.annotation_specs.InternationalizationMessage
read_only: Optional[bool]

読み込み専用

type: annofabapi.models.AdditionalDataDefinitionType
class annofabapi.dataclass.annotation_specs.AdditionalDataRestriction(additional_data_definition_id: str, condition: Dict[str, Any])[source]
additional_data_definition_id: str

属性ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

condition: Dict[str, Any]
class annofabapi.dataclass.annotation_specs.AnnotationEditorFeature(append: bool, erase: bool, freehand: bool, rectangle_fill: bool, polygon_fill: bool, fill_near: bool)[source]

塗りつぶしの作図機能に関する情報

append: bool

塗りつぶしの「追記」機能が使えるか否か

erase: bool

塗りつぶしの「消しゴム」機能が使えるか否か

fill_near: bool

「近似色塗りつぶし」機能を有効にするかどうか

freehand: bool

塗りつぶしの「フリーハンド」機能が使えるか否か

polygon_fill: bool

塗りつぶしの「ポリゴン」機能が使えるか否か

rectangle_fill: bool

塗りつぶしの「矩形」機能が使えるか否か

class annofabapi.dataclass.annotation_specs.AnnotationSpecsHistory(history_id: str, project_id: str, updated_datetime: str, url: str, account_id: Optional[str], comment: Optional[str])[source]
account_id: Optional[str]

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

comment: Optional[str]

変更内容のコメント

history_id: str

アノテーション仕様の履歴ID

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

updated_datetime: str

更新日時

url: str

アノテーション仕様が格納されたJSONのURL。URLにアクセスするには認証認可が必要です。

class annofabapi.dataclass.annotation_specs.AnnotationSpecsV1(project_id: str, labels: List[annofabapi.dataclass.annotation_specs.LabelV1], inspection_phrases: List[annofabapi.dataclass.annotation_specs.InspectionPhrase], updated_datetime: Optional[str], option: Optional[Dict[str, Any]], metadata: Dict[str, str])[source]
inspection_phrases: List[annofabapi.dataclass.annotation_specs.InspectionPhrase]

定型指摘

labels: List[annofabapi.dataclass.annotation_specs.LabelV1]

ラベル

metadata: Dict[str, str]

ユーザーが自由に登録できるkey-value型のメタデータです。

option: Optional[Dict[str, Any]]
project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

updated_datetime: Optional[str]

更新日時

class annofabapi.dataclass.annotation_specs.AnnotationSpecsV2(project_id: str, labels: List[annofabapi.dataclass.annotation_specs.LabelV2], additionals: List[annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV2], restrictions: List[annofabapi.dataclass.annotation_specs.AdditionalDataRestriction], inspection_phrases: List[annofabapi.dataclass.annotation_specs.InspectionPhrase], format_version: str, updated_datetime: Optional[str], option: Optional[Dict[str, Any]], metadata: Dict[str, str])[source]
additionals: List[annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV2]

属性

format_version: str

アノテーション仕様のフォーマットのバージョン

inspection_phrases: List[annofabapi.dataclass.annotation_specs.InspectionPhrase]

定型指摘

labels: List[annofabapi.dataclass.annotation_specs.LabelV2]

ラベル

metadata: Dict[str, str]

ユーザーが自由に登録できるkey-value型のメタデータです。

option: Optional[Dict[str, Any]]
project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

restrictions: List[annofabapi.dataclass.annotation_specs.AdditionalDataRestriction]

属性の制約

updated_datetime: Optional[str]

更新日時

class annofabapi.dataclass.annotation_specs.BoundingBoxMetadata(min_width: int, min_height: int, min_warn_rule: str, min_area: Optional[int], max_vertices: Optional[int], min_vertices: Optional[int], position_for_minimum_bounding_box_insertion: Optional[annofabapi.dataclass.annotation_specs.PositionForMinimumBoundingBoxInsertion], tolerance: Optional[int], has_direction: Optional[bool])[source]

ベクター形式のアノテーション(矩形、ポリゴン、ポリライン、点)のメタデータ

has_direction: Optional[bool]

annotation_typepolyline の場合、アノテーションに向きを持たせるかどうかを指定できます。 この値が true の場合、Annofabの標準画像エディタ上ではポリラインの向きを示す矢印が描画されるようになります。 annotationTypepolyline 以外の場合は必ず false となります。

max_vertices: Optional[int]

頂点数の最大値

min_area: Optional[int]

面積の最小値[平方ピクセル]

min_height: int

高さの最小値[ピクセル]

min_vertices: Optional[int]

頂点数の最小値

min_warn_rule: str

サイズの制約に関する情報 * none - 制約なし * or - 幅と高さの両方が最小値以上 * and - 幅と高さのどちらか一方が最小値以上

min_width: int

幅の最小値[ピクセル]

position_for_minimum_bounding_box_insertion: Optional[annofabapi.dataclass.annotation_specs.PositionForMinimumBoundingBoxInsertion]
tolerance: Optional[int]

許容誤差[ピクセル]

class annofabapi.dataclass.annotation_specs.Color(red: int, green: int, blue: int)[source]

RGBで表現される色情報

blue: int
green: int
red: int
class annofabapi.dataclass.annotation_specs.InspectionPhrase(id: str, text: annofabapi.dataclass.annotation_specs.InternationalizationMessage)[source]
id: str

定型指摘ID

text: annofabapi.dataclass.annotation_specs.InternationalizationMessage
class annofabapi.dataclass.annotation_specs.InternationalizationMessage(messages: List[annofabapi.dataclass.annotation_specs.InternationalizationMessageMessages], default_lang: str)[source]
default_lang: str

希望された言語のメッセージが存在しない場合に、フォールバック先として使われる言語コード

messages: List[annofabapi.dataclass.annotation_specs.InternationalizationMessageMessages]

言語コードとメッセージ(テキスト)のリスト。 * アノテーションエディタなどでは、Annofabの表示言語(各ユーザーが個人設定で選んだ言語)のメッセージが使われます * 以下の名前は、[Simple Annotation](#section/Simple-Annotation-ZIP) では en-US のメッセージが使われます * ラベル名 * 属性名 * 選択肢名 * いずれの場合でも、表示しようとした言語が messages に含まれない場合、 default_lang に指定した言語のメッセージが使われます

class annofabapi.dataclass.annotation_specs.InternationalizationMessageMessages(lang: str, message: str)[source]
lang: str

言語コード。en-US (英語) または ja-JP (日本語) のみサポートしています。

message: str

lang で指定された言語でのメッセージ

class annofabapi.dataclass.annotation_specs.Keybind(code: str, shift: bool, ctrl: bool, alt: bool)[source]
alt: bool

Altキーを押しているかどうか

code: str

//developer.mozilla.org/ja/docs/Web/API/KeyboardEvent/code)に相当する値です。

Type

[KeyboardEvent.code](https

ctrl: bool

Ctrlキーを押しているかどうか

shift: bool

Shiftキーを押しているかどうか

class annofabapi.dataclass.annotation_specs.LabelV1(label_id: str, label_name: annofabapi.dataclass.annotation_specs.InternationalizationMessage, keybind: List[annofabapi.dataclass.annotation_specs.Keybind], annotation_type: str, bounding_box_metadata: Optional[annofabapi.dataclass.annotation_specs.BoundingBoxMetadata], segmentation_metadata: Optional[annofabapi.dataclass.annotation_specs.SegmentationMetadata], additional_data_definitions: List[annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV1], color: annofabapi.dataclass.annotation_specs.Color, annotation_editor_feature: annofabapi.dataclass.annotation_specs.AnnotationEditorFeature, allow_out_of_image_bounds: Optional[bool], metadata: Optional[Dict[str, str]])[source]
additional_data_definitions: List[annofabapi.dataclass.annotation_specs.AdditionalDataDefinitionV1]

属性

allow_out_of_image_bounds: Optional[bool]

枠内制御がなくなったため値の設定は出来ません。値の取得では、必ず`true`が入ります。[廃止](/docs/releases/deprecation-announcements.html#notice25)までは互換性のため残されています。

annotation_editor_feature: annofabapi.dataclass.annotation_specs.AnnotationEditorFeature
annotation_type: str
bounding_box_metadata: Optional[annofabapi.dataclass.annotation_specs.BoundingBoxMetadata]
color: annofabapi.dataclass.annotation_specs.Color
keybind: List[annofabapi.dataclass.annotation_specs.Keybind]

ショートカットキー

label_id: str

ラベルID。[値の制約についてはこちら。](#section/API-Convention/APIID)

label_name: annofabapi.dataclass.annotation_specs.InternationalizationMessage
metadata: Optional[Dict[str, str]]

ユーザーが自由に登録できるkey-value型のメタデータです。

segmentation_metadata: Optional[annofabapi.dataclass.annotation_specs.SegmentationMetadata]
class annofabapi.dataclass.annotation_specs.LabelV2(label_id: str, label_name: annofabapi.dataclass.annotation_specs.InternationalizationMessage, keybind: List[annofabapi.dataclass.annotation_specs.Keybind], annotation_type: str, bounding_box_metadata: Optional[annofabapi.dataclass.annotation_specs.BoundingBoxMetadata], segmentation_metadata: Optional[annofabapi.dataclass.annotation_specs.SegmentationMetadata], additional_data_definitions: List[str], color: annofabapi.dataclass.annotation_specs.Color, annotation_editor_feature: annofabapi.dataclass.annotation_specs.AnnotationEditorFeature, allow_out_of_image_bounds: Optional[bool], metadata: Optional[Dict[str, str]])[source]
additional_data_definitions: List[str]

ラベルに所属する属性のID

allow_out_of_image_bounds: Optional[bool]

枠内制御がなくなったため値の設定は出来ません。値の取得では、必ず`true`が入ります。[廃止](/docs/releases/deprecation-announcements.html#notice25)までは互換性のため残されています。

annotation_editor_feature: annofabapi.dataclass.annotation_specs.AnnotationEditorFeature
annotation_type: str
bounding_box_metadata: Optional[annofabapi.dataclass.annotation_specs.BoundingBoxMetadata]
color: annofabapi.dataclass.annotation_specs.Color
keybind: List[annofabapi.dataclass.annotation_specs.Keybind]

ショートカットキー

label_id: str

ラベルID。[値の制約についてはこちら。](#section/API-Convention/APIID)

label_name: annofabapi.dataclass.annotation_specs.InternationalizationMessage
metadata: Optional[Dict[str, str]]

ユーザーが自由に登録できるkey-value型のメタデータです。

segmentation_metadata: Optional[annofabapi.dataclass.annotation_specs.SegmentationMetadata]
class annofabapi.dataclass.annotation_specs.PositionForMinimumBoundingBoxInsertion(x: int, y: int)[source]

annotation_typebounding_box かつ min_warn_ruleand または or の場合のみ、挿入する最小矩形アノテーションの原点を指定できます。 画像左上の座標が「x=0, y=0」です。 未指定、もしくは「画像外に飛び出たアノテーション」を許可していないにも関わらず飛び出してしまう場合は、表示範囲の中央に挿入されます。 「スキャンした帳票の記入欄」や「定点カメラで撮影した製品ラベル」など、アノテーションしたい位置やサイズが多くの画像で共通している場合に便利です。 annotation_typebounding_box 以外の場合は必ず未指定となります。

x: int
y: int
class annofabapi.dataclass.annotation_specs.SegmentationMetadata(min_width: int, min_height: int, min_warn_rule: str, tolerance: Optional[int])[source]

塗りつぶしアノテーションのメタデータ

min_height: int

高さの最小値[ピクセル]

min_warn_rule: str

サイズの制約に関する情報 * none - 制約なし * or - 幅と高さの両方が最小値以上 * and - 幅と高さのどちらか一方が最小値以上

min_width: int

幅の最小値[ピクセル]

tolerance: Optional[int]

許容誤差[ピクセル]

annofabapi.dataclass.input module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.input.InputData(input_data_id: str, project_id: str, organization_id: str, input_data_set_id: str, input_data_name: str, input_data_path: str, url: Optional[str], etag: Optional[str], original_input_data_path: Optional[str], updated_datetime: str, sign_required: bool, metadata: Dict[str, str], system_metadata: Dict[str, Any])[source]

入力データの情報を表すデータ構造です。

etag: Optional[str]

//developer.mozilla.org/ja/docs/Web/HTTP/Headers/ETag)に相当する値です。

Type

[HTTPレスポンスヘッダー ETag](https

input_data_id: str

入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID)

input_data_name: str

入力データ名

input_data_path: str

入力データの実体が保存されたパスです。 s3スキーマまたはhttpsスキーマのみサポートしています。

input_data_set_id: str

入力データセットID。[値の制約についてはこちら。](#section/API-Convention/APIID)

metadata: Dict[str, str]

ユーザーが自由に登録できるkey-value型のメタデータです。

organization_id: str

組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

original_input_data_path: Optional[str]

システム内部用のプロパティ

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

sign_required: bool

CloudFrontのSignedCookieを使ったプライベートストレージを利用するかどうか

system_metadata: Dict[str, Any]
updated_datetime: str

更新日時

url: Optional[str]

システム内部用のプロパティ

class annofabapi.dataclass.input.Resolution(width: int, height: int)[source]
height: int

画像の高さ[ピクセル]

width: int

画像の幅[ピクセル]

annofabapi.dataclass.inspection module

annofabapiのmodelをDataClassで定義したクラス

Note

Inspection Commmentに関するWebAPIは 2022-08-23以降に廃止される予定です。 廃止予定日などの情報をdecoratorで設定するため、このファイルは自動生成ではなく手動で生成しています。

class annofabapi.dataclass.inspection.Inspection(project_id: str, task_id: str, input_data_id: str, inspection_id: str, phase: annofabapi.models.TaskPhase, phase_stage: int, commenter_account_id: str, annotation_id: Optional[str], label_id: Optional[str], data: Dict[str, Any], parent_inspection_id: Optional[str], phrases: Optional[List[str]], comment: str, status: annofabapi.models.InspectionStatus, created_datetime: str, updated_datetime: Optional[str])[source]

検査コメント

Deprecated since version 2022-08-23以降に廃止する予定です。.

annotation_id: Optional[str]

アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。

comment: str

検査コメントの中身

commenter_account_id: str
created_datetime: str
data: Dict[str, Any]
input_data_id: str

入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID)

inspection_id: str

検査ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

label_id: Optional[str]
parent_inspection_id: Optional[str]

検査ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

phase: annofabapi.models.TaskPhase
phase_stage: int

検査コメントを付与したときのフェーズのステージ

phrases: Optional[List[str]]

参照している定型指摘のID。

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

status: annofabapi.models.InspectionStatus
task_id: str

タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID)

updated_datetime: Optional[str]

annofabapi.dataclass.instruction module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.instruction.Instruction(html: str, last_updated_datetime: str)[source]
html: str

作業ガイドのHTML

last_updated_datetime: str

更新日時

class annofabapi.dataclass.instruction.InstructionHistory(history_id: str, account_id: str, updated_datetime: str)[source]
account_id: str

作業ガイドを更新したユーザーのアカウントID

history_id: str

作業ガイドの履歴ID

updated_datetime: str

作業ガイドの最終更新日時

class annofabapi.dataclass.instruction.InstructionImage(image_id: str, path: str, url: str, etag: str)[source]
etag: str

//developer.mozilla.org/ja/docs/Web/HTTP/Headers/ETag)に相当する値です。

Type

[HTTPレスポンスヘッダー ETag](https

image_id: str

作業ガイド画像ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

path: str

作業ガイド画像の実体が保存されたパスです。

url: str

作業ガイド画像を取得するためのシステム内部用のURLです。

annofabapi.dataclass.job module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.job.ProjectJobInfo(project_id: str, job_type: annofabapi.models.ProjectJobType, job_id: str, job_status: annofabapi.models.JobStatus, job_execution: Optional[Dict[str, Any]], job_detail: Optional[Dict[str, Any]], errors: Dict[str, Any], created_datetime: str, updated_datetime: str)[source]
created_datetime: str

作成日時

errors: Dict[str, Any]
job_detail: Optional[Dict[str, Any]]

ジョブ結果の内部情報

job_execution: Optional[Dict[str, Any]]

ジョブの内部情報

job_id: str

ジョブID。[値の制約についてはこちら。](#section/API-Convention/APIID)

job_status: annofabapi.models.JobStatus
job_type: annofabapi.models.ProjectJobType
project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

updated_datetime: str

更新日時

annofabapi.dataclass.my module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.my.MyAccount(account_id: str, user_id: str, username: str, email: str, lang: annofabapi.models.Lang, biography: Optional[str], keylayout: annofabapi.models.KeyLayout, authority: str, is_external_account: bool, updated_datetime: str, reset_requested_email: Optional[str], errors: List[str])[source]
account_id: str

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

authority: str

システム内部用のプロパティ

biography: Optional[str]

人物紹介、略歴。 この属性は、Annofab外の所属先や肩書などを表すために用います。 Annofab上の「複数の組織」で活動する場合、本籍を示すのに便利です。

email: str

メールアドレス

errors: List[str]

システム内部用のプロパティ

is_external_account: bool

[外部アカウントだけで作成したアカウント](/docs/faq/#v1u344)の場合はtrue。 外部アカウント連携していないAnnofabアカウントや、後から[外部アカウントとの紐付け](/docs/faq/#yyyub0)をしたAnnofabアカウントの場合はfalse。

keylayout: annofabapi.models.KeyLayout
lang: annofabapi.models.Lang
reset_requested_email: Optional[str]

システム内部用のプロパティ

updated_datetime: str

更新日時

user_id: str

ユーザーID。[値の制約についてはこちら。](#section/API-Convention/APIID)

username: str

ユーザー名

class annofabapi.dataclass.my.MyOrganization(organization_id: Optional[str], name: Optional[str], email: Optional[str], price_plan: Optional[annofabapi.models.PricePlan], summary: Optional[Dict[str, Any]], created_datetime: Optional[str], updated_datetime: Optional[str], my_role: Optional[annofabapi.models.OrganizationMemberRole], my_status: Optional[annofabapi.models.OrganizationMemberStatus])[source]
created_datetime: Optional[str]

作成日時

email: Optional[str]
my_role: Optional[annofabapi.models.OrganizationMemberRole]
my_status: Optional[annofabapi.models.OrganizationMemberStatus]
name: Optional[str]
organization_id: Optional[str]

組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

price_plan: Optional[annofabapi.models.PricePlan]
summary: Optional[Dict[str, Any]]

廃止予定のプロパティです。常に中身は空です。

updated_datetime: Optional[str]

更新日時

annofabapi.dataclass.organization module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.organization.Organization(organization_id: str, organization_name: str, email: str, price_plan: annofabapi.models.PricePlan, summary: Dict[str, Any], created_datetime: str, updated_datetime: str)[source]
created_datetime: str

作成日時

email: str

メールアドレス

organization_id: str

組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

organization_name: str

組織名。[値の制約についてはこちら。](#section/API-Convention/APIID)

price_plan: annofabapi.models.PricePlan
summary: Dict[str, Any]

廃止予定のプロパティです。常に中身は空です。

updated_datetime: str

更新日時

class annofabapi.dataclass.organization.OrganizationActivity(organization_id: str, created_datetime: str, storage_usage_bytes: int)[source]
created_datetime: str

作成日時

organization_id: str

組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

storage_usage_bytes: int

Annofabストレージの使用量[バイト]

annofabapi.dataclass.organization_member module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.organization_member.OrganizationMember(organization_id: str, account_id: str, user_id: str, username: str, role: annofabapi.models.OrganizationMemberRole, status: annofabapi.models.OrganizationMemberStatus, biography: Optional[str], created_datetime: str, updated_datetime: str)[source]
account_id: str

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

biography: Optional[str]

人物紹介、略歴。 この属性は、Annofab外の所属先や肩書などを表すために用います。 Annofab上の「複数の組織」で活動する場合、本籍を示すのに便利です。

created_datetime: str

作成日時

organization_id: str

組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

role: annofabapi.models.OrganizationMemberRole
status: annofabapi.models.OrganizationMemberStatus
updated_datetime: str

更新日時

user_id: str

ユーザーID。[値の制約についてはこちら。](#section/API-Convention/APIID)

username: str

ユーザー名

annofabapi.dataclass.project module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.project.Project(project_id: str, organization_id: str, title: str, overview: Optional[str], project_status: annofabapi.models.ProjectStatus, input_data_type: annofabapi.models.InputDataType, configuration: annofabapi.dataclass.project.ProjectConfiguration, created_datetime: str, updated_datetime: str, summary: annofabapi.dataclass.project.ProjectSummary)[source]
configuration: annofabapi.dataclass.project.ProjectConfiguration
created_datetime: str

作成日時

input_data_type: annofabapi.models.InputDataType
organization_id: str

組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

overview: Optional[str]

プロジェクトの概要

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

project_status: annofabapi.models.ProjectStatus
summary: annofabapi.dataclass.project.ProjectSummary
title: str

プロジェクトのタイトル

updated_datetime: str

更新日時

class annofabapi.dataclass.project.ProjectConfiguration(number_of_inspections: Optional[int], assignee_rule_of_resubmitted_task: Optional[annofabapi.models.AssigneeRuleOfResubmittedTask], task_assignment_type: Optional[annofabapi.models.TaskAssignmentType], task_assignment_property: Optional[Dict[str, Any]], max_tasks_per_member: Optional[int], max_tasks_per_member_including_hold: Optional[int], input_data_set_id_list: Optional[List[str]], input_data_max_long_side_length: Optional[int], sampling_inspection_rate: Optional[int], sampling_acceptance_rate: Optional[int], private_storage_aws_iam_role_arn: Optional[str], plugin_id: Optional[str], custom_task_assignment_plugin_id: Optional[str], custom_specs_plugin_id: Optional[str], editor_version: Optional[str], use_beginner_navigation: Optional[bool])[source]

プロジェクトの設定情報

assignee_rule_of_resubmitted_task: Optional[annofabapi.models.AssigneeRuleOfResubmittedTask]
custom_specs_plugin_id: Optional[str]

プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID)

custom_task_assignment_plugin_id: Optional[str]

プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID)

editor_version: Optional[str]

標準アノテーションエディタのバージョン。 * stable * 安定版。通常はこちらを利用してください。 * preview * 最新版。新機能やUI変更の先行リリース版。 プロジェクト更新時に未指定の場合は stable が指定されたものとみなします。

input_data_max_long_side_length: Optional[int]

入力データ画像の長辺の最大値(未指定時は4096px)。 画像をアップロードすると、長辺がこの値になるように画像が自動で圧縮されます。 アノテーションの座標は、もとの解像度の画像でつけたものに復元されます。 大きな数値を設定すると入力データ画像のサイズが大きくなり、生産性低下やブラウザで画像を表示できない懸念があります。注意して設定してください。

input_data_set_id_list: Optional[List[str]]

システム内部用のプロパティ。 [putProject](#operation/putProject) APIでプロジェクトを更新する際は、[getProject](#operation/getProject) APIで取得した値を指定してください。

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になります。

number_of_inspections: Optional[int]

検査回数。 * 0回:教師付け -> 受入 * 1回:教師付け -> 検査 -> 受入 * n回(n >= 2):教師付け -> 検査1 -> … -> 検査n -> 受入

plugin_id: Optional[str]

プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID)

private_storage_aws_iam_role_arn: Optional[str]

AWS IAMロール。ビジネスプランでのS3プライベートストレージの認可で使います。 [S3プライベートストレージの認可の設定についてはこちら](/docs/faq/#m0b240)をご覧ください。

sampling_acceptance_rate: Optional[int]

抜取受入率[%]。未指定の場合は100%として扱う。

sampling_inspection_rate: Optional[int]

抜取検査率[%]。未指定の場合は100%として扱う。

task_assignment_property: Optional[Dict[str, Any]]
task_assignment_type: Optional[annofabapi.models.TaskAssignmentType]
use_beginner_navigation: Optional[bool]

true の場合、プロジェクトの画面でナビゲーションUIを表示します(ログインユーザーがプロジェクトオーナーの場合のみ)。

class annofabapi.dataclass.project.ProjectSummary(last_tasks_updated_datetime: Optional[str])[source]

プロジェクトのサマリー情報

last_tasks_updated_datetime: Optional[str]

タスクの最終更新日時

annofabapi.dataclass.project_member module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.project_member.ProjectMember(project_id: str, account_id: str, user_id: str, username: str, member_status: annofabapi.models.ProjectMemberStatus, member_role: annofabapi.models.ProjectMemberRole, biography: Optional[str], updated_datetime: str, created_datetime: str, sampling_inspection_rate: Optional[int], sampling_acceptance_rate: Optional[int])[source]
account_id: str

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

biography: Optional[str]

人物紹介、略歴。 この属性は、Annofab外の所属先や肩書などを表すために用います。 Annofab上の「複数の組織」で活動する場合、本籍を示すのに便利です。

created_datetime: str

作成日時

member_role: annofabapi.models.ProjectMemberRole
member_status: annofabapi.models.ProjectMemberStatus
project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

sampling_acceptance_rate: Optional[int]

抜取受入率(パーセント)

sampling_inspection_rate: Optional[int]

抜取検査率(パーセント)

updated_datetime: str

更新日時

user_id: str

ユーザーID。[値の制約についてはこちら。](#section/API-Convention/APIID)

username: str

ユーザー名

annofabapi.dataclass.statistics module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.statistics.AccountWorktimeStatistics(account_id: str, by_tasks: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem], by_inputs: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem], by_minutes: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem])[source]
account_id: str

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

by_inputs: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem]

画像1枚あたりの作業時間情報(動画プロジェクトの場合は空リスト)

by_minutes: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem]

動画1分あたりの作業時間情報(画像プロジェクトの場合は空リスト)

by_tasks: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem]

タスクごとに計算した「画像1枚あたりの作業時間平均」の統計(動画プロジェクトの場合は空リスト)

class annofabapi.dataclass.statistics.HistogramItem(begin: float, end: float, count: int)[source]
begin: float
count: int
end: float
class annofabapi.dataclass.statistics.InspectionStatistics(project_id: str, date: str, breakdown: annofabapi.dataclass.statistics.InspectionStatisticsBreakdown)[source]
breakdown: annofabapi.dataclass.statistics.InspectionStatisticsBreakdown
date: str

集計日

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

class annofabapi.dataclass.statistics.InspectionStatisticsBreakdown(labels: Dict[str, annofabapi.dataclass.statistics.InspectionStatisticsPhrases], no_label: annofabapi.dataclass.statistics.InspectionStatisticsPhrases)[source]

検査コメント数の集計結果

labels: Dict[str, annofabapi.dataclass.statistics.InspectionStatisticsPhrases]

ラベルに紐付いている検査コメントの集計結果。キーは`label_id`です。

no_label: annofabapi.dataclass.statistics.InspectionStatisticsPhrases
class annofabapi.dataclass.statistics.InspectionStatisticsPhrases(phrases: Dict[str, int], no_phrase: int)[source]
no_phrase: int

定型指摘を使っていない検査コメントの個数

phrases: Dict[str, int]

定型指摘ごとの検査コメントの個数。キーは定型指摘ID、値は検査コメント数です。

class annofabapi.dataclass.statistics.LabelStatistics(label_id: str, completed: int, wip: int)[source]
completed: int

ラベルごとの受入が完了したアノテーション数

label_id: str

ラベルID。[値の制約についてはこちら。](#section/API-Convention/APIID)

wip: int

ラベルごとの受入が完了していないアノテーション数

class annofabapi.dataclass.statistics.Marker(marker_id: str, title: str, graph_type: annofabapi.models.GraphType, marked_at: str)[source]
graph_type: annofabapi.models.GraphType
marked_at: str

グラフ上のマーカー位置(x軸)

marker_id: str

マーカーID。[値の制約についてはこちら。](#section/API-Convention/APIID)

title: str

マーカーのタイトル

class annofabapi.dataclass.statistics.Markers(project_id: str, markers: List[annofabapi.dataclass.statistics.Marker], updated_datetime: Optional[str])[source]
markers: List[annofabapi.dataclass.statistics.Marker]

マーカー一覧

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

updated_datetime: Optional[str]

更新日時

class annofabapi.dataclass.statistics.PhaseStatistics(phase: annofabapi.models.TaskPhase, worktime: str)[source]
phase: annofabapi.models.TaskPhase
worktime: str

累積作業時間(ISO 8601 duration)

class annofabapi.dataclass.statistics.ProjectAccountStatistics(account_id: str, histories: List[annofabapi.dataclass.statistics.ProjectAccountStatisticsHistory])[source]
account_id: str

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

histories: List[annofabapi.dataclass.statistics.ProjectAccountStatisticsHistory]
class annofabapi.dataclass.statistics.ProjectAccountStatisticsHistory(date: str, tasks_completed: int, tasks_rejected: int, worktime: str)[source]
date: str
tasks_completed: int

1 * Chris: 2 <table> <tr> <th>担当者</th> <th>フェーズ</th> <th>作業内容</th> <th>完了日時</th> </tr> <tr> <td>Alice</td> <td>教師付</td> <td>提出する</td> <td>2020-04-01 09:00</td> </tr> <tr> <td>Chris</td> <td>受入</td> <td>差し戻す</td> <td>2020-04-01 10:00</td> </tr> <tr> <td>Bob</td> <td>教師付</td> <td>提出する</td> <td>2020-04-01 11:00</td> </tr> <tr> <td>Chris</td> <td>受入</td> <td>合格にする</td> <td>2020-04-01 12:00</td> </tr> </table>

Type

教師付フェーズのタスクを提出した回数、または検査/受入フェーズのタスクを合格/差戻にした回数。 たとえば、あるタスクのタスク履歴が下表の状態だった場合、2020-04-01の`tasks_completed`は以下の通りになります。 * Alice

Type

1 * Bob

tasks_rejected: int

1 * Chris: 1 <table> <tr> <th>担当者</th> <th>フェーズ</th> <th>作業内容</th> <th>完了日時</th> </tr> <tr> <td>Alice</td> <td>教師付</td> <td>提出する</td> <td>2020-04-01 09:00</td> </tr> <tr> <td>Chris</td> <td>受入</td> <td>差し戻す</td> <td>2020-04-01 10:00</td> </tr> <tr> <td>Bob</td> <td>教師付</td> <td>提出する</td> <td>2020-04-01 11:00</td> </tr> <tr> <td>Chris</td> <td>受入</td> <td>差し戻す</td> <td>2020-04-01 12:00</td> </tr> <tr> <td>Bob</td> <td>教師付</td> <td>提出する</td> <td>2020-04-01 13:00</td> </tr> <tr> <td>Chris</td> <td>受入</td> <td>合格にする</td> <td>2020-04-01 14:00</td> </tr> <tr> <td>Dave</td> <td>受入</td> <td>受入完了状態を取り消して、再度合格にする</td> <td>2020-04-01 15:00</td> </tr> </table>

Type

教師付フェーズを担当したタスクが差し戻された回数、または受入フェーズを担当したタスクが受入完了を取り消された回数。 たとえば、あるタスクのタスク履歴が下表の状態だった場合、2020-04-01の`tasks_rejected`は以下の通りになります。 * Alice

Type

1 * Bob

worktime: str

作業時間(ISO 8601 duration)

class annofabapi.dataclass.statistics.ProjectTaskStatistics(phase: annofabapi.models.TaskPhase, status: annofabapi.models.TaskStatus, count: int, work_timespan: int)[source]
count: int

タスク数

phase: annofabapi.models.TaskPhase
status: annofabapi.models.TaskStatus
work_timespan: int

累計実作業時間(ミリ秒)

class annofabapi.dataclass.statistics.ProjectTaskStatisticsHistory(date: str, tasks: List[annofabapi.dataclass.statistics.ProjectTaskStatistics])[source]
date: str

日付

tasks: List[annofabapi.dataclass.statistics.ProjectTaskStatistics]

タスクのフェーズごと、ステータスごとの情報

class annofabapi.dataclass.statistics.TaskPhaseStatistics(project_id: str, date: str, phases: List[annofabapi.dataclass.statistics.PhaseStatistics])[source]
date: str

日付

phases: List[annofabapi.dataclass.statistics.PhaseStatistics]

タスクのフェーズごとの集計結果

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

class annofabapi.dataclass.statistics.WorktimeStatistics(project_id: str, date: str, by_tasks: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem], by_inputs: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem], by_minutes: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem], accounts: List[annofabapi.dataclass.statistics.AccountWorktimeStatistics])[source]
accounts: List[annofabapi.dataclass.statistics.AccountWorktimeStatistics]

ユーザーごとの作業時間情報

by_inputs: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem]

画像1個当たりの作業時間情報(動画プロジェクトの場合は空リスト)

by_minutes: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem]

動画1分当たりの作業時間情報(画像プロジェクトの場合は空リスト)

by_tasks: List[annofabapi.dataclass.statistics.WorktimeStatisticsItem]

タスクごとに計算した「画像1枚あたりの作業時間平均」の統計(動画プロジェクトの場合は空リスト)

date: str
project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

class annofabapi.dataclass.statistics.WorktimeStatisticsItem(phase: annofabapi.models.TaskPhase, histogram: List[annofabapi.dataclass.statistics.HistogramItem], average: str, standard_deviation: str)[source]
average: str

作業時間の平均(ISO 8601 duration)

histogram: List[annofabapi.dataclass.statistics.HistogramItem]

ヒストグラム情報

phase: annofabapi.models.TaskPhase
standard_deviation: str

作業時間の標準偏差(ISO 8601 duration)

annofabapi.dataclass.supplementary module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.supplementary.SupplementaryData(organization_id: str, input_data_set_id: str, project_id: str, input_data_id: str, supplementary_data_id: str, supplementary_data_name: str, supplementary_data_path: str, url: str, etag: Optional[str], supplementary_data_type: annofabapi.models.SupplementaryDataType, supplementary_data_number: int, updated_datetime: str)[source]
etag: Optional[str]

//developer.mozilla.org/ja/docs/Web/HTTP/Headers/ETag)に相当する値です。

Type

[HTTPレスポンスヘッダー ETag](https

input_data_id: str

入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID)

input_data_set_id: str

入力データセットID。[値の制約についてはこちら。](#section/API-Convention/APIID)

organization_id: str

組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

supplementary_data_id: str

補助情報ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

supplementary_data_name: str

補助情報の名前

supplementary_data_number: int

補助情報の表示順を表す数値。

supplementary_data_path: str

補助情報の実体が存在するパスです。 s3スキーマまたはhttpsスキーマのみサポートしています。

supplementary_data_type: annofabapi.models.SupplementaryDataType
updated_datetime: str

更新日時

url: str

システム内部用のプロパティ

annofabapi.dataclass.task module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.task.Task(project_id: str, task_id: str, phase: annofabapi.models.TaskPhase, phase_stage: int, status: annofabapi.models.TaskStatus, input_data_id_list: List[str], account_id: Optional[str], histories_by_phase: List[annofabapi.dataclass.task.TaskHistoryShort], work_time_span: int, number_of_rejections: int, started_datetime: Optional[str], updated_datetime: str, operation_updated_datetime: str, sampling: Optional[str], metadata: Optional[Dict[str, Any]])[source]
account_id: Optional[str]

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

histories_by_phase: List[annofabapi.dataclass.task.TaskHistoryShort]

簡易的なタスク履歴(あるフェーズを誰が担当したか)

input_data_id_list: List[str]

タスクに含まれる入力データのID

metadata: Optional[Dict[str, Any]]

ユーザーが自由に登録できるkey-value型のメタデータです。 keyにはメタデータ名、valueには値を指定してください。 keyに指定できる文字種は次の通りです。 * 半角英数字 * _ (アンダースコア) * - (ハイフン) valueに指定できる値は次の通りです。 * 文字列 * 数値 * 真偽値

number_of_rejections: int

このタスクが差戻しされた回数(すべてのフェーズでの差戻し回数の合計 このフィールドは、どのフェーズで何回差戻されたかを区別できないため、廃止予定です。 histories_by_phase で各フェーズの回数を計算することで、差戻し回数が分かります。 例)`acceptance`フェーズが3回ある場合、`acceptance`フェーズで2回差し戻しされたことになります。

operation_updated_datetime: str

タスクのステータスやフェーズ、担当者などが更新されたときの日時

phase: annofabapi.models.TaskPhase
phase_stage: int

タスクのフェーズのステージ番号

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

sampling: Optional[str]

検査抜取検査/抜取受入によって、どのフェーズがスキップされたか * inspection_skipped - 抜取検査の対象外となり、検査フェーズがスキップされた * inspection_stages_skipped - 抜取検査の対象外となり、検査フェーズのステージの一部がスキップされた * acceptance_skipped - 抜取受入の対象外となり、受入フェーズがスキップされた * inspection_and_acceptance_skipped - 抜取検査・抜取受入の対象外となり、検査・受入フェーズがスキップされた 未指定ならば、どのフェーズもスキップされていません。

started_datetime: Optional[str]

現在のフェーズが開始された日時

status: annofabapi.models.TaskStatus
task_id: str

タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID)

updated_datetime: str

更新日時

work_time_span: int

累計実作業時間(ミリ秒)

class annofabapi.dataclass.task.TaskHistory(project_id: str, task_id: str, task_history_id: str, started_datetime: Optional[str], ended_datetime: Optional[str], accumulated_labor_time_milliseconds: str, phase: annofabapi.models.TaskPhase, phase_stage: int, account_id: Optional[str])[source]

タスクのあるフェーズで、誰がいつどれくらいの作業時間を費やしたかを表すタスク履歴です。

account_id: Optional[str]

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

accumulated_labor_time_milliseconds: str

累計実作業時間(ISO 8601 duration)

ended_datetime: Optional[str]

終了日時

phase: annofabapi.models.TaskPhase
phase_stage: int

タスクのフェーズのステージ番号

project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

started_datetime: Optional[str]

開始日時

task_history_id: str

タスク履歴ID。[値の制約についてはこちら。](#section/API-Convention/APIID)

task_id: str

タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID)

class annofabapi.dataclass.task.TaskHistoryShort(phase: annofabapi.models.TaskPhase, phase_stage: int, account_id: str, worked: Optional[bool])[source]

タスクのあるフェーズを誰が担当したかを表します。

account_id: str

アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID)

phase: annofabapi.models.TaskPhase
phase_stage: int
worked: Optional[bool]

そのフェーズでタスクの作業を行ったかどうか(行った場合はtrue)

annofabapi.dataclass.webhook module

annofabapiのmodelをDataClassで定義したクラス

Note

このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照. oneOf, allOfなどは正しく表現できない可能性がある。

class annofabapi.dataclass.webhook.Webhook(project_id: str, event_type: annofabapi.models.WebhookEventType, webhook_id: str, webhook_status: annofabapi.models.WebhookStatus, method: annofabapi.models.WebhookHttpMethod, headers: List[annofabapi.dataclass.webhook.WebhookHeader], body: Optional[str], url: str, created_datetime: str, updated_datetime: str)[source]
body: Optional[str]

Webhookが送信するHTTPリクエストのボディ

created_datetime: str

作成日時

event_type: annofabapi.models.WebhookEventType
headers: List[annofabapi.dataclass.webhook.WebhookHeader]

Webhookが送信するHTTPリクエストのヘッダー

method: annofabapi.models.WebhookHttpMethod
project_id: str

プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID)

updated_datetime: str

更新日時

url: str

Webhookの送信先URL

webhook_id: str

WebhookID。[値の制約についてはこちら。](#section/API-Convention/APIID)

webhook_status: annofabapi.models.WebhookStatus
class annofabapi.dataclass.webhook.WebhookHeader(name: str, value: str)[source]
name: str

HTTPヘッダーのフィールド名

value: str

HTTPヘッダーの値