ChatMessage.role

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description

The author of the chat message.

Type

string

Supported Script Types

Server scripts

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

Module

N/llm Module

Parent Object

llm.ChatMessage

Sibling Object Members

ChatMessage Object Members

Since

2024.1

Errors

Error Code	Thrown If
`READ_ONLY`	Setting the property is attempted.

Error Code

Thrown If

READ_ONLY

Setting the property is attempted.

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
...

chatHistory.push({
    role: llm.ChatRole.CHATBOT,
    text: chatBotMessage  // this is a previously defined string
});

...
// Add additional code

Errors

Syntax

Related Topics