Get task list

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Get the list of created task models.

Request

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

Method	URI
GET	/api/v1/tasks

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`index`	Integer	Optional	Start location of task list Default: 0
`limit`	Integer	Optional	Task list output limit value 1 - 100 (default: 20)

Request example

The request example is as follows:

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

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`index`	Integer	-	Page index (0 - N)
`limit`	Integer	-	Task list output limit value (1 - 100)
`total`	Integer	-	Total number of tasks created by the user
`tasks.task_id`	String	-	Task ID
`tasks.task_name`	String	-	Name of task entered by the user
`tasks.status`	String	-	Creation type `registered` \| `pending` \| `in_progress` \| `completed` \| `failed` `registered`: registered `pending`: pending `in_progress`: creating `completed`: available `failed`: failed
`tasks.created_at`	String	-	Task creation request date (ISO 8601 format)
`tasks.completed_at`	String	-	Task creation job completion date (ISO 8601 format)
`tasks.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
`tasks.train_feature_name`	String	-	Feature name for training set
`tasks.train_bucket`	String	-	Bucket name of Object Storage where the correct answer dataset file is stored
`tasks.train_file_path`	String	-	File path of the correct answer dataset in the train_bucket bucket
`tasks.test_feature_id`	String	-	Feature ID for the test set set separately for evaluating the performance of the trained model
`tasks.test_feature_name`	String	-	Feature name for test set
`tasks.test_bucket`	String	-	Bucket name of Object Storage where the correct answer dataset file for test set is stored
`tasks.test_file_path`	String	-	File path of the correct answer dataset for test set in the train_bucket bucket
`tasks.AUROC`	Double	-	Performance of the created task model Value between 0 and 1 calculated as the area under the ROC curve
`tasks.line_count`	Integer	-	Number of lines of the feature used to create task
`tasks.disk_usage`	Integer	-	Capacity (byte) of the created task
`tasks.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.

{
    "index": 0,
    "limit": 20,
    "total: 172,
    "tasks": [
        {
            "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

Create task

Table of contents

Request
Response