fyroxl / gpt-tokens

Calculate the token consumption and amount of openai gpt message

gpt-tokens

GPT tokens / price Calculate

Install

# npm or yarn

npm install gpt-tokens
yarn add gpt-tokens

Usage

import { GPTTokens } from 'gpt-tokens'

const usageInfo = new GPTTokens({
    model   : 'gpt-3.5-turbo-0613',
    messages: [
        {
            'role'   : 'system',
            'content': 'You are a helpful, pattern-following assistant that translates corporate jargon into plain English.',
        },
        {
            'role'   : 'system',
            'name'   : 'example_user',
            'content': 'New synergies will help drive top-line growth.',
        },
        {
            'role'   : 'system',
            'name'   : 'example_assistant',
            'content': 'Things working well together will increase revenue.',
        },
        {
            'role'   : 'system',
            'name'   : 'example_user',
            'content': 'Let\'s circle back when we have more bandwidth to touch base on opportunities for increased leverage.',
        },
        {
            'role'   : 'system',
            'name'   : 'example_assistant',
            'content': 'Let\'s talk later when we\'re less busy about how to do better.',
        },
        {
            'role'   : 'user',
            'content': 'This late pivot means we don\'t have time to boil the ocean for the client deliverable.',
        },
        {
            'role'   : 'assistant',
            'content': 'This last-minute change means we don\'t have enough time to complete the entire project for the client.',
        },
    ]
})

// ┌───────────────────┬────────┐
// │      (index)      │ Values │
// ├───────────────────┼────────┤
// │   Tokens prompt   │  129   │
// │ Tokens completion │   20   │
// │   Tokens total    │  149   │
// └───────────────────┴────────┘
console.table({
    'Tokens prompt'    : usageInfo.promptUsedTokens,
    'Tokens completion': usageInfo.completionUsedTokens,
    'Tokens total'     : usageInfo.usedTokens,
})

// Price USD:  0.000298
console.log('Price USD: ', usageInfo.usedUSD)

Tokens calculation rules for prompt and completion:

If the role of the last element of messages is not assistant, the entire messages will be regarded as a prompt, and all content will participate in the calculation of tokens

If the role of the last element of messages is assistant, the last message is regarded as the completion returned by openai, and only the 'content' content in the completion participates in the calculation of tokens

Verify the function above in openai-cookbook

Support Models

• gpt-3.5-turbo
• gpt-3.5-turbo-0301
• gpt-3.5-turbo-0613
• gpt-3.5-turbo-1106
• gpt-3.5-turbo-16k
• gpt-3.5-turbo-16k-0613
• gpt-4
• gpt-4-0314
• gpt-4-0613
• gpt-4-32k
• gpt-4-32k-0314
• gpt-4-32k-0613
• gpt-4-1106-preview

Test in your project

node test.js yourAPIKey

#    Testing GPT...
#    [1/13]: Testing gpt-3.5-turbo-0301...
#    Pass!
#    [2/13]: Testing gpt-3.5-turbo...
#    Warning: gpt-3.5-turbo may update over time. Returning num tokens assuming gpt-3.5-turbo-0613
#    Pass!
#    [3/13]: Testing gpt-3.5-turbo-0613...
#    Pass!
#    [4/13]: Testing gpt-3.5-turbo-16k...
#    Warning: gpt-3.5-turbo-16k may update over time. Returning num tokens assuming gpt-3.5-turbo-16k-0613
#    Pass!
#    [5/13]: Testing gpt-3.5-turbo-16k-0613...
#    Pass!
#    [6/13]: Testing gpt-3.5-turbo-1106...
#    Pass!
#    [7/13]: Testing gpt-4...
#    Warning: gpt-4 may update over time. Returning num tokens assuming gpt-4-0613
#    Pass!
#    [8/13]: Testing gpt-4-0314...
#    Pass!
#    [9/13]: Testing gpt-4-0613...
#    Pass!
#    [10/13]: Testing gpt-4-32k...
#    Ignore model gpt-4-32k: 404 The model `gpt-4-32k` does not exist or you do not have access to it. Learn more: https://help.openai.com/en/articles/7102672-how-can-i-access-gpt-4.
#    Warning: gpt-4-32k may update over time. Returning num tokens assuming gpt-4-32k-0613
#    [11/13]: Testing gpt-4-32k-0314...
#    Ignore model gpt-4-32k-0314: 404 The model `gpt-4-32k-0314` does not exist or you do not have access to it. Learn more: https://help.openai.com/en/articles/7102672-how-can-i-access-gpt-4.
#    [12/13]: Testing gpt-4-32k-0613...
#    Ignore model gpt-4-32k-0613: 404 The model `gpt-4-32k-0613` does not exist or you do not have access to it. Learn more: https://help.openai.com/en/articles/7102672-how-can-i-access-gpt-4.
#    [13/13]: Testing gpt-4-1106-preview...
#    Pass!
#    Test success!
#    Testing performance...
#    GPTTokens: 0.473ms
#    GPTTokens: 0.097ms
#    GPTTokens: 0.072ms
#    GPTTokens: 0.079ms
#    GPTTokens: 0.095ms
#    GPTTokens: 0.066ms
#    GPTTokens: 0.064ms
#    GPTTokens: 0.068ms
#    GPTTokens: 0.077ms
#    GPTTokens: 0.08ms

Dependencies

• js-tiktoken