annofabapi.dataclass module#

annofabapi.dataclass.annotation module#

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

Note

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

class annofabapi.dataclass.annotation.AnnotationDetailContentInputInner(type: str, data: Any)[source]#

アノテーションのデータ部をJSON内部に保持します

data: Any#
type: str#
class annofabapi.dataclass.annotation.AnnotationDetailContentInputOuter(type: str, path: str)[source]#

アノテーションのデータ部を外部ファイルの形式(画像など)で保持します

path: str#

外部ファイルの位置を示す文字列。 [createTempPath](#operation/createTempPath) APIによって取得したpathを指定します。

type: str#
class annofabapi.dataclass.annotation.AnnotationDetailContentOutputInner(type: str, data: Any)[source]#

アノテーションのデータ部をJSON内部に保持します

data: Any#
type: str#
class annofabapi.dataclass.annotation.AnnotationDetailContentOutputInnerUnknown(type: str, data: str)[source]#

アノテーションのデータ部をJSON内部に保持します。 AnnotationDetailV1の形式で保存されていたデータのAnnotationTypeが特定できない場合にこの値となります。 典型的な例では、アノテーションの保存後にアノテーション仕様が書き換わっていた場合が該当します。

data: str#

アノテーション座標値や区間などの文字列表現です。 アノテーション種類(annotation_type)とデータ格納形式(data_holding_type)に応じて、以下のとおり表現が変わります。 <table> <tr><th>annotation_type</th><th>data_holding_type</th><th>文字列表現</th></tr> <tr><td>bounding_box</td><td>inner</td><td><code>”左上x,左上y,右下x,右下y”</code></td></tr> <tr><td>point</td><td>inner</td><td><code>”x1,y1”</code></td></tr> <tr><td>polygon / polyline</td><td>inner</td><td><code>”x1,y1,x2,y2, … “</code></td></tr> <tr><td>range </td><td>inner</td><td><code>”開始時間(ミリ秒),終了時間(ミリ秒) “</code></td></tr> <tr><td>classification</td><td>inner</td><td><code>null</code></td></tr> <tr><td>segmentation</td><td>outer</td><td><code>null</code></td></tr> <tr><td>segmentation_v2</td><td>outer</td><td><code>null</code></td></tr> </table>

type: str#
class annofabapi.dataclass.annotation.AnnotationDetailContentOutputOuter(type: str, url: str, etag: str)[source]#

アノテーションのデータ部を外部ファイルの形式(画像など)で保持します

etag: str#

外部ファイルに保存されたアノテーションのETag

type: str#
url: str#

外部ファイルに保存されたアノテーションの認証済み一時URL

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

アノテーションのデータ部を外部ファイルの形式(画像など)で保持します。 Outerのurl / etagを解決しなかった場合(過去のアノテーションを取得した場合等)にこの値となります。

type: str#
class annofabapi.dataclass.annotation.AnnotationDetailV2Create(type: str, annotation_id: str, label_id: str, body: Dict[str, Any], additional_data_list: List[AdditionalDataV2], editor_props: AnnotationPropsForEditor)[source]#

新規にアノテーションを作成する場合にこの型を利用します。

additional_data_list: List[AdditionalDataV2]#
annotation_id: str#

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

body: Dict[str, Any]#
editor_props: AnnotationPropsForEditor#
label_id: str#

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

type: str#
class annofabapi.dataclass.annotation.AnnotationDetailV2Import(type: str, annotation_id: str, account_id: str, label_id: str, body: Dict[str, Any], additional_data_list: List[AdditionalDataV2], editor_props: AnnotationPropsForEditor, created_datetime: str, updated_datetime: str)[source]#

過去にAnnofab内外で作成したアノテーションをそのままインポートする場合にこの型を利用します。

account_id: str#

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

additional_data_list: List[AdditionalDataV2]#
annotation_id: str#

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

body: Dict[str, Any]#
created_datetime: str#

作成日時

editor_props: AnnotationPropsForEditor#
label_id: str#

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

type: str#
updated_datetime: str#

更新日時

class annofabapi.dataclass.annotation.AnnotationDetailV2Update(type: str, annotation_id: str, label_id: str, body: Optional[Dict[str, Any]], additional_data_list: List[AdditionalDataV2], editor_props: AnnotationPropsForEditor)[source]#

既に存在するアノテーションを更新する場合にこの型を利用します

additional_data_list: List[AdditionalDataV2]#
annotation_id: str#

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

body: Optional[Dict[str, Any]]#
editor_props: AnnotationPropsForEditor#
label_id: str#

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

type: str#
class annofabapi.dataclass.annotation.AnnotationPropsForEditor(can_delete: Optional[bool], can_edit_data: Optional[bool], can_edit_additional: Optional[bool], description: Optional[str], tags: Optional[List[str]], etc: Optional[Dict[str, Any]])[source]#

アノテーションエディタ用のアノテーション毎のプロパティです。<br /> ここに含まれているデータはアノテーション結果に反映されず、エディタが利用するために存在します。 エディタ用のデータであるため、たとえば`can_delete`や`can_edit_data`が`false`でも、APIによる編集は妨げません。<br /> ここで定義されているデータを利用して動作を変えるかどうかは、エディタによって異なります。

can_delete: Optional[bool]#

アノテーションがエディタ上で削除できるかどうか。 trueの場合削除可能。

can_edit_additional: Optional[bool]#

アノテーションの付加情報を編集できるかどうか。 trueの場合編集可能。 2022/09現在、この値を利用しているエディタは存在しません。

can_edit_data: Optional[bool]#

アノテーションの本体のデータを編集できるかどうか。 trueの場合編集可能。 2022/09現在、この値を利用しているエディタは存在しません。

description: Optional[str]#

アノテーションについての人間可読な説明。 2022/09現在、この値を利用しているエディタは存在しません。

etc: Optional[Dict[str, Any]]#

上記以外の任意のJson構造

tags: Optional[List[str]]#

アノテーションに付与されている機械可読・人間可読なタグの列。 2022/09現在、この値を利用しているエディタは存在しません

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

属性情報

additional_data_definition_id: str#

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

additional_data_definition_name: Dict[str, Any]#
type: AdditionalDataDefinitionType#
value: Dict[str, Any]#
class annofabapi.dataclass.annotation.Point(x: int, y: int)[source]#

点の座標値

x: int#

X座標の値[ピクセル]

y: int#

Y座標の値[ピクセル]

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

アノテーション情報

account_id: str#

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

additional_data_list: List[AdditionalDataV1]#

属性情報。 アノテーション属性の種類(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: 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.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.AnnotationTypeFieldValueAnnotationEditorFeature(type: str, 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#
type: str#
class annofabapi.dataclass.annotation_specs.AnnotationTypeFieldValueDisplayLineDirection(type: str, has_direction: bool)[source]#

線の向き表示/非表示の設定

has_direction: bool#
type: str#
class annofabapi.dataclass.annotation_specs.AnnotationTypeFieldValueEmptyFieldValue(type: str)[source]#

値を持たないフィールド。 アノテーション仕様上に定義が存在すること自体に意味がある場合のフィールド値に利用します。

type: str#
class annofabapi.dataclass.annotation_specs.AnnotationTypeFieldValueMarginOfErrorTolerance(type: str, max_pixel: int)[source]#

誤差許容範囲

max_pixel: int#
type: str#
class annofabapi.dataclass.annotation_specs.AnnotationTypeFieldValueMinimumArea2d(type: str, min_area: int)[source]#

最小の面積

min_area: int#
type: str#
class annofabapi.dataclass.annotation_specs.AnnotationTypeFieldValueMinimumSize(type: str, min_warn_rule: AnnotationTypeFieldMinWarnRule, min_width: int, min_height: int)[source]#

アノテーションの最小サイズに関する設定

min_height: int#
min_warn_rule: AnnotationTypeFieldMinWarnRule#
min_width: int#
type: str#
class annofabapi.dataclass.annotation_specs.AnnotationTypeFieldValueOneBooleanFieldValue(type: str, value: bool)[source]#

真偽値をひとつだけ持つフィールド

type: str#
value: bool#
class annofabapi.dataclass.annotation_specs.AnnotationTypeFieldValueOneIntegerFieldValue(type: str, value: int)[source]#

数値をひとつだけ持つフィールド

type: str#
value: int#
class annofabapi.dataclass.annotation_specs.AnnotationTypeFieldValueOneStringFieldValue(type: str, value: str)[source]#

文字列を一つだけ持つフィールド

type: str#
value: str#
class annofabapi.dataclass.annotation_specs.AnnotationTypeFieldValueVertexCountMinMax(type: str, min: int, max: int)[source]#

頂点数の最大・最小

max: int#
min: int#
type: 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[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[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.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]#

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

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: 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: 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: TaskPhase#
phase_stage: int#

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

phrases: Optional[List[str]]#

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

project_id: str#

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

status: 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などは正しく表現できない可能性がある。

annofabapi.dataclass.job module#

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

Note

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

annofabapi.dataclass.my module#

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

Note

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

annofabapi.dataclass.organization module#

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

Note

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

annofabapi.dataclass.organization_member module#

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

Note

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

annofabapi.dataclass.project module#

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

Note

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

class annofabapi.dataclass.project.ProjectConfiguration(number_of_inspections: Optional[int], assignee_rule_of_resubmitted_task: Optional[AssigneeRuleOfResubmittedTask], task_assignment_type: Optional[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[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[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などは正しく表現できない可能性がある。

annofabapi.dataclass.statistics module#

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

Note

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

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

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

labels: Dict[str, InspectionStatisticsPhrases]#

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

no_label: InspectionStatisticsPhrases#

annofabapi.dataclass.supplementary module#

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

Note

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

annofabapi.dataclass.task module#

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

Note

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

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: 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: 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: TaskPhase, phase_stage: int, account_id: str, worked: Optional[bool])[source]#

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

account_id: str#

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

phase: TaskPhase#
phase_stage: int#
worked: Optional[bool]#

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

annofabapi.dataclass.webhook module#

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

Note

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