NCLUE 개요
- 인쇄
- PDF
NCLUE 개요
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
NCLUE는 네이버의 대규모 언어 모델인 HyperCLOVA X에 기반한 NCLUE 모델을 활용하여 다양한 기계 학습 모델을 생성하고 여러 비즈니스 문제를 해결할 수 있도록 돕는 네이버 클라우드 플랫폼의 SaaS 서비스입니다. NCLUE 서비스에서는 Feature 생성, Task 모델의 생성 및 실행, 그리고 사용자 프로파일링 기능을 RESTful API로 제공합니다.
NCLUE 공통 설정
NCLUE API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.
요청
공통 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://nclue.apigw.ntruss.com
요청 헤더
헤더에 대한 설명은 다음과 같습니다.
| 필드 | 필수 여부 | 설명 |
|---|---|---|
X-NCP-APIGW-TIMESTAMP | Required | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간 (밀리초) |
X-NCP-IAM-ACCESS-KEY | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key |
X-NCP-APIGW-SIGNATURE-V2 | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 |
주의
NCLUE API의 초당 요청 수는 1 이하로 설정해 주십시오. (1 tps)
응답
공통 응답 형식을 설명합니다.
응답 상태 코드
응답 상태 코드에 대한 설명은 다음과 같습니다.
| HTTP 상태코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 200 | success | 성공 | |
| 401 | 10100 | ACCESS_DENIED | 잘못된 접근입니다. |
| 422 | 10101 | NAME_TOO_LONG | 40자 이내로 입력해주세요. |
| 409 | 10102 | DUPLICATE_NAME | 동일한 이름이 존재합니다. |
| 422 | 10103 | INVALID_PATH_CHARACTER | 파일 경로에 사용할 수 없는 특수문자가 포함되어 있습니다. |
| 422 | 10104 | INVALID_CHARACTER_IN_TRAIN_PATH | 파일 경로에 사용할 수 없는 특수문자가 포함되어 있습니다. |
| 422 | 10105 | INVALID_CHARACTER_IN_TEST_PATH | 파일 경로에 사용할 수 없는 특수문자가 포함되어 있습니다. |
| 404 | 10106 | PATH_NOT_FOUND | 해당 경로/파일이 존재하지 않습니다. |
| 404 | 10107 | TRAIN_PATH_NOT_FOUND | 해당 경로/파일이 존재하지 않습니다. |
| 404 | 10108 | TEST_PATH_NOT_FOUND | 해당 경로/파일이 존재하지 않습니다. |
| 422 | 10109 | PERSONAL_DATA_NOT_ALLOWED | 파일에 개인정보를 포함할 수 없습니다. |
| 422 | 10110 | PERSONAL_DATA_IN_TRAIN_FILE | 파일에 개인정보를 포함할 수 없습니다. |
| 422 | 10111 | PERSONAL_DATA_IN_TEST_FILE | 파일에 개인정보를 포함할 수 없습니다. |
| 422 | 10112 | TOO_MANY_KEYWORDS | 입력 가능한 속성 키워드 갯수를 초과하였습니다. |
| 409 | 10113 | INCOMPATIBLE_MODEL | Feature와 Task가 호환되지 않습니다. |
| 409 | 10114 | FEATURE_PROCESSING | 요청하신 작업을 처리할 수 없습니다. Feature가 대기 중이거나 생성 중인지 확인하세요. |
| 409 | 10115 | TASK_PROCESSING | 요청하신 작업을 처리할 수 없습니다. Task가 대기 중이거나 생성 중인지 확인하세요. |
| 409 | 10116 | RUN_PROCESSING | 요청하신 작업을 처리할 수 없습니다. Run이 대기 중이거나 생성 중인지 확인하세요. |
| 409 | 10117 | PROFILE_PROCESSING | 요청하신 작업을 처리할 수 없습니다. Profile이 대기 중이거나 생성 중인지 확인하세요. |
| 422 | 10118 | KEYWORD_REQUIRED | 키워드를 하나 이상 입력해주세요. |
| 422 | 10119 | STORAGE_FULL | 데이터 저장 공간이 부족합니다. |
| 422 | 10121 | EMPTY_CONTENT_IN_PATH | 빈 경로/파일입니다. |
| 422 | 10122 | EMPTY_CONTENT_IN_TRAIN_PATH | 빈 경로/파일입니다. |
| 422 | 10123 | EMPTY_CONTENT_IN_TEST_PATH | 빈 경로/파일입니다. |
| 404 | 10124 | PROFILE_NOT_FOUND | 프로파일 데이터가 없습니다. |
| 422 | 10130 | INVALID_RESULT_FILE_PATH | 파일 경로가 정상적으로 입력되지 않았습니다. 빈 이름의 폴더는 허용되지 않습니다. |
| 422 | 10131 | OBJECT_STORAGE_ACCESS_DENIED | Object Storage 버킷에 접근할 수 없습니다. 접근 권한을 확인해주세요. |
| 404 | 10132 | OBJECT_STORAGE_ACCOUNT_REQUIRED | Object Storage 서비스 이용 신청이 필요합니다. |
| 422 | 10133 | INVALID_LIMIT | limit는 1 이상 100 이하로만 가능합니다. |
| 409 | 10134 | FEATURE_IN_USE | 해당 Feature로 생성 중인 작업이 있어 삭제할 수 없습니다. |
| 409 | 10135 | TASK_IN_USE | 해당 Task로 생성 중인 작업이 있어 삭제할 수 없습니다. |
| 404 | 10136 | BUCKET_NOT_FOUND | 해당 Object Storage 버킷이 존재하지 않습니다. |
참고
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.
NCLUE API
NCLUE 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| Feature 조회 | NCLUE Feature 상세 정보 조회 |
| Feature 목록 조회 | NCLUE Feature 목록 조회 |
| Feature 생성 | NCLUE Feature 생성 |
| Feature 삭제 | NCLUE Feature 삭제 |
| Task 조회 | Task Model 상세 정보 조회 |
| Task 목록 조회 | Task Model 목록 조회 |
| Task 생성 | Task Model 생성 |
| Task 삭제 | Task Model 삭제 |
| Task Run 조회 | Task Model Run 상세 정보 조회 |
| Task Run 목록 조회 | Task Model Run 목록 조회 |
| Task Run 생성 | Task Model Run 생성 |
| Task Run 삭제 | Task Model Run 삭제 |
| Shopping Intent 조회 | User Profiling > Shopping Intent 상세 정보 조회 |
| Shopping Intent 목록 조회 | User Profiling > Shopping Intent 목록 조회 |
| Shopping Intent 생성 | User Profiling > Shopping Intent 생성 |
| Shopping Intent 삭제 | User Profiling > Shopping Intent 삭제 |
| Shopping Intent 다운로드 | User Profiling > Shopping Intent 다운로드 |
| Custom Attributes 조회 | User Profiling > Custom Attributes 상세 정보 조회 |
| Custom Attributes 목록 조회 | User Profiling > Custom Attributes 목록 조회 |
| Custom Attributes 생성 | User Profiling > Custom Attributes 생성 |
| Custom Attributes 삭제 | User Profiling > Custom Attributes 삭제 |
NCLUE 연관 리소스
NCLUE API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.
- NCLUE API 사용 방법
- Ncloud API 개요: 네이버 클라우드 플랫폼에서 발급받은 Access Key, Secret Key 발급 및 확인, 요청 헤더에 필요한 서명 생성 방법을 안내합니다.
- Sub Account 생성 및 인증키 관리: 네이버 클라우드 플랫폼에서 발급받은 서브 계정의 Access Key 발급 및 확인 방법을 설명합니다.
- API Gateway 사용 가이드: 요청 헤더에 필요한 API Key를 확인할 수 있습니다.
- Ncloud 공통 응답 상태 코드: 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보를 설명합니다.
- NCLUE 서비스 사용 방법
- Object Storage 사용 가이드: NCLUE를 사용하려면 별도의 Object Storage를 이용해야 합니다. Object Storage는 사용자 행동 데이터를 업로드하고, NCLUE 결과물을 저장하는 데 사용합니다.
- Sub Account 사용 가이드: NCLUE 서비스 운영 관리를 도와주는 Sub Account 사용 방법입니다.
이 문서가 도움이 되었습니까?