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
choice: Optional[str]
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
additional_data_list: List[annofabapi.dataclass.annotation.AdditionalData]

各要素は、 [アノテーション仕様](#operation/getAnnotationSpecs)で定義された属性(`additional_data_definitions`内)のいずれかの要素と対応づけます。 各要素は、どの属性なのかを表す`additional_data_definition_id`と値が必要です。値は、属性の種類に対応するキーに格納します(下表)。 <table> <tr><th>アノテーション属性の種類<br>(<code>additional_data_definition</code>の<code>type</code>)</th><th>属性の値を格納するキー</th><th>データ型</th></tr> <tr><td><code>text</code>, <code>comment</code> または <code>tracking</code></td><td><code>comment</code></td><td>string</td></tr> <tr><td><code>flag<c/ode></td><td><code>flag</code></td><td>boolean</td></tr> <tr><td><code>integer</code></td><td><code>integer</code></td><td>integer</td></tr> <tr><td><code>choice</code> または <code>select</code></td><td><code>choice</code></td><td>string(選択肢ID)</td></tr> <tr><td><code>link</code></td><td><code>comment</code></td><td>string(アノテーションID)</td></tr> </table>

annotation_id: str

アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> 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
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: Optional[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: Optional[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: Optional[str], additional_data_definition_name: Optional[Dict[str, Any]], type: Optional[annofabapi.models.AdditionalDataDefinitionType], value: Optional[Dict[str, Any]])[source]
additional_data_definition_id: Optional[str]
additional_data_definition_name: Optional[Dict[str, Any]]
type: Optional[annofabapi.models.AdditionalDataDefinitionType]
value: Optional[Dict[str, Any]]
class annofabapi.dataclass.annotation.FullAnnotationDataBoundingBox(left_top: annofabapi.dataclass.annotation.Point, right_bottom: annofabapi.dataclass.annotation.Point, type: str)[source]

annotation_type が bounding_boxの場合に、[左上頂点座標, 右下頂点座標]を {“x”:int, “y”:int} の形式で記述したもの。

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]

頂点座標 {“x”:int, “y”:int} の配列。 * annotation_type が polygon/polyline の場合: ポリゴン/ポリラインを構成する頂点の配列。

points: List[annofabapi.dataclass.annotation.Point]
type: str

Points

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

annotation_type が rangeの場合に、[開始時間, 終了時間]を {“begin”:number, “end”:number} の形式で記述したもの。開始時間・終了時間の単位は秒で、精度はミリ秒まで。

begin: float

開始時間(ミリ秒)。小数点以下はミリ秒以下を表します。

end: float

終了時間(ミリ秒)。小数点以下はミリ秒以下を表します。

type: str

Range

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

塗っていないところは rgba(0,0,0,0)、塗ったところは rgba(255,255,255,1) の PNGデータをBase64エンコードしたもの。

data_uri: str
type: str

Segmentation

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

SegmentationV2

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

annotation_type が pointの場合。

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: annofabapi.models.AnnotationType, 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)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。

annotation_type: annofabapi.models.AnnotationType
data: Any
data_holding_type: annofabapi.models.AnnotationDataHoldingType
label_id: str
label_name: Dict[str, Any]
user_id: str
class annofabapi.dataclass.annotation.Point(x: int, y: int)[source]

座標

x: int
y: int
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]

キーに属性の名前、値に各属性の値が入った辞書構造です。

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
additional_data_list: List[annofabapi.dataclass.annotation.AdditionalData]
annotation_id: str

アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> 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
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
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
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
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
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]
comment: Optional[str]
history_id: str
project_id: str

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

updated_datetime: str
url: str
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.Color(red: int, green: int, blue: int)[source]
blue: int
green: int
red: int
class annofabapi.dataclass.annotation_specs.InspectionPhrase(id: str, text: annofabapi.dataclass.annotation_specs.InternationalizationMessage)[source]
id: str
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]
class annofabapi.dataclass.annotation_specs.InternationalizationMessageMessages(lang: str, message: str)[source]
lang: str
message: str
class annofabapi.dataclass.annotation_specs.Keybind(code: str, shift: bool, ctrl: bool, alt: bool)[source]
alt: bool
code: str
ctrl: bool
shift: bool
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: annofabapi.models.AnnotationType, bounding_box_metadata: Optional[annofabapi.dataclass.annotation_specs.LabelV1BoundingBoxMetadata], segmentation_metadata: Optional[annofabapi.dataclass.annotation_specs.LabelV1SegmentationMetadata], 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]
annotation_editor_feature: annofabapi.dataclass.annotation_specs.AnnotationEditorFeature
annotation_type: annofabapi.models.AnnotationType
bounding_box_metadata: Optional[annofabapi.dataclass.annotation_specs.LabelV1BoundingBoxMetadata]
color: annofabapi.dataclass.annotation_specs.Color
keybind: List[annofabapi.dataclass.annotation_specs.Keybind]
label_id: str
label_name: annofabapi.dataclass.annotation_specs.InternationalizationMessage
metadata: Optional[Dict[str, str]]

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

segmentation_metadata: Optional[annofabapi.dataclass.annotation_specs.LabelV1SegmentationMetadata]
class annofabapi.dataclass.annotation_specs.LabelV1BoundingBoxMetadata(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
min_width: int
position_for_minimum_bounding_box_insertion: Optional[annofabapi.dataclass.annotation_specs.PositionForMinimumBoundingBoxInsertion]
tolerance: Optional[int]
class annofabapi.dataclass.annotation_specs.LabelV1SegmentationMetadata(min_width: int, min_height: int, min_warn_rule: str, tolerance: Optional[int])[source]
min_height: int
min_warn_rule: str
min_width: int
tolerance: Optional[int]
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: annofabapi.models.AnnotationType, bounding_box_metadata: Optional[annofabapi.dataclass.annotation_specs.LabelV1BoundingBoxMetadata], segmentation_metadata: Optional[annofabapi.dataclass.annotation_specs.LabelV1SegmentationMetadata], 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]
allow_out_of_image_bounds: Optional[bool]
annotation_editor_feature: annofabapi.dataclass.annotation_specs.AnnotationEditorFeature
annotation_type: annofabapi.models.AnnotationType
bounding_box_metadata: Optional[annofabapi.dataclass.annotation_specs.LabelV1BoundingBoxMetadata]
color: annofabapi.dataclass.annotation_specs.Color
keybind: List[annofabapi.dataclass.annotation_specs.Keybind]
label_id: str
label_name: annofabapi.dataclass.annotation_specs.InternationalizationMessage
metadata: Optional[Dict[str, str]]

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

segmentation_metadata: Optional[annofabapi.dataclass.annotation_specs.LabelV1SegmentationMetadata]
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

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, 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: Optional[bool], metadata: Optional[Dict[str, str]], system_metadata: Optional[Dict[str, Any]])[source]

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

etag: Optional[str]
input_data_id: str

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

input_data_name: str

表示用の名前です。

input_data_path: str

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

metadata: Optional[Dict[str, str]]

ユーザーが自由に登録できるkey-value型のメタデータです。主にカスタムエディタで使われることを想定しています。

original_input_data_path: Optional[str]

AF外部のストレージから登録された場合、その外部ストレージ中のパス。 それ以外の場合は値なし

project_id: str

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

sign_required: Optional[bool]

データがSigned Cookieによるクロスオリジン配信に対応しているか否かです。

system_metadata: Optional[Dict[str, Any]]
updated_datetime: str
url: Optional[str]

入力データを取得するためのhttpsスキーマのURLです。 このURLはセキュリティのために認証認可が必要となっており、URLだけでは入力データを参照できません。 このURLは内部用であり、常に変更になる可能性があります。そのため、アクセスは保証外となります。 また、このURLのレスポンスは最低1時間キャッシュされます。 キャッシュを無効にしたい場合は、クエリパラメータにアクセス毎にランダムなUUIDなどを付与してください。 設定の不備等でデータが取得できない場合、この属性は設定されません。

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

annofabapi.dataclass.inspection module

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

Note

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

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]

検査コメント

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: Optional[str], last_updated_datetime: Optional[str])[source]
html: Optional[str]

作業ガイドのHTML

last_updated_datetime: Optional[str]

最後に作業ガイドを更新した日時を指定する。まだ一度も保存した事がない場合は指定しない。

Type
  • [getInstruction](#operation/getInstruction) APIのレスポンスの場合

Type

最後に作業ガイドを更新した日時。 * [putInstruction](#operation/putInstruction) APIのリクエストボディの場合

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
image_id: str

作業ガイド画像ID

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: Optional[str], job_type: Optional[annofabapi.models.ProjectJobType], job_id: Optional[str], job_status: Optional[annofabapi.models.JobStatus], job_execution: Optional[Dict[str, Any]], job_detail: Optional[Dict[str, Any]], created_datetime: Optional[str], updated_datetime: Optional[str])[source]
created_datetime: Optional[str]
job_detail: Optional[Dict[str, Any]]

ジョブ結果の内部情報

job_execution: Optional[Dict[str, Any]]

ジョブの内部情報

job_id: Optional[str]
job_status: Optional[annofabapi.models.JobStatus]
job_type: Optional[annofabapi.models.ProjectJobType]
project_id: Optional[str]

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

updated_datetime: Optional[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: str, biography: Optional[str], keylayout: str, authority: annofabapi.models.AccountAuthority, is_external_account: bool, updated_datetime: Optional[str], reset_requested_email: Optional[str], errors: List[str])[source]
account_id: str
authority: annofabapi.models.AccountAuthority
biography: Optional[str]

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

email: str
errors: List[str]
is_external_account: bool

[外部アカウント連携](/docs/faq/#mpl0n7)済みのアカウントである場合true

keylayout: str
lang: str
reset_requested_email: Optional[str]
updated_datetime: Optional[str]
user_id: str
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
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: float)[source]
created_datetime: str
organization_id: str

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

storage_usage_bytes: float

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: Optional[str], updated_datetime: Optional[str])[source]
account_id: str
biography: Optional[str]

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

created_datetime: Optional[str]
organization_id: str

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

role: annofabapi.models.OrganizationMemberRole
status: annofabapi.models.OrganizationMemberStatus
updated_datetime: Optional[str]
user_id: str
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])[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)

input_data_max_long_side_length: Optional[int]

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

input_data_set_id_list: Optional[List[str]]

このフィールドは内部用でまだ何も意味を成しません。今は空配列を指定してください。

max_tasks_per_member: Optional[int]

保留中のタスクを除き、1人(オーナー以外)に割り当てられるタスク数上限。未指定の場合は10件として扱う。

max_tasks_per_member_including_hold: Optional[int]

保留中のタスクを含めて、1人(オーナー以外)に割り当てられるタスク数上限。未指定の場合は20件として扱う。

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]

抜取受入率。0-100のパーセント値で指定し、未指定の場合は100%として扱う。

sampling_inspection_rate: Optional[int]

抜取検査率。0-100のパーセント値で指定し、未指定の場合は100%として扱う。

task_assignment_property: Optional[Dict[str, Any]]
task_assignment_type: Optional[annofabapi.models.TaskAssignmentType]
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: Optional[str], created_datetime: Optional[str], sampling_inspection_rate: Optional[int], sampling_acceptance_rate: Optional[int])[source]
account_id: str
biography: Optional[str]

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

created_datetime: Optional[str]
member_role: annofabapi.models.ProjectMemberRole
member_status: annofabapi.models.ProjectMemberStatus
project_id: str

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

sampling_acceptance_rate: Optional[int]

メンバー固有の抜取受入率(0-100のパーセント値)。

sampling_inspection_rate: Optional[int]

メンバー固有の抜取検査率(0-100のパーセント値)。

updated_datetime: Optional[str]
user_id: str
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
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
wip: int

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

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

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

marker_id: Optional[str]

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

title: Optional[str]
class annofabapi.dataclass.statistics.Markers(project_id: Optional[str], markers: Optional[List[annofabapi.dataclass.statistics.Marker]], updated_datetime: Optional[str])[source]
markers: Optional[List[annofabapi.dataclass.statistics.Marker]]
project_id: Optional[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
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: Optional[str], tasks: Optional[List[annofabapi.dataclass.statistics.ProjectTaskStatistics]])[source]
date: Optional[str]
tasks: Optional[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(project_id: str, input_data_id: str, supplementary_data_id: str, supplementary_data_name: str, supplementary_data_path: str, url: Optional[str], etag: Optional[str], supplementary_data_type: annofabapi.models.SupplementaryDataType, supplementary_data_number: int, updated_datetime: Optional[str])[source]
etag: Optional[str]
input_data_id: str

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

project_id: str

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

supplementary_data_id: str
supplementary_data_name: str

表示用の名前

supplementary_data_number: int

表示順を表す数値(昇順)。同じ入力データに対して複数の補助情報で表示順が重複する場合、順序不定になります。

supplementary_data_path: str

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

supplementary_data_type: annofabapi.models.SupplementaryDataType
updated_datetime: Optional[str]
url: Optional[str]

このフィールドはAF内部での利用のみを想定しており、依存しないでください。

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, sampling: Optional[str], metadata: Optional[Dict[str, Any]])[source]
account_id: Optional[str]
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回差し戻しされたことになります。

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]
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
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
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: Optional[str], event_type: Optional[annofabapi.models.WebhookEventType], webhook_id: Optional[str], webhook_status: Optional[annofabapi.models.WebhookStatus], method: Optional[annofabapi.models.WebhookHttpMethod], headers: Optional[List[annofabapi.dataclass.webhook.WebhookHeader]], body: Optional[str], url: Optional[str], created_datetime: Optional[str], updated_datetime: Optional[str])[source]
body: Optional[str]
created_datetime: Optional[str]
event_type: Optional[annofabapi.models.WebhookEventType]
headers: Optional[List[annofabapi.dataclass.webhook.WebhookHeader]]
method: Optional[annofabapi.models.WebhookHttpMethod]
project_id: Optional[str]

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

updated_datetime: Optional[str]
url: Optional[str]
webhook_id: Optional[str]

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

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