NCLUE overview
- Print
- PDF
NCLUE overview
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
NCLUE is a NAVER Cloud Platform SaaS service that helps users create various machine learning models and solve various business problems by using the NCLUE model based on HyperCLOVA, NAVER's large-scale language model. The NCLUE service provides RESTful APIs for feature creation, task model creation and execution, and user profiling.
Common NCLUE settings
The following describes commonly used request and response formats in NCLUE APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows.
https://nclue.apigw.ntruss.com
Request headers
The following describes the headers.
| Field | Required | Description |
|---|---|---|
X-NCP-APIGW-TIMESTAMP | Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC |
X-NCP-IAM-ACCESS-KEY | Required | Access key issued on NAVER Cloud Platform |
X-NCP-APIGW-SIGNATURE-V2 | Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256) |
Caution
Set the number of requests per second for the NCLUE API to 1 or less. (1 tps)
Response
The following describes the common response format.
Response status codes
The following describes the response status codes.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| 200 | success | Succeeded | |
| 401 | 10100 | ACCESS_DENIED | Invalid access. |
| 422 | 10101 | NAME_TOO_LONG | Enter 40 characters or less. |
| 409 | 10102 | DUPLICATE_NAME | The same name already exists. |
| 422 | 10103 | INVALID_PATH_CHARACTER | The file path contains unacceptable special characters. |
| 422 | 10104 | INVALID_CHARACTER_IN_TRAIN_PATH | The file path contains unacceptable special characters. |
| 422 | 10105 | INVALID_CHARACTER_IN_TEST_PATH | The file path contains unacceptable special characters. |
| 404 | 10106 | PATH_NOT_FOUND | The path/file doesn't exist. |
| 404 | 10107 | TRAIN_PATH_NOT_FOUND | The path/file doesn't exist. |
| 404 | 10108 | TEST_PATH_NOT_FOUND | The path/file doesn't exist. |
| 422 | 10109 | PERSONAL_DATA_NOT_ALLOWED | The file can't contain any personal information. |
| 422 | 10110 | PERSONAL_DATA_IN_TRAIN_FILE | The file can't contain any personal information. |
| 422 | 10111 | PERSONAL_DATA_IN_TEST_FILE | The file can't contain any personal information. |
| 422 | 10112 | TOO_MANY_KEYWORDS | The number of property keywords you can enter has been exceeded. |
| 409 | 10113 | INCOMPATIBLE_MODEL | The feature and the task are incompatible. |
| 409 | 10114 | FEATURE_PROCESSING | The requested operation can't be processed. Check if the feature is pending or being created. |
| 409 | 10115 | TASK_PROCESSING | The requested operation can't be processed. Check if the task is pending or being created. |
| 409 | 10116 | RUN_PROCESSING | The requested operation can't be processed. Check if the run is pending or being created. |
| 409 | 10117 | PROFILE_PROCESSING | The requested operation can't be processed. Check if the profile is pending or being created. |
| 422 | 10118 | KEYWORD_REQUIRED | Enter one or more keywords. |
| 422 | 10119 | STORAGE_FULL | Insufficient data storage space. |
| 422 | 10121 | EMPTY_CONTENT_IN_PATH | Empty path/file. |
| 422 | 10122 | EMPTY_CONTENT_IN_TRAIN_PATH | Empty path/file. |
| 422 | 10123 | EMPTY_CONTENT_IN_TEST_PATH | Empty path/file. |
| 404 | 10124 | PROFILE_NOT_FOUND | There is no profile data. |
| 422 | 10130 | INVALID_RESULT_FILE_PATH | Invalid file path entered. Folders with empty name fields are not allowed. |
| 422 | 10131 | OBJECT_STORAGE_ACCESS_DENIED | Unable to access the Object Storage bucket. Check your access permission. |
| 404 | 10132 | OBJECT_STORAGE_ACCOUNT_REQUIRED | You need to request subscription to the Object Storage service. |
| 422 | 10133 | INVALID_LIMIT | Limit must be between 1 and 100. |
| 409 | 10134 | FEATURE_IN_USE | This feature can't be deleted because it contains jobs being created with it. |
| 409 | 10135 | TASK_IN_USE | This task can't be deleted because it contains jobs being created with it. |
| 404 | 10136 | BUCKET_NOT_FOUND | The Object Storage bucket does not exist. |
Note
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
NCLUE API
The following describes the APIs provided by the NCLUE service.
| API | Description |
|---|---|
| Get feature | Get NCLUE feature details |
| Get feature list | Get NCLUE feature list |
| Create feature | Create NCLUE feature |
| Delete feature | Delete NCLUE feature |
| Get task | Get task model details |
| Get task list | Get task model list |
| Create task | Create task model |
| Delete task | Delete task model |
| Get task run | Get task model run details |
| Get task run list | Get task model run list |
| Create task run | Create task model run |
| Delete task run | Delete task model run |
| Get shopping intent | User Profiling > Get shopping intent details |
| Get shopping intent list | User Profiling > Get shopping intent list |
| Create shopping intent | User Profiling > Create shopping intent |
| Delete shopping intent | User Profiling > Delete shopping intent |
| Download shopping intent | User Profiling > Download shopping intent |
| Get custom attributes | User Profiling > Get custom attributes details |
| Get custom attributes list | User Profiling > Get custom attributes list |
| Create custom attributes | User Profiling > Create custom attributes |
| Delete custom attributes | User Profiling > Delete custom attributes |
NCLUE related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand NCLUE APIs.
- How to use NCLUE APIs
- Ncloud API overview: It describes how to issue and check access key and secret key issued by NAVER Cloud Platform and how to generate the signature required for request headers.
- Create Sub Account and manage authentication key: It describes how to issue and check access keys for sub accounts issued by NAVER Cloud Platform.
- API Gateway User Guide: It describes how to check the API key required for the request header.
- Common Ncloud response status codes: It describes the information on common response status codes of NAVER Cloud Platform.
- How to use NCLUE service
- Object Storage User Guide: To use NCLUE, you need to use a separate Object Storage. Object Storage is used to upload user behavior data and store NCLUE results.
- Sub Account User Guide: It describes how to use Sub Account that helps the management of NCLUE service operations.
Was this article helpful?