Create feature
- Print
- PDF
Create feature
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Create a feature.
When a user requests the creation, the NCLUE system registers the request job and returns the feature 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
| 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 features varies in time depending on the service's available resources. To check the progress of the creation, call the Get feature 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/features |
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 | Feature name (40-character limit) |
source_bucket | String | Required | Bucket name of Object Storage where the sequence dataset file is stored |
source_file_path | String | Required | Sequence dataset file path in the source_bucket bucket
|
Request example
The request example is as follows:
curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/features' \
--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": "Shopping behavior sequence - 2024",
"source_bucket": "your_bucket_name",
"source_file_path": "path/sequence_dataset_filename"
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
| Field | Type | Required | Description |
|---|---|---|---|
feature_id | String | - | Feature ID |
feature_name | String | - | Feature name entered by the user |
created_at | String | - | Feature creation request date (ISO 8601 format) |
source_bucket | String | - | Entered Object Storage bucket name |
source_file_path | String | - | source_bucket bucket's input data file path |
Response example
The response example is as follows:
Succeeded
The following is a sample response upon a successful call.
{
"feature_id": "79eb85b5-8ec5-4e1a-8617-64a1977c8062",
"feature_name": "Shopping behavior sequence - 2024",
"created_at": "2024-10-08T08:08:08",
"source_bucket": "your.bucket.name",
"source_file_path": "path/sequence_dataset_filename"
}
Failure
For examples of responses in the event of a failed call, see Response status codes.
Was this article helpful?