annotation create_classification#

Description#

指定したラベルの全体アノテーション（Classification）を作成します。

既に全体アノテーションが存在する場合は、作成をスキップします。作業中状態のタスクには作成できません。

利用用途#

annotation change_attributes コマンドで全体アノテーションの属性値を変更するには、事前に全体アノテーションが存在している必要があります。しかし、タスク作成直後は全体アノテーションが存在しません。アノテーションエディタ画面でアノテーションを保存して、初めて全体アノテーションが作成されます。タスク作成直後に、全体アノテーションの属性値を annotation change_attributes コマンドで変更する際などに、有用なコマンドです。

Examples#

基本的な使い方#

--task_id に全体アノテーションを作成するタスクのIDを指定し、 --label_name に作成する全体アノテーションのラベル名（英語）を指定してください。

$ annofabcli annotation create_classification --project_id prj1 \
--task_id task1 task2 --label_name weather

複数のラベル名を指定することもできます。

$ annofabcli annotation create_classification --project_id prj1 \
--task_id task1 --label_name weather season time_of_day

担当者の変更#

オーナーロールでは、タスクの担当者や状態を変更せずに全体アノテーションを作成できます。チェッカーロールで自身が担当者ではないタスクに作成するには、 --change_operator_to_me を指定してください。担当者を一時的に自分自身に変更して全体アノテーションを作成します。オーナーロールで指定しても効果はありません。

$ annofabcli annotation create_classification --project_id prj1 \
--task_id task1 --label_name weather --change_operator_to_me

完了状態のタスクへの作成#

デフォルトでは、完了状態のタスクには全体アノテーションを作成しません。 --include_complete_task を指定すると、完了状態のタスクにも全体アノテーションを作成できます。ただし、このオプションはプロジェクトのオーナーロールを持つユーザーでのみ実行できます。

$ annofabcli annotation create_classification --project_id prj1 \
--task_id task1 --label_name weather --include_complete_task

休憩中状態のタスクへの作成#

デフォルトでは、休憩中状態のタスクには全体アノテーションを作成しません。 --include_break_task を指定すると、休憩中状態のタスクにも全体アノテーションを作成できます。

保留中状態のタスクへの作成#

デフォルトでは、保留中状態のタスクには全体アノテーションを作成しません。 --include_on_hold_task を指定すると、保留中状態のタスクにも全体アノテーションを作成できます。チェッカーロールで作成した場合、作成後は未着手状態になります。

並列処理#

--parallelism を指定すると、複数のタスクを並列で処理できます。並列処理を使用する場合は、 --yes も指定してください。

$ annofabcli annotation create_classification --project_id prj1 \
--task_id file://task_id.txt --label_name weather \
--parallelism 4 --yes

Usage Details#

指定したラベルの全体アノテーション（Classification）を作成します。既に全体アノテーションが存在する場合はスキップします。作業中状態のタスクには作成できません。完了状態のタスクには、デフォルトでは作成できません。休憩中状態のタスクには、デフォルトでは作成できません。

usage: annofabcli annotation create_classification [-h] [--yes]
                                                   [--endpoint_url ENDPOINT_URL]
                                                   [--annofab_user_id ANNOFAB_USER_ID]
                                                   [--annofab_password ANNOFAB_PASSWORD]
                                                   [--annofab_pat ANNOFAB_PAT]
                                                   [--logdir LOGDIR]
                                                   [--disable_log] [--debug]
                                                   -p PROJECT_ID -t TASK_ID
                                                   [TASK_ID ...] --label_name
                                                   LABEL_NAME [LABEL_NAME ...]
                                                   [--change_operator_to_me]
                                                   [--include_complete_task]
                                                   [--include_break_task]
                                                   [--include_on_hold_task]
                                                   [--parallelism {2,3,4}]

Named Arguments#

-p, --project_id

対象のプロジェクトのproject_idを指定します。

-t, --task_id

全体アノテーションの作成先であるタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。

--label_name

作成する全体アノテーションのラベル名（英語）を指定します。

--change_operator_to_me

チェッカーロールで、自身が担当者ではないタスクに全体アノテーションを作成する場合に指定してください。タスクの担当者を一時的に自分自身に変更し、作成完了後に元へ戻します。オーナーロールで指定しても効果はありません。

--include_complete_task

オーナーロールで完了状態のタスクにも全体アノテーションを作成します。未指定の場合は、完了状態のタスクはスキップされます。

--include_break_task

休憩中状態のタスクにも全体アノテーションを作成します。未指定の場合は、休憩中状態のタスクはスキップされます。

--include_on_hold_task

保留中状態のタスクにも全体アノテーションを作成します。チェッカーロールで作成した場合、作成後は未着手状態になります。未指定の場合は、保留中状態のタスクはスキップされます。

--parallelism

Possible choices: 2, 3, 4

並列度。指定しない場合は、逐次的に処理します。--parallelism を指定した場合は、--yes も指定してください。

global optional arguments#

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: 'https://annofab.com'

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

オーナーロールまたはチェッカーロールを持つユーザーで実行してください。