N/llm Module

Note:

The content in this help topic pertains to SuiteScript 2.1.

The N/llm module supports generative artificial intelligence (AI) capabilities in SuiteScript. You can use this module to send requests to the large language models (LLMs) supported by NetSuite and receive responses to use in your scripts.

N/llm Module Script Samples

If you're new to using generative AI in SuiteScript, see SuiteScript 2.x Generative AI APIs. That topic contains essential information about this feature.

The following list summarizes the main features that are available using the N/llm module:

• Content generation - You can request generative AI content from a supported LLM using llm.generateText(options). You can provide a prompt that describes the content you want to generate, and the module sends the request to the Oracle Cloud Infrastructure (OCI) Generative AI service to generate a response.

• Prompt evaluation - If you use Prompt Studio to manage existing prompts in your NetSuite account, you can use llm.evaluatePrompt(options) to send a prompt from Prompt Studio to the LLM for evaluation. This method uses the information from the prompt definition in Prompt Studio (such as the model and model parameters), and it lets you provide values for any variables the prompt uses before sending it for evaluation. For more information about Prompt Studio, see Prompt Studio.

• Prompt and Text Enhance action management - By using the N/record module, you can create, update, and delete prompts and Text Enhance actions in your scripts. For more information, see Managing Prompts and Text Enhance Actions Using the N/llm Module.

• Retrieval-augmented generation (RAG) support - You can give source documents to the LLM when calling llm.generateText(options). The LLM uses information from the source documents to augment its response. The LLM also returns citations that identify which source documents it used. For an example of how to implement a RAG use case using the N/llm module, see Provide Source Documents When Calling the LLM.

• Embedding support - The llm.embed(options) method converts text to vector embeddings. Your SuiteScript applications can use vector embeddings for use cases such as semantic searches, recommender systems, text classification, or text clustering. For an example of how to generate and use embeddings, see Find Similar Items Using Embeddings. For more information about embedding models, refer to Offered Pretrained Foundational Models in Generative AI in the Oracle Cloud Infrastructure Documentation.

  Embedding methods have their own monthly free usage quota, separate from generate methods. If you use both in a month, you'll see two rows for the month, labeled by usage type. For more information, see View SuiteScript AI Usage Limit and Usage.

• Streaming support - Using the llm.generateTextStreamed(options) and llm.evaluatePromptStreamed(options) methods, your code gets content as the LLM generates it, instead of waiting to receive it all at the same time. For an example of how to work with streamed content, see Receive a Partial Response from the LLM.

• Tooling support - You can define custom tools using llm.createTool(options) that let you extend and enhance LLM interactions. Tools can run business-specific logic in your scripts (such as SuiteQL queries), receive inputs from the LLM, and return structured outputs. The LLM can request tool calls as needed and integrate tool results into its generated responses, which can provide richer and more dynamic responses.

  For more information, see Tooling in the N/llm Module. For an example of how to create tools and provide them to the LLM, see Use Tools to Enhance the Response from the LLM.

• Method aliases - You can use the following aliases in your code instead of the method names:

  • llm.chat(options) is an alias for llm.generateText(options).

  • llm.executePrompt(options) is an alias for llm.evaluatePrompt(options).

  • llm.chatStreamed(options) is an alias for llm.generateTextStreamed(options).

  • llm.executePromptStreamed(options) is an alias for llm.evaluatePromptStreamed(options).

  Promise versions are also available for these methods.

  When aliases are available for methods, you'll see them listed in the main table of the method's help topic. For an example, see llm.generateTextStreamed(options).

This module is available in NetSuite by default when the Server SuiteScript feature is enabled. For more information, see Enabling Features.

Important:

As you work with this module, keep the following considerations in mind:

• Generative AI features, such as the N/llm module, use creativity in their responses. Make sure you validate the AI-generated responses for accuracy and quality. Oracle NetSuite isn't responsible or liable for the use or interpretation of AI-generated content.

• SuiteScript Generative AI APIs (N/llm module) are available only for accounts located in certain regions. For a list of these regions, see Generative AI Feature Availability in NetSuite.

In This Help Topic

• N/llm Module Members

• ChatMessage Object Members

• Citation Object Members

• Document Object Members

• EmbedResponse Object Members

• Response Object Members

• StreamedResponse Object Members

• Tool Object Members

• ToolCall Object Members

• ToolParameter Object Members

• ToolResult Object Members

• Usage Object Members

N/llm Module Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Object	llm.ChatMessage	Object	Server scripts	The chat message.
	llm.Citation	Object	Server scripts	A citation returned from the LLM.
	llm.Document	Object	Server scripts	A document to be used as source content when calling the LLM.
	llm.EmbedResponse	Object	Server scripts	The embeddings response returned from the LLM.
	llm.Response	Object	Server scripts	The response returned from the LLM.
	llm.StreamedResponse	Object	Server scripts	The streamed response returned from the LLM.
	llm.Tool	Object	Server scripts	A tool the LLM can request.
	llm.ToolCall	Object	Server scripts	A tool call request from the LLM.
	llm.ToolParameter	Object	Server scripts	A parameter for a tool.
	llm.ToolResult	Object	Server scripts	A tool result to send back to the LLM.
Method	llm.createChatMessage(options)	llm.ChatMessage	Server scripts	Creates a chat message based on a specified role and text.
	llm.createDocument(options)	llm.Document	Server scripts	Creates a document to be used as source content when calling the LLM.
	llm.createTool(options)	llm.Tool	Server scripts	Creates a tool the LLM can request.
	llm.createToolParameter(options)	llm.ToolParameter	Server scripts	Creates a tool parameter for a tool.
	llm.createToolResult(options)	llm.ToolResult	Server scripts	Creates a tool result to send back to the LLM.
	llm.embed(options)	llm.EmbedResponse	Server scripts	Returns the embeddings from the LLM for a given input.
	llm.embed.promise(options)	Promise	Server scripts	Asynchronously returns the embeddings from the LLM for a given input.
	llm.evaluatePrompt(options)	llm.Response	Server scripts	Takes the ID of an existing prompt and values for variables used in the prompt and returns the response from the LLM. When you're using unlimited usage mode, this method also accepts the OCI configuration parameters.
	llm.evaluatePrompt.promise(options)	Promise	Server scripts	Takes the ID of an existing prompt and values for variables used in the prompt and asynchronously returns the response from the LLM. When you're using unlimited usage mode, this method also accepts the OCI configuration parameters.
	llm.evaluatePromptStreamed(options)	llm.StreamedResponse	Server scripts	Takes the ID of an existing prompt and values for variables used in the prompt and returns the streamed response from the LLM. When you're using unlimited usage mode, this method also accepts the OCI configuration parameters.
	llm.evaluatePromptStreamed.promise(options)	Promise	Server scripts	Takes the ID of an existing prompt and values for variables used in the prompt and asynchronously returns the streamed response from the LLM. When you're using unlimited usage mode, this method also accepts the OCI configuration parameters.
	llm.generateText(options)	llm.Response	Server scripts	Takes a prompt and parameters for the LLM and returns the response from the LLM. When you're using unlimited usage mode, this method also accepts the OCI configuration parameters.
	llm.generateText.promise(options)	Promise	Server scripts	Takes a prompt and parameters for the LLM and asynchronously returns the response from the LLM. When you're using unlimited usage mode, this method also accepts the OCI configuration parameters.
	llm.generateTextStreamed(options)	llm.StreamedResponse	Server scripts	Takes a prompt and parameters for the LLM and returns the streamed response from the LLM. When you're using unlimited usage mode, this method also accepts the OCI configuration parameters.
	llm.generateTextStreamed.promise(options)	Promise	Server scripts	Takes a prompt and parameters for the LLM and asynchronously returns the streamed response from the LLM. When you're using unlimited usage mode, this method also accepts the OCI configuration parameters.
	llm.getRemainingFreeUsage()	number	Server scripts	Returns the number of free requests in the current month.
	llm.getRemainingFreeUsage.promise()	Promise	Server scripts	Asynchronously returns the number of free requests in the current month.
	llm.getRemainingFreeEmbedUsage()	number	Server scripts	Returns the number of free embeddings requests in the current month.
	llm.getRemainingFreeEmbedUsage.promise()	Promise	Server scripts	Asynchronously returns the number of free embeddings requests in the current month.
Enum	llm.ChatRole	enum	Server scripts	Holds the string values for the author (role) of a chat message. Use this enum to set the value of the options.role parameter in llm.createChatMessage(options).
	llm.EmbedModelFamily	enum	Server scripts	Holds the string values for the large language model to be used to generate embeddings. Use this enum to set the value of the options.embedModelFamily parameter in llm.embed(options).
	llm.ModelFamily	enum	Server scripts	Holds the string values for the large language model to be used. Use this enum to set the value of the options.model parameter in llm.generateText(options).
	llm.SafetyMode	enum	Server scripts	Holds the string values for the safety mode to be used for LLM requests. Use this enum to set the value of the options.safetyMode parameter in llm.generateText(options) and llm.generateTextStreamed(options).
	llm.ToolParameterType	enum	Server scripts	Holds the data type for a tool parameter. Use this enum to set the value of the options.type parameter in llm.createToolParameter(options).
	llm.Truncate	enum	Server scripts	Holds the string values for the truncation method to use when embeddings input exceeds 512 tokens. Use this enum to set the value of the options.truncate parameter in llm.embed(options).

ChatMessage Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	ChatMessage.role	string	Server scripts	The author (role) of the chat message.
	ChatMessage.text	string	Server scripts	Text of the chat message. This text can be either the prompt sent by the script or the response returned by the LLM.

Citation Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Citation.documentIds	string[]	Server scripts	The IDs of the documents where the cited text is located.
	Citation.end	number	Server scripts	The ending position of the cited text.
	Citation.start	number	Server scripts	The starting position of the cited text.
	Citation.text	string	Server scripts	The cited text from the documents.

Document Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Document.data	string	Server scripts	The content of the document.
	Document.id	string	Server scripts	The ID of the document.

EmbedResponse Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	EmbedResponse.embeddings	number[]	Server scripts	The embeddings returned from the LLM.
	EmbedResponse.inputs	string[]	Server scripts	The list of inputs used to generate the embeddings response.
	EmbedResponse.model	string	Server scripts	The model used to generate the embeddings response.

Response Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Response.chatHistory	llm.ChatMessage[]	Server scripts	List of chat messages.
	Response.citations	llm.Citation[]	Server scripts	List of citations used to generate the response.
	Response.documents	llm.Document[]	Server scripts	List of documents used to generate the response.
	Response.model	string	Server scripts	Model used to produce the LLM response.
	Response.text	string	Server scripts	Text returned by the LLM.
	Response.toolCalls	llm.ToolCall[]	Server scripts	Tool calls requested by the LLM.
	Response.usage	llm.Usage	Server scripts	Token usage for a request to the LLM.

StreamedResponse Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	StreamedResponse.chatHistory	llm.ChatMessage[]	Server scripts	List of chat messages.
	StreamedResponse.citations	llm.Citation[]	Server scripts	List of citations used to generate the streamed response.
	StreamedResponse.documents	llm.Document[]	Server scripts	List of documents used to generate the streamed response.
	StreamedResponse.model	string	Server scripts	Model used to produce the streamed response.
	StreamedResponse.text	string	Server scripts	Text returned by the LLM.
	StreamedResponse.toolCalls	llm.ToolCall[]	Server scripts	Tool calls requested by the LLM.

Tool Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Tool.description	string	Server scripts	The description of the tool.
	Tool.name	string	Server scripts	The name of the tool.
	Tool.parameters	llm.ToolParameter[]	Server scripts	The parameters of the tool.

ToolCall Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	ToolCall.name	string	Server scripts	The name of the requested tool.
	ToolCall.parameters	llm.ToolParameter[]	Server scripts	The parameters of the requested tool.

ToolParameter Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	ToolParameter.description	string	Server scripts	The description of the tool parameter.
	ToolParameter.name	string	Server scripts	The name of the tool parameter.
	ToolParameter.type	string	Server scripts	The type of the tool parameter.

ToolResult Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	ToolResult.call	llm.ToolCall	Server scripts	The originating tool call request from the LLM.
	ToolResult.outputs	Object[]	Server scripts	The outputs from running the tool specified in the tool call request.

Usage Object Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Usage.completionTokens	number	Server scripts	The number of tokens in the response from the LLM.
	Usage.promptTokens	number	Server scripts	The number of tokens in the request to the LLM.
	Usage.totalTokens	number	Server scripts	The total number of tokens for the entire request to the LLM.

Note:

To learn more about the generative AI models, see the SuiteAnswers article LLM Mapping for Generative AI Features. Be aware that you must be logged in to NetSuite to access articles in SuiteAnswers.

Related Topics

• N/llm Module
• SuiteScript 2.x Generative AI APIs
• SuiteScript 2.x Modules
• SuiteScript 2.1

General Notices