MENU
      NCLUE overview

        NCLUE overview


        Article summary

        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
        HTTP

        Request headers

        The following describes the headers.

        FieldRequiredDescription
        X-NCP-APIGW-TIMESTAMPRequiredThis 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-KEYRequiredAccess key issued on NAVER Cloud Platform
        X-NCP-APIGW-SIGNATURE-V2RequiredBase64-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 codeCodeMessageDescription
        200-successSucceeded
        40110100ACCESS_DENIEDInvalid access
        42210101NAME_TOO_LONGNumber of characters allowed in name exceeded
        • Solution: Enter less than 40 characters and try again
        40910102DUPLICATE_NAMESame name exists
        42210103INVALID_PATH_CHARACTERThe file path contains an invalid special character
        42210104INVALID_CHARACTER_IN_TRAIN_PATHThe train correct answer data file path contains an invalid special character.
        42210105INVALID_CHARACTER_IN_TEST_PATHThe test correct answer data file path contains an invalid special character.
        40410106PATH_NOT_FOUNDThe data path or file does not exist
        40410107TRAIN_PATH_NOT_FOUNDThe train correct answer data path or file does not exist
        40410108TEST_PATH_NOT_FOUNDThe test correct answer data path or file does not exist
        42210109PERSONAL_DATA_NOT_ALLOWEDThe file contains personal information
        42210110PERSONAL_DATA_IN_TRAIN_FILEThe train correct answer data file contains personal information
        42210111PERSONAL_DATA_IN_TEST_FILEThe test correct answer data file contains personal information
        42210112TOO_MANY_KEYWORDSThe total string length of the inputable attribute keyword is exceeded
        • Solution: Enter the total string length within 1000 characters and try again
        40910113INCOMPATIBLE_MODELThe feature and the task are incompatible
        40910114FEATURE_PROCESSINGRequested job cannot be processed
        • Solution: If the status of the feature is pending or creating, retry after creation is complete
          40910115TASK_PROCESSINGRequested job cannot be processed
          • Solution: If the status of the task is pending or creating, retry after creation is complete
            40910116RUN_PROCESSINGRequested job cannot be processed
            • Solution: If the status of the run is pending or creating, retry after creation is complete
              40910117PROFILE_PROCESSINGRequested job cannot be processed
              • Solution: If the status of the profile is pending or creating, retry after creation is complete
                42210118KEYWORD_REQUIREDKeyword not entered
                42210119STORAGE_FULLInsufficient data storage space
                42210121EMPTY_CONTENT_IN_PATHThe correct answer data path or file is empty
                42210122EMPTY_CONTENT_IN_TRAIN_PATHThe train correct answer data path or file is empty
                42210123EMPTY_CONTENT_IN_TEST_PATHThe test correct answer data path or file is empty
                40410124PROFILE_NOT_FOUNDNo profile data exists
                42210130INVALID_RESULT_FILE_PATHAn abnormal file path is entered
                42210131OBJECT_STORAGE_ACCESS_DENIEDUnable to access the Object Storage bucket
                • Solution: Retry after granting access to the Object Storage bucket
                40410132OBJECT_STORAGE_ACCOUNT_REQUIREDNeed to subscribe to the Object Storage service
                42210133INVALID_LIMITNumber of characters allowed in limit exceeded
                • Solution: Enter between 1 to 100 characters and try again
                40910134FEATURE_IN_USEUnable to delete feature
                • Solution: Try again after completing the job being created with the feature
                40910135TASK_IN_USEUnable to delete task
                • Solution: Try again after completing the job being created with the task
                40410136BUCKET_NOT_FOUNDAn 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.

                APIDescription
                Get featureGet NCLUE feature details
                Get feature listGet NCLUE feature list
                Create featureCreate NCLUE feature using sequence dataset
                Delete featureDelete NCLUE feature
                Get taskGet task model details
                Get task listGet task model list
                Create taskCreate task model using correct answer dataset
                Delete taskDelete task model
                Get task runGet task model execution results
                Get task run listGet task model run list
                Create task runCreate run using user feature and task model
                Delete task runDelete task model run
                Get shopping intentGet profile details of shopping intent
                Get shopping intent listGet profile list of shopping intent
                Create shopping intentCreate profile of shopping intent
                Delete shopping intentDelete profile of shopping intent
                Download shopping intentDownload profile result of shopping intent
                Get custom attributesGet profile details of custom attributes
                Get custom attributes listGet profile list of custom attributes
                Create custom attributesCreate profile of custom attributes
                Delete custom attributesDelete profile of custom attributes

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


                Was this article helpful?

                Changing your password will log you out immediately. Use the new password to log back in.
                First name must have atleast 2 characters. Numbers and special characters are not allowed.
                Last name must have atleast 1 characters. Numbers and special characters are not allowed.
                Enter a valid email
                Enter a valid password
                Your profile has been successfully updated.