ChatMessage Object Members in SuiteScript 2.1

The ChatMessage object in SuiteScript 2.1 provides a method for creating and managing chat messages within scripts, facilitating interaction with chatbots and other messaging tools.

ChatMessage Object Members

The ChatMessage object includes several important members that define the structure and purpose of chat messages. Below are the key members you should be aware of:

Property Descriptions

1. Role: This property indicates who authored the chat message. It's a string type and is utilized predominantly by server scripts.
2. Text: This property contains the actual text of the chat message, which can either be user input or chat bot outputs. It is also a string type and is used in server scripts.

Error Handling

If you attempt to set a property that is read-only, you will encounter the following error:

• Error Code: READ_ONLY
• Thrown If: An attempt is made to set the property value of a read-only member.

Syntax Example

Here's a syntax example demonstrating how to create a new chat message using the ChatMessage object:

// Adding a chat message to the history
chatHistory.push({
    role: llm.ChatRole.CHATBOT,
    text: chatBotMessage  // this is a previously defined string
});

For a more comprehensive script example related to creating chat messages, you can refer to the N/llm Module Script Samples.

Who This Affects

This article is primarily directed towards:

• Developers: Those implementing server scripts using the SuiteScript framework.
• Administrators: Admins overseeing chat functionalities and integrations within their NetSuite instance.

Key Takeaways

• The ChatMessage object facilitates chat message management in SuiteScript.
• It includes properties like role and text, critical for message definition.
• Be mindful of read-only properties to avoid errors during implementation.