Taskリストの照会

Prev Next

VPC環境で利用できます。

作成した Task Modelのリストを照会します。照会されたすべての Task Modelの詳細情報を確認できます。

リクエスト

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

メソッド URI
GET /tasks

リクエストヘッダ

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

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

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
index Integer Optional リストのスタート位置
  • デフォルト: 0
limit Integer Optional リストの出力制限値
  • 1~100(デフォルト: 20)

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
index Integer - リストのスタート位置
limit Integer - リストの出力制限値
total Integer - 照会された Task数
tasks Array - Taskリスト

tasks

tasksの説明は次の通りです。

フィールド タイプ 必須の有無 説明
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 - 作成失敗メッセージ

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

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

レスポンス例

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

{
    "index": 0,
    "limit": 20,
    "total": 5,
    "tasks": [
        {
            "task_id": "3179664c-****-****-****-af6354344018",
            "task_name": "YOUR_TASK_NAME",
            "status": "completed",
            "created_at": "2024-11-22T08:50:51",
            "completed_at": "2024-11-22T08:52:23",
            "train_feature_id": "28bd06bb-****-****-****-9f2d6a9c3313",
            "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.7587277915975462",
            "line_count": 93734,
            "disk_usage": 42582684,
            "fail_message": null
        },
        // (省略)
    ]
}