MENU
      Get task

        Get task


        Article summary

        Available in VPC

        Get the details of a specific task model. You can check the progress of the task model you requested to create, the feature information applied to the task model, the Object Storage bucket and file name where the correct answer dataset file is located, and the capacity of the task model. When the creation is complete, you can check the performance values of the task model, and when the creation fails, you can check the error message.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        GET/task/{task_id}

        Request headers

        For information about the headers common to all NCLUE APIs, see NCLUE request headers.

        Request path parameters

        You can use the following path parameters with your request:

        FieldTypeRequiredDescription
        task_idStringRequiredTask ID

        Request example

        The request example is as follows:

        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}'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        task_idString-Task ID
        task_nameString-Task name
        statusString-Task status
        • registered | pending | in_progress | completed | failed
          • registered: registered
          • pending: pending
          • in_progress: creating
          • completed: available
          • failed: failed
        created_atString-Task creation request date and time (ISO 8601 format)
        completed_atString-Task creation completion date and time (ISO 8601 format)
        train_feature_idString-Feature ID to apply to train correct answer data
        train_feature_nameString-Feature name to apply to train correct answer data
        train_bucketString-Bucket name of Object Storage where the train correct answer data file is stored
        train_file_pathString-Train correct answer data file path in train_bucket
        test_feature_idString-Feature ID to apply to test correct answer data
        test_feature_nameString-Feature name to apply to test correct answer data
        test_bucketString-Bucket name of Object Storage where the test correct answer data file is stored
        test_file_pathString-Test correct answer data file path in test_bucket
        AUROCNumber-Performance of the task model
        • 0-1
        • Calculated as the area under the ROC curve
        line_countInteger-Number of lines of the feature applied to the task
        • If you use both the train and test correct answer data, sum the number of lines for the two features applied to each data
        disk_usageInteger-Capacity (byte) of the task
        fail_messageString-Creation failure message

        Response status codes

        For response status codes common to NCLUE, see NCLUE response status codes.

        Response example

        The response example is as follows:

        {
            "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
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.