Classic/VPC環境で利用できます。
HCXモデルで入力した文章のトークン数を計算します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /v1/api-tools/chat-tokenize/{modelName} |
リクエストヘッダ
リクエストヘッダの説明は次の通りです。
| ヘッダ | 必須の有無 | 説明 |
|---|---|---|
Authorization |
Required | 認証用 APIキー<例> Bearer nv-************ |
X-NCP-CLOVASTUDIO-REQUEST-ID |
Optional | リクエスト ID |
Content-Type |
Required | リクエストデータの形式
|
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
modelName |
String | Required | モデル名
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
messages |
Array | Required | トークン数を計算する会話メッセージリスト |
messages.role |
Enum | Required | 会話メッセージのロール
|
messages.content |
String | Required | 会話メッセージの内容 |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://clovastudio.stream.ntruss.com/v1/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": [
{
"role": "system",
"content": "- HyperCLOVA Xは NAVERのハイパースケール AIです。"
},
{
"role": "user",
"content": "こんにちは。お名前は何ですか?"
},
{
"role": "assistant",
"content": "私は HyperCLOVA Xです。"
}
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
messages |
Array | - | トークン数が計算されたリクエスト会話メッセージリスト |
messages.role |
Enum | - | 会話メッセージのロール
|
messages.content |
String | - | 会話メッセージの内容 |
messages.count |
Integer | - | 会話メッセージトークン数の計算結果 |
レスポンス例
レスポンスのサンプルコードは次の通りです。
成功
呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"messages": [
{
"role": "system",
"content": "- HyperCLOVA Xは NAVERのハイパースケール AIです。",
"count": 15
},
{
"role": "user",
"content": "こんにちは。お名前は何ですか?",
"count": 10
},
{
"role": "assistant",
"content": "私は HyperCLOVA Xです。",
"count": 9
}
]
}
}
失敗
呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。