llm.createChatMessage(options)

Note:

The content in this help topic pertains to SuiteScript 2.1.

Method Description

Creates a chat message based on a specified role and text. Chat messages can be used in the chatHistory parameter of the llm.generateText(options) method. Supported roles are defined by the llm.ChatRole enum.

Returns

llm.ChatMessage

Supported Script Types

Server scripts

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

Governance

None

Module

N/llm Module

Since

2024.1

Parameters

Parameter	Type	Required / Optional	Description	Since
`options.role`	string	required	Author of the message (as a role). Use llm.ChatRole to set the value.	2024.1
`options.text`	string	required	Text of the chat.	2024.1

Parameter

Type

Required / Optional

Description

Since

options.role

string

required

Author of the message (as a role).

Use llm.ChatRole to set the value.

2024.1

options.text

string

required

Text of the chat.

2024.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 myChatMessage = llm.createChatMessage({
   role: llm.ChatRole.USER,
   text: 'Hello World'
});

...
// Add additional code

Parameters

Syntax

Related Topics