토큰 계산기(챗 v3)

Classic/VPC 환경에서 이용 가능합니다.

Chat Completions v3에서 사용한 문자열의 토큰 수를 계산합니다.

참고

해당 기능은 익스플로러에서 제공하지 않으며, API로만 지원합니다.
HCX-003, HCX-DASH-001 모델은 해당 API를 이용할 수 없습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/v3/api-tools/chat-tokenize/{modelName}

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

헤더	필수 여부	설명
`Authorization`	Required	인증을 위한 API 키 (예: `Bearer nv-***********`)
`X-NCP-CLOVASTUDIO-REQUEST-ID`	Optional	요청 ID
`Content-Type`	Required	요청 데이터의 형식 `application/json`

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`modelName`	String	Required	모델 이름

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`messages`	Object	Required	토큰 수를 계산할 대화 메시지 목록
`messages.role`	Enum	Required	대화 메시지의 역할 `system` \| `user` \| `assistant` `system`: 역할을 규정하는 지시문 `user`: 사용자의 발화 또는 질문 `assistant`: 모델의 답변
`messages.content`	String	Required	대화 메시지 내용

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://clovastudio.stream.gov-ntruss.com/v3/api-tools/chat-tokenize/{modelName}' \
--header 'Authorization: Bearer <API-KEY>' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: <X-NCP-CLOVASTUDIO-REQUEST-ID>' \
--header 'Content-Type: application/json' \
--data '{
    "messages": [
        {
            "role": "system",
            "content": "- HyperCLOVA X는 네이버클라우드의 하이퍼스케일 AI입니다."
        },
        {
            "role": "user",
            "content": "안녕하세요, 이름이 무엇입니까?"
        }       
    ]
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`status`	Object	-	응답 상태
`result`	Object	-	응답 결과
`result.messages`	Object	-	토큰 수 계산을 요청한 문자열과 계산된 토큰 수
`result.messages.role`	Enum	-	대화 메시지 역할 `system` \| `user` \| `assistant` `system`: 역할을 규정하는 지시문 `user`: 사용자의 발화 또는 질문 `assistant`: 모델의 답변
`result.messages.content`	Object	-	대화 메시지 내용
`result.messages.content.type`	Enum	-	입력된 Content 유형 text: 문자열
`result.messages.content.text`	String	-	토큰 수 계산을 요청한 문자열
`result.messages.content.count`	Integer	-	계산된 토큰 수

응답 예시

응답 예시는 다음과 같습니다.

성공

호출이 성공한 경우의 응답 예시는 다음과 같습니다.

{
    "status": {
        "code": "20000",
        "message": "OK"
    },
    "result": {
        "messages": [
            {
                "role": "system",
                "content": [
                    {
                        "type": "text",
                        "text": "- HyperCLOVA X는 네이버클라우드의 하이퍼스케일 AI입니다.",
                        "count": 59
                    }
                ]
            },
            {
                "role": "user",
                "content": [
                    {
                        "type": "text",
                        "text": "안녕하세요, 이름이 무엇입니까?",
                        "count": 15
                    }
                ]
            }
        ]
    }
}

실패

호출이 실패한 경우의 구문 예시는 다음과 같습니다.