llm.ToolParameterType

Note:

The content in this help topic pertains to SuiteScript 2.1.

Enum Description	The data type for a tool parameter. Use this enum to set the value of the options.type parameter in llm.createToolParameter(options). Note: JavaScript does not include an enumeration type. The SuiteScript 2.x documentation uses the term enumeration (or enum) to describe a plain JavaScript object with a flat, map-like structure. In this object, each key points to a read-only string value.
Module	N/llm Module
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Since	2025.2

Values

Enum	Value
ToolParameterType.ARRAY	ARRAY
ToolParameterType.BOOLEAN	BOOLEAN
ToolParameterType.FLOAT	FLOAT
ToolParameterType.INTEGER	INTEGER
ToolParameterType.OBJECT	OBJECT
ToolParameterType.STRING	STRING

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 userNameParameter = llm.createToolParameter({
    name: "userName",
    description: "Name of the user",
    type: llm.ToolParameterType.STRING
});

...
// Add additional code 

          

General Notices