llm.getRemainingFreeEmbedUsage()

Note:

The content in this help topic pertains to SuiteScript 2.1.

Method Description

Returns the number of free embeddings requests in the current month.

This method tracks free requests for embed API calls, such as llm.embed(options). To track free requests for non-embed API calls (such as llm.generateText(options)), use llm.getRemainingFreeUsage() instead.

Returns

number

Supported Script Types

Server scripts

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

Governance

None

Module

N/llm Module

Since

2025.1

Syntax

Important:

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

            // Add additional code
...

const embedUsage = llm.getRemainingFreeEmbedUsage();

...
// Add additional code

Syntax

Related Topics