トークン計算機(チャット v3)

Classic/VPC環境で利用できます。

Chat Completions V3で HCXモデルに入力した文章のトークン数を計算します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

リクエストボディ

リクエストボディの説明は次の通りです。

ChatMessage

ChatMessageの説明は次の通りです。

content

contentの説明は次の通りです。

tools

toolsの説明は次の通りです。

toolCalls

toolCallsの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

画像でクエリする場合

画像でクエリする場合のリクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://clovastudio.stream.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.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)