Create task

Prev Next

Available in VPC

Create a new task model.

When you request to create a task model, the creation process will proceed according to the following sequence.

Order Creation status Description
Step 1 registered: registered Status where the creation job is registered in the NCLUE system
  • It is the status before the start of the job, and you can Delete task to cancel the job
Step 2 pending: pending Status where the creation job is queued in the system
Step 3 in_progress: creating Status where the creation job is running on the server
Step 4
  • complete: available
  • failed: failure
 Status where the creation job has been completed
  • If the creation is successful, the status will be complete, and it can be used normally
  • If the creation fails due to an error that occurred during the operation, the status will be failed and it can't be used
Note

The duration of each job when creating a task depends on the amount of data and service's available resources. To check the progress of the creation, call the Get task API and check the status field in the response body.

Request

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

Method URI
POST tasks

Request headers

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

Request body

You can include the following data in the body of your request:

Field Type Required Description
name String Required Task name
  • 1-100 characters
train_feature_id String Required Feature ID to apply for train correct answer data
train_bucket String Required Bucket name of Object Storage where the train correct answer data file is stored
train_file_path String Required Train correct answer data file path in train_bucket
  • File paths containing the following special characters can't be entered
    • &$@=;:+,?*\{}^%`[]<>~#|"'
    • Characters with ASCII codes 0 to 31 and 128 to 255
test_feature_id String Optional Feature ID to apply for test correct answer data
test_bucket String Optional Bucket name of Object Storage where the test correct answer data file is stored
test_file_path String Optional Test correct answer data file path in test_bucket
  • File paths containing the following special characters can't be entered
    • &$@=;:+,?*\{}^%`[]<>~#|"'
    • Characters with ASCII codes 0 to 31 and 128 to 255

Request example

The request example is as follows:

curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/tasks' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' \
--data '{
    "name": "YOUR_TASK_NAME",
    "train_feature_id": "0ccc59f9-****-****-****-7837ae76d046",
    "train_bucket": "YOUR_BUCKET_NAME",
    "train_file_path": "path/filename"
}'

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 - Task name
created_at String - Task creation request date and time (ISO 8601 format)
train_feature_id String - Feature ID to apply to train correct answer data
train_feature_name String - Feature name to apply to train correct answer data
train_bucket String - Bucket name of Object Storage where the train correct answer data file is stored
train_file_path String - Train correct answer data file path in train_bucket
test_feature_id String - Feature ID to apply to test correct answer data
test_feature_name String - Feature name to apply to test correct answer data
test_bucket String - Bucket name of Object Storage where the test correct answer data file is stored
test_file_path String - Test correct answer data file path in test_bucket

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",
    "created_at": "2024-11-26T11:48:16+09:00",
    "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
}