View SuiteScript AI Usage Limit and Usage

SuiteScript modules that use AI include a pool of limited, free usage. The free usage pool is renewed each month. The usage table on the SuiteScript subtab of the AI Preferences page shows how much is available for the account. If you want to verify the amount of free usage available when running SuiteScript code, your code can use these methods:

If your company wants unlimited usage, you'll need to set up an Oracle Cloud account with Oracle Generative AI service (for N/llm) or Oracle Cloud Infrastructure Document Understanding service (for N/documentCapture) or both. For more information about setting up the unlimited usage option, see Configure OCI Credentials for AI and Manage SuiteScript AI Preferences.

To view SuiteScript AI usage limit and usage for an account:

  1. Go to Setup > Company > AI > AI Preferences.

  2. From the AI Preferences page, click the SuiteScript subtab.

  3. Find the usage table. It shows the following information:

    • Month: Usage month and year.

    • Usage Limit: Number of free uses of the SuiteScript modules that use AI that are available for the account each month.

    • Used Quantity: Number of successful uses by SuiteScript modules that use AI during the month. All successfully completed actions count, but unsuccessful attempts don't.

    • Type: Represents the type of SuiteScript usage. Each type is counted separately and has its own free usage quota. If you use more than one type during the month, each one is shown as a separate row in the table.

      Usage types are:

      • Embed: Conversion of text to vector embeddings (N/llm module, embedding support methods).

      • Generate: Text generation by large language models (N/llm module, generative AI methods).

      • Document Capture: Extraction of structured content and key information from a variety of document types (N/documentCapture module methods).

    Note:

    The usage table won't show any data until your SuiteScript code successfully uses AI. A successful use is when your code sends a request using one of the SuiteScript modules that support AI and receives a successful response. (Error responses don't count.) Before your SuiteScript code uses AI successfully, the usage table shows the message "No records to show." If your code doesn't consume any usage during a month, that month won't be shown in the table.

Related Topics

General Notices