Usage.promptTokens

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description

The number of tokens in the request to the LLM.

This value includes the tokens for the prompt and any supporting content sent to the LLM, including the preamble (if supported) and provided documents.

Type

number

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/llm Module

Parent Object

llm.Usage

Sibling Object Members

Usage Object Members

Since

2025.1

Errors

Error Code

Thrown If

READ_ONLY

Setting the property is attempted.

Syntax

Important:

The following code sample shows the syntax for this member. It isn't a functional example. For a complete script example, see N/llm Module Script Samples.

            // Add additional code
...

const response = llm.generateText({
    prompt: "Write a 200 word pitch for a TV show about elephants."
});

const usagePromptTokens = response.usage.promptTokens;

...
// Add additional code 

          

General Notices