토큰 계산기(HCX)

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

HCX 모델에서 입력한 문장의 토큰 수를 계산합니다.

요청

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

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

요청 헤더

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

헤더	필수 여부	설명
`X-NCP-CLOVASTUDIO-API-KEY`	Required	테스트 앱이나 서비스 앱 생성 시 발급받은 API Key
`X-NCP-APIGW-API-KEY`	Required	테스트 앱이나 서비스 앱 생성 시 발급받은 API Gateway Key
`X-NCP-CLOVASTUDIO-REQUEST-ID`	Optional	요청 ID
`Content-Type`	Required	요청 데이터의 형식 `application/json`

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`modelName`	String	Required	모델 이름 <예시> HCX-003

요청 바디

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

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

요청 예시

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

curl --location --request POST 'https://clovastudio.apigw.ntruss.com/v1/api-tools/chat-tokenize/{modelName}' \
--header 'X-NCP-CLOVASTUDIO-API-KEY: {CLOVA Studio API Key}' \
--header 'X-NCP-APIGW-API-KEY: {API Gateway API Key}' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}' \
--header 'Content-Type: application/json' \
--data '{
        "messages": [
        {
            "role": "system",
            "content": "- HyperCLOVA X는 네이버의 하이퍼스케일 AI입니다."
        },
        {
            "role": "user",
            "content": "안녕하세요, 이름이 무엇입니까?"
        },
        {
            "role": "assistant",
            "content": "저는 HyperCLOVA X입니다."
        }
    ]
}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

응답 예시

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

성공

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

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

실패

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

이 문서가 도움이 되었습니까?

What's Next

토큰 계산기(임베딩 v2)

요청
응답