llm.ToolParameter

Note:

The content in this help topic pertains to SuiteScript 2.1.

Object Description

A tool parameter returned from llm.createToolParameter(options).

This object represents a single input parameter for a tool. Tool parameters inform the LLM about the expected inputs required when calling a tool during an LLM interaction. These parameters help the LLM understand how to call the tool accurately and ensure that tool calls include all necessary and correctly typed data for the tool handler logic.

You create this object using the llm.createToolParameter(options) method. This object includes properties for the tool parameter name (ToolParameter.name), tool parameter description (ToolParameter.description), and tool parameter type (ToolParameter.type). When you call llm.createTool(options), you can use the options.parameters parameter to provide a set of parameters for the tool.

Supported Script Types

Server scripts

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

Module

N/llm Module

Methods and Properties

ToolParameter Object Members

Since

2025.2

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

Syntax

Related Topics