Create task run

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Create a task model run.

When a user requests the creation of task run, the NCLUE system registers the request job and returns the task run ID. The creation process is as follows.

Creation process

Order	Creation status	Description
Step 1	Registered `registered`	Status where the creation job is registered in the system. It is the status before starting the job. You can cancel the job by deleting it at this point
Step 2	Pending `pending`	Status where the creation job is queued in the system
Step 3	Creating `in_progress`	Status where the job is being executed on the server. Creation time varies depending on the service's available resources
Step 4	Creation complete Available `completed` Failed `failed`	Once creation is complete, it will be available for use when successful with the "Available" status. If an error occurs during the operation, it will be in the "Failed" status, and the error message can be used to troubleshoot the problem

The creation of task run varies in time depending on the service's available resources. To check the progress of the creation, call the Get task run 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	/api/v1/task-runs

Request headers

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

Request body

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

Field	Type	Required	Description
`name`	String	Required	Task run name (40-character limit)
`task_id`	String	Required	ID of task to check performance
`feature_id`	String	Required	ID of the feature applied to the task
`result_bucket`	String	Required	Name of the Object Storage bucket to store the task run job results
`result_file_path`	String	Required	File path to store the results in the result_bucket 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/task-runs' \
--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":"Estimate of users interested in purchasing pet food",
    "task_id":"b5e742f1-0558-465a-8485-3b7808b0e125",
    "feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
    "result_bucket":"your.bucket.name",
    "result_file_path":"petfood_predict.tsv"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`run_id`	String	-	Task Run ID
`run_name`	String	-	Name of task run entered by the user
`task_id`	String	-	ID of task to check performance
`task_name`	String	-	Name of task to check performance
`feature_id`	String	-	ID of the feature applied to the task
`feature_name`	String	-	Name of the feature applied to the task
`created_at`	String	-	Task run creation request date (ISO 8601 format)
`result_bucket`	String	-	Name of the Object Storage bucket to store the task run job results
`result_file_path`	String	-	File path to save the results in the result_bucket bucket

Response example

The response example is as follows:

Succeeded

The following is a sample response upon a successful call.

{
    "run_id":"9e6fecc9-0079-4c5e-a0c6-f387e6221afa",
    "run_name":"Estimate of users interested in purchasing pet food",
    "task_id":"b5e742f1-0558-465a-8485-3b7808b0e125",
    "task_name":"Prediction model for pet food purchase interest",
    "feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
    "feature_name":"Shopping behavior sequence - 2024",
    "created_at":"2024-11-03T15:02:24",
    "result_bucket":"your.bucket.name",
    "result_file_path":"petfood_predict.tsv"
}

Failure

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

Was this article helpful?

What's Next

Delete task run

Table of contents

Request
Response