Taskの照会

Prev Next

VPC環境で利用できます。

特定の Task Modelの詳細情報を照会します。作成リクエストした Task Modelの進行状況、Task Modelに適用した Feature情報、正解データセットファイルが保存されている Object Storageバケット名とファイルパス、Task Modelの容量を確認できます。作成が完了すると Task Modelのパフォーマンスを確認できます。作成できなかった場合はエラーメッセージを確認できます。

リクエスト

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

メソッド URI
GET /tasks/{task_id}

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
task_id String Required Task ID

リクエスト例

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

curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/tasks/{task_id}' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
task_id String - Task ID
task_name String - Task名
status String - Taskの状態
  • registered | pending | in_progress | completed | failed
    • registered: 登録完了
    • pending: 待機中
    • in_progress: 作成中
    • completed: 使用可能
    • failed: 失敗
created_at String - Taskの作成リクエスト日時(ISO 8601形式)
completed_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正解データファイルパス
AUROC Number - Task Modelのパフォーマンス
  • 0~1
  • ROC曲線の下の面積で算出
line_count Integer - Taskに適用された Featureのライン数
  • Train、Test正解データをいずれも使用した場合、各データに適用された Featureのライン数を合計
disk_usage Integer - Task容量(Byte)
fail_message String | null - 作成失敗メッセージ

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

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

レスポンス例

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

{
    "task_id": "f5aebc0c-****-****-****-b201bc64b1c9",
    "task_name": "YOUR_TASK_NAME",
    "status": "completed",
    "created_at": "2024-11-26T11:48:16",
    "completed_at": "2024-11-26T11:49:55",
    "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,
    "AUROC": "0.7681659649879657",
    "line_count": 93734,
    "disk_usage": 42582684,
    "fail_message": null
}