Get task

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Get the details of a created task model.

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

Request

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

Method	URI
GET	/api/v1/task/{task_id}

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`task_id`	String	Required	Task ID Check in the response body of Get task list

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

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`task_id`	String	-	Task ID
`task_name`	String	-	Name of task entered by the user
`status`	String	-	Creation type `registered` \| `pending` \| `in_progress` \| `completed` \| `failed` `registered`: registered `pending`: pending `in_progress`: creating `completed`: available `failed`: failed
`created_at`	String	-	Task creation request date (ISO 8601 format)
`completed_at`	String	-	Task creation job completion date (ISO 8601 format)
`train_feature_id`	String	-	Feature ID for training set If you have not made detailed settings for train/test, the feature you have entered will be displayed by default in the train field
`train_feature_name`	String	-	Feature name for training set
`train_bucket`	String	-	Bucket name of Object Storage where the correct answer dataset file is stored
`train_file_path`	String	-	File path of the correct answer dataset in the train_bucket bucket
`test_feature_id`	String	-	Feature ID for the test set set separately for evaluating the performance of the trained model
`test_feature_name`	String	-	Feature name for test set
`test_bucket`	String	-	Bucket name of Object Storage where the correct answer dataset file for test set is stored
`test_file_path`	String	-	File path of the correct answer dataset for test set in the train_bucket bucket
`AUROC`	Double	-	Performance of the created task model Value between 0 and 1 calculated as the area under the ROC curve
`line_count`	Integer	-	Number of lines of the feature used to create task
`disk_usage`	Integer	-	Capacity (byte) of the created task
`fail_message`	String	-	Message upon creation failure. See Troubleshooting NCLUE

Response example

The response example is as follows:

Succeeded

The following is a sample response upon a successful call.

{
    "task_id": "7db18fb6-55ca-4774-94f5-1e8736757249",
    "task_name": "Prediction model for pet food purchase interest",
    "status": "completed",
    "created_at": "2024-11-11T11:01:30",
    "completed_at": "2024-11-11T11:06:44",
    "train_feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
    "train_feature_name":"Shopping behavior sequence - 2024",
    "train_bucket":"your.bucket.name",
    "train_file_path":"task_dataset/pet_food.tsv",
    "test_feature_id":null,
    "test_feature_name":null,
    "test_bucket":null,
    "test_file_path":null,
    "AUROC":0.9054,
    "line_count": 1209478,
    "disk_usage": 72582684,
    "fail_message":null
}

Failure

For examples of responses in the event of a failed call, see Response status codes.

Was this article helpful?

What's Next

Get task list

Table of contents

Request
Response