1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/llm Module
  6. llm.ChatRole

llm.ChatRole

Note:

The content in this help topic pertains to SuiteScript 2.1.

Enum Description

The author of the chat message.

Use this enum to set the value of the options.role parameter in llm.createChatMessage(options).

Note:

JavaScript does not include an enumeration type. The SuiteScript 2.x documentation uses the term enumeration (or enum) to describe a plain JavaScript object with a flat, map-like structure. In this object, each key points to a read-only string value.

Module

N/llm Module

Supported Script Types

Server scripts

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

Since

2024.1

Values

Value

Notes

USER

Identifies the author of the chat message (prompt) sent to the large language model.

CHATBOT

Identifies the author of the chat message (response text) received from the large language model.

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.USER,
    text: yourMessage
});
chatHistory.push({
    role:llm.ChatRole.CHATBOT,
    text: chatBotMessage
});

...
// Add additional code

Related Topics

General Notices