NCLUE overview

Prev Next

Available in 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 X, 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/api/v1

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.
  • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes.
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 tps or less.

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 Number of characters allowed in name exceeded
  • Solution: Enter less than 100 characters and try again.
409 10102 DUPLICATE_NAME Same name exists.
422 10103 INVALID_PATH_CHARACTER The file path contains an invalid special character.
422 10104 INVALID_CHARACTER_IN_TRAIN_PATH The train correct answer data file path contains an invalid special character.
422 10105 INVALID_CHARACTER_IN_TEST_PATH The test correct answer data file path contains an invalid special character.
404 10106 PATH_NOT_FOUND The data path or file does not exist.
404 10107 TRAIN_PATH_NOT_FOUND The train correct answer data path or file does not exist.
404 10108 TEST_PATH_NOT_FOUND The test correct answer data path or file does not exist.
422 10109 PERSONAL_DATA_NOT_ALLOWED The file contains personal information.
422 10110 PERSONAL_DATA_IN_TRAIN_FILE The train correct answer data file contains personal information.
422 10111 PERSONAL_DATA_IN_TEST_FILE The test correct answer data file contains personal information.
422 10112 TOO_MANY_KEYWORDS The total string length of the inputable attribute keyword is exceeded.
  • Solution: Enter the total string length within 1000 characters and try again.
409 10113 INCOMPATIBLE_MODEL The feature and the task are incompatible.
409 10114 FEATURE_PROCESSING Requested job cannot be processed.
  • Solution: If the status of the feature is pending or creating, retry after creation is complete.
    409 10115 TASK_PROCESSING Requested job cannot be processed.
    • Solution: If the status of the task is pending or creating, retry after creation is complete.
      409 10116 RUN_PROCESSING Requested job cannot be processed.
      • Solution: If the status of the run is pending or creating, retry after creation is complete.
        409 10117 PROFILE_PROCESSING Requested job cannot be processed.
        • Solution: If the status of the profile is pending or creating, retry after creation is complete.
          422 10118 KEYWORD_REQUIRED Keyword not entered
          422 10119 STORAGE_FULL Insufficient data storage space
          422 10121 EMPTY_CONTENT_IN_PATH The correct answer data path or file is empty.
          422 10122 EMPTY_CONTENT_IN_TRAIN_PATH The train correct answer data path or file is empty.
          422 10123 EMPTY_CONTENT_IN_TEST_PATH The test correct answer data path or file is empty.
          404 10124 PROFILE_NOT_FOUND No profile data exists.
          422 10130 INVALID_RESULT_FILE_PATH An abnormal file path is entered.
          422 10131 OBJECT_STORAGE_ACCESS_DENIED Unable to access the Object Storage bucket
          • Solution: Retry after granting access to the Object Storage bucket.
          404 10132 OBJECT_STORAGE_ACCOUNT_REQUIRED Need to subscribe to the Object Storage service.
          422 10133 INVALID_LIMIT Number of characters allowed in limit exceeded.
          • Solution: Enter between 1 to 100 characters and try again.
          409 10134 FEATURE_IN_USE Unable to delete feature
          • Solution: Try again after completing the job being created with the feature.
          409 10135 TASK_IN_USE Unable to delete task
          • Solution: Try again after completing the job being created with the task.
          404 10136 BUCKET_NOT_FOUND An Object Storage bucket name that does not exist is entered.
          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 using sequence dataset.
          Delete feature Delete NCLUE feature.
          Get task Get task model details.
          Get task list Get task model list.
          Create task Create task model using correct answer dataset.
          Delete task Delete task model.
          Get task run Get task model execution results.
          Get task run list Get task model run list.
          Create task run Create run using user feature and task model.
          Delete task run Delete task model run.
          Get shopping intent Get profile details of shopping intent.
          Get shopping intent list Get profile list of shopping intent.
          Create shopping intent Create profile of shopping intent.
          Delete shopping intent Delete profile of shopping intent.
          Download shopping intent Download profile result of shopping intent.
          Get custom attributes Get profile details of custom attributes.
          Get custom attributes list Get profile list of custom attributes.
          Create custom attributes Create profile of custom attributes.
          Delete custom attributes Delete profile of custom attributes.

          NCLUE related resources

          NAVER Cloud Platform provides a variety of related resources to help users better understand NCLUE APIs.