- 인쇄
- PDF
CLOVA Studio 개요
- 인쇄
- PDF
Classic/VPC 환경에서 이용 가능합니다.
CLOVA Studio 서비스는 초대규모(Hyperscale) AI 기술인 HyperCLOVA X 언어 모델을 활용하여 사용자가 입력한 내용에 따라 AI 기술을 통해 생성된 문구를 출력하는 네이버 클라우드 플랫폼의 서비스입니다.
CLOVA Studio API
CLOVA Studio에서 제공하는 API는 다음과 같습니다.
API | 설명 |
---|---|
Chat Completions | HyperCLOVA X 모델을 활용한 대화형 문장 생성 |
학습 조회 | 학습 현황 조회 |
학습 목록 조회 | 생성한 학습 목록 조회 |
학습 생성 | 사용자의 데이터셋을 사용한 학습 생성 |
학습 삭제 | 생성한 학습 삭제 |
토큰 계산기(HCX) | HCX 모델에서 입력한 문장의 토큰 수 계산 |
토큰 계산기(임베딩v2) | 임베딩 v2에서 입력한 문장의 토큰 수 계산 |
슬라이딩 윈도우 | Chat Completions 이용 시 최대 토큰 수를 초과하는 문장 처리 |
문단 나누기 | 문장 간 유사도를 파악하여 주제 단위로 글의 단락 구분 |
요약 | 다양한 옵션을 적용하여 긴 문장 요약 |
임베딩 v2 | 장문 텍스트를 숫자로 표현하는 벡터화 작업 수행 |
스킬셋 답변 생성 | 스킬셋 API 호출로 답변 생성 |
API 키
CLOVA Studio API는 권한을 가진 사용자만 호출할 수 있도록 사용자 식별 도구인 API 키를 계정별로 발급하고 있습니다. 이는 API 호출 시 인증 정보로 전달하는 요청 헤더상의 파라미터로 사용합니다. 따라서 CLOVA Studio API를 사용하려면 우선 API 키를 발급받아야 합니다.
API 키 발급
API 키 발급과 관리는 CLOVA Studio의 API 키 화면에서 진행합니다. 방법은 다음과 같습니다.
- CLOVA Studio에 접속해 주십시오.
- 프로필 > API 키 메뉴를 차례대로 클릭해 주십시오.
- API 키에서 생성하고자 하는 API 키 종류에 해당하는 탭 선택 후, 우측 상단의 버튼을 클릭해주세요.
- 테스트 API 키: 테스트 탭 선택 > 테스트 API 키 발급
- 서비스 앱을 제외한 CLOVA Studio API 호출 시 이용 가능
- 서비스 API 키: 서비스 탭 선택 > 서비스 API 키 발급
- 서비스 앱을 포함한 모든 CLOVA Studio API 호출 시 이용 가능
- 테스트 API 키: 테스트 탭 선택 > 테스트 API 키 발급
- API 키 발급 팝업에서 발급 버튼을 클릭하여 API 키를 확인해주세요.
- 발급받은 API 키를 복사하여 별도의 안전한 공간에 보관하여 이용해주세요.
주의- API 키 복사 팝업을 닫은 후엔 해당 API 키를 다시는 확인하지 못하므로 반드시 발급 시점에 별도의 안전한 공간에 보관하여 이용해주시기 바랍니다.
- 이후 발급받은 API 키를 이용하여 CLOVA Studio API를 호출해주세요.
- CLOVA Studio API 키는 네이버 클라우드 플랫폼 계정 (Main Account) 기준 테스트, 서비스 각각 최대 10개까지 생성 가능합니다.
API 보안 설정
API 키가 제3자에게 유출되는 경우, CLOVA Studio 리소스를 임의로 이용하는 등의 보안 문제가 발생할 수 있으므로 적절한 사전 대비와 대응이 필요합니다.
API 키 삭제 및 재발급
API 키를 사용하지 않거나 도용이 의심된다면 발급한 API 키를 삭제해 주십시오. 방법은 다음과 같습니다.
- CLOVA Studio에 접속해 주십시오.
- 프로필 > API 키 메뉴를 차례대로 클릭해 주십시오.
- 삭제하고자 하는 API 키 종류에 해당하는 탭 선택 후, 삭제하고자 하는 API 키 항목 우측의 > 삭제 메뉴를 클릭해주세요.
- API 키를 삭제하면 유효하지 않은 키로 인식되어 더 이상 인증에 사용할 수 없습니다.
공통 설정
CLOVA Studio API에서 공통으로 사용하는 형식 및 설정을 설명합니다.
테스트 앱 생성
필요에 따라 CLOVA Studio API를 사용하기 위해 테스트 앱 또는 서비스 앱을 생성해야 할 수 있습니다. 자세한 내용은 CLOVA Studio 사용 가이드를 참조해 주십시오.
요청
CLOVA Studio API에서 공통으로 사용하는 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://clovastudio.stream.gov-ntruss.com/
요청 헤더
요청 헤더에 대한 설명은 다음과 같습니다.
필드 | 필수 여부 | 설명 (예시) |
---|---|---|
Authorization | Required | 인증을 위한 API 키 (예: Bearer nv-********** ) |
Content-Type | Required | application/json |
응답
CLOVA Studio API에서 공통으로 사용하는 응답 형식을 설명하고 구문 예시를 안내합니다.
바디
바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
status | object | - | 응답 상태 |
status.code | string | - | 응답 상태 코드 |
status.message | string | - | 응답 메시지 |
result | any | - | 응답 결과 |
- 응답 상태 코드별 원인 및 해결 방법은 CLOVA Studio 문제 해결을 참조해 주십시오.
- 네이버 클라우드 플랫폼 공통 상태 코드는 NAVER 연동 API를 확인해 주십시오.
구문
공통 응답 구문 예시를 안내합니다.
- 성공
{ "status": { "code": "20000", "message": "OK" }, "result": {} }
- 실패(클라이언트 오류)
{ "status": { "code": "40102", "message": "Invalid access token" } }
- 실패(서버 오류)
{ "status": { "code": "50000", "message": "Internal Server Error" } }