Taskの作成

Prev Next

VPC環境で利用できます。

Task Modelを新規作成します。

Task Modelの作成をリクエストすると、次の順序で作成が行われます。

順序 作成状態 説明
Step 1 registered: 登録完了 作成作業が NCLUEシステムに登録された状態
  • 作業開始前の状態で、Taskを削除すると作業をキャンセルできる
Step 2 pending: 待機中 作成作業がシステムキューに登録された状態
Step 3 in_progress: 作成中 作成作業がサーバで実行中の状態
Step 4
  • complete: 使用可能
  • failed: 失敗
 作成作業が完了した状態
  • 作成に成功するとcomplete状態になり、正常に使用可能
  • 作業中に発生したエラーにより作成できなかった場合はfailed状態になり、使用不可
参考

Taskの作成にかかる時間は、データ量と利用可能なリソースの状況によります。作成の進行状況は、Taskの照会 APIを呼び出すとレスポンスボディのstatusフィールドで確認できます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST tasks

リクエストヘッダ

NCLUE APIで共通して使用されるヘッダの詳細は、NCLUEのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
name String Required Task名
  • 1~100文字
train_feature_id String Required Train正解データに適用する Feature ID
train_bucket String Required Train正解データファイルが保存された Object Storageのバケット名
train_file_path String Required train_bucket内の Train正解データのファイルパス
  • 次の記号を含むファイルパスは入力不可
    • &$@=;:+,?*\{}^%`[]<>~#|"'
    • ASCIIコードが0~31、128~255の文字
test_feature_id String Optional Test正解データに適用する Feature ID
test_bucket String Optional Test正解データファイルが保存された Object Storageのバケット名
test_file_path String Optional test_bucket内の Test正解データファイルパス
  • 次の記号を含むファイルパスは入力不可
    • &$@=;:+,?*\{}^%`[]<>~#|"'
    • ASCIIコードが0~31、128~255の文字

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/tasks' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' \
--data '{
    "name": "YOUR_TASK_NAME",
    "train_feature_id": "0ccc59f9-****-****-****-7837ae76d046",
    "train_bucket": "YOUR_BUCKET_NAME",
    "train_file_path": "path/filename"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
task_id String - Task ID
task_name String - Task名
created_at String - Taskの作成リクエスト日時(ISO 8601形式)
train_feature_id String - Train正解データに適用する Feature ID
train_feature_name String - Train正解データに適用する Feature名
train_bucket String - Train正解データファイルが保存された Object Storageのバケット名
train_file_path String - train_bucket内の Train正解データファイルパス
test_feature_id String - Test正解データに適用する Feature ID
test_feature_name String - Test正解データに適用する Feature名
test_bucket String - Test正解データファイルが保存された Object Storageのバケット名
test_file_path String - test_bucket内の Test正解データファイルパス

レスポンスステータスコード

NCLUEで共通して使用されるレスポンスステータスコードの詳細は、NCLUEのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "task_id": "f5aebc0c-****-****-****-b201bc64b1c9",
    "task_name": "YOUR_TASK_NAME",
    "created_at": "2024-11-26T11:48:16+09:00",
    "train_feature_id": "0ccc59f9-****-****-****-7837ae76d046",
    "train_feature_name": "YOUR_FEATURE_NAME",
    "train_bucket": "YOUR_BUCKET_NAME",
    "train_file_path": "path/filename",
    "test_feature_id": null,
    "test_feature_name": null,
    "test_bucket": null,
    "test_file_path": null
}