トークン計算機(HCX)
    • PDF

    トークン計算機(HCX)

    • PDF

    記事の要約

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

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

    リクエスト

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

    メソッドURI
    POST/v1/api-tools/chat-tokenize/{modelName}

    リクエストヘッダ

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

    ヘッダ必須の有無説明
    X-NCP-CLOVASTUDIO-API-KEYRequiredテストアプリやサービスアプリの作成時に発行された API Key
    X-NCP-APIGW-API-KEYRequiredテストアプリやサービスアプリの作成時に発行された API Gateway Key
    X-NCP-CLOVASTUDIO-REQUEST-IDOptionalリクエスト ID
    Content-TypeRequiredリクエストデータの形式
    • application/json

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

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

    フィールドタイプ必須の有無説明
    modelNameStringRequiredモデル名
    • <例> HCX-003

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    messagesArrayRequiredトークン数を計算する会話メッセージリスト
    messages.roleEnumRequired会話メッセージのロール
    • system | user | assistant
      • system: ロールを規定する指示文
      • user: ユーザーの発話または質問
      • assistant: モデルの返答
    messages.contentStringRequired会話メッセージの内容

    リクエスト例

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

    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は NAVERのハイパースケール AIです。"
            },
            {
                "role": "user",
                "content": "こんにちは。お名前は何ですか?"
            },
            {
                "role": "assistant",
                "content": "私は HyperCLOVA Xです。"
            }
        ]
    }'
    

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    messagesArray-トークン数が計算されたリクエスト会話メッセージリスト
    messages.roleEnum-会話メッセージのロール
    • system | user | assistant
      • system: ロールを規定する指示文
      • user: ユーザーの発話または質問
      • assistant: モデルの返答
    messages.contentString-会話メッセージの内容
    messages.countInteger-会話メッセージトークン数の計算結果

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    成功

    呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。

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

    失敗

    呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。


    この記事は役に立ちましたか?

    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.