토큰 계산기(챗 v3)

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

Chat Completions v3를 통해 HCX 모델에 입력한 문장의 토큰 수를 계산합니다.

요청

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

요청 헤더

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

요청 경로 파라미터

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

요청 바디

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

ChatMessage

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

content

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

tools

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

toolCalls

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

요청 예시

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

이미지로 질의하는 경우

이미지로 질의하는 경우의 요청 예시는 다음과 같습니다.

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: {Request ID}' \
--header 'Content-Type: application/json' \
--data '{
        "messages": [
        {
    "messages": [
        {
            "role": "system",
            "content": "- 친절하게 답변하는 AI 어시스턴트입니다."
        },
        {
            "role": "user",
            "content": [
                {
                    "type": "image_url",
                    "imageUrl": [
                        {
                            "url": "https://www.******.com/image_a1b1c1.png"
                        }
                    ]
                },
                {
                    "type": "text",
                    "text": "이 사진에 대해서 설명해줘"
                }
            ]
        },
        {
            "role": "assistant",
            "content": "사진에는 어린 아이가 양에게 먹이를 주는 모습이 담겨 있습니다."
        }
    ]
}'

텍스트로 질의하는 경우

텍스트로 질의하는 경우의 요청 예시는 다음과 같습니다.

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: {Request ID}' \
--header 'Content-Type: application/json' \
--data '{
	"messages":[
		{
			"content":"내일 서울 날씨 어때?",
			"role":"user"
		}
	],
	"tools":[
		{
			"type":"function",
			"function":{
				"description":"날씨를 알려줄 수 있는 도구",
				"name":"weather",
				"parameters":{
					"properties":{
						"location":{
							"description":"서울, 대전, 부산 등의 도시 이름",
							"type":"string"
						},
						"unit":{
							"enum":[
								"celsius",
								"fahrenheit"
							],
							"type":"string"
						},
						"date":{
							"description":"2023-08-01 같은 형태의 날짜 문자열. 날씨를 알고 싶은 날짜",
							"type":"string"
						}
					},
					"required":[
						"location"
					],
					"type":"object"
				}
			}
		},
		{
			"type":"function",
			"function":{
				"description":"여행지를 추천해 줄 수 있는 도구",
				"name":"travel",
				"parameters":{
					"properties":{
						"location":{
							"description":"The city and state, e.g. San Francisco, CA",
							"type":"string"
						},
						"date":{
							"description":"\"2023-08-01~2023-09-01\" 같은 형태의 날짜 쌍 문자열. 여행 날짜 범위",
							"type":"string"
						}
					},
					"required":[
						"location"
					],
					"type":"object"
				}
			}
		}
	],
    "toolChoice":"auto"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

ChatMessageCount

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

ToolCount

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

응답 예시

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

성공

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

{
    "status": {
        "code": "20000",
        "message": "OK"
    },
    "result": {
        "messages": [
            {
                "role": "system",
                "content": {
                    "type": "text",
                    "text": "- 친절하게 답변하는 AI 어시스턴트입니다.",
                    "count": 16
                }
            },
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "imageUrl": {
                            "url": "https://www.******.com/image_a1b1c1.png"
                        },
                        "count": 1478
                    },
                    {
                        "type": "text",
                        "text": "이 사진에 대해서 설명해줘",
                        "count": 12
                    }
                ]
            },
            {
                "role": "assistant",
                "content": [
                    {
                        "type": "text",
                        "text": "사진에는 어린 아이가 양에게 먹이를 주는 모습이 담겨 있습니다.",
                        "count": 20
                    }
                ]
            }
        ]
    }
}

{
    "status": {
        "code": "20000",
        "message": "OK"
    },
    "result": {
        "messages": [
            {
                "role": "user",
                "content": [
                    {
                        "type": "text",
                        "text": "내일 서울 날씨 어때?",
                        "count": 12
                    }
                ]
            }
        ],
        "tools": {
            "count": 230
        }
    }
}

실패

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

• 클라이언트 공통 오류 문제(4xx)
• 서버 공통 오류 문제(5xx)