토큰 계산기(HCX)
    • PDF

    토큰 계산기(HCX)

    • PDF

    기사 요약

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

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

    요청

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

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

    요청 헤더

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

    헤더필수 여부설명
    AuthorizationRequired인증을 위한 API 키 (예: Bearer nv-***********)
    Content-TypeRequiredapplication/json
    X-NCP-CLOVASTUDIO-REQUEST-IDOptional각 요청에 대한 요청 아이디

    요청 경로 파라미터

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

    필드타입필수 여부설명
    modelNamestringY사용할 모델 이름 <예시> HCX-003

    요청 바디

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

    필드타입필수 여부설명
    messagesarray[ChatMessage]Y토큰 수를 계산할 요청 대화 메시지 목록
    ChatMessage.rolestring (enum)Y대화 메시지 역할
  • system: 역할을 규정하는 지시문
  • user: 사용자의 발화/질문
  • assistant: 사용자의 발화/질문에 대한 답변
  • ChatMessage.contentstringY대화 메시지 내용

    요청 구문

    구문 예시는 다음과 같습니다.

    curl --location --request POST 'https://clovastudio.stream.gov-ntruss.com/v1/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": "안녕하세요, 이름이 무엇입니까?"
            },
            {
                "role": "assistant",
                "content": "저는 HyperCLOVA X 입니다."
            }
        ]
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드타입필수 여부설명
    messagesarray[ChatMessage]Y토큰 수가 계산된 요청 대화 메시지 목록
    ChatMessage.rolestring (enum)Y대화 메시지 역할
  • system: 역할을 규정하는 지시문
  • user: 사용자의 발화/질문
  • assistant: 사용자의 발화/질문에 대한 답변
  • ChatMessage.contentstringY대화 메시지 내용
    ChatMessage.countintegerY대화 메시지의 토큰 수 계산 결과

    응답 구문

    구문 예시는 다음과 같습니다.

    성공

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

    {
        "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
            }
          ]
        }
      }
    

    실패

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


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

    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.