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

llm.ModelFamily

Note:

The content in this help topic pertains to SuiteScript 2.1.

Enum Description

The large language model to be used.

Use this enum to set the value of the options.modelFamily parameter in llm.generateText(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

Sibling Module Members

N/llm Module Members.

Since

2024.2

Values

The following table lists the models that are supported when using llm.generateText(options) and llm.generateTextStreamed(options) (and their promise versions). The Supported Capabilities column indicates which of the following features are supported by each model:

  • Retrieval-augmented generation (RAG) – You can provide documents with text content (in llm.Document objects) using the options.documents parameter. These documents provide additional context to the LLM, and the LLM uses information in these documents to augment its response using RAG. It returns llm.Citation objects that represent the content from source documents where the LLM found relevant information for its response. For more information about RAG, see What Is Retrieval-Augmented Generation (RAG)? in the OCI documentation.

  • Preambles – You can provide a preamble using the options.preamble parameter. A preamble provides initial context or a guiding message to the LLM. For more information about using a preamble, see About the Chat Models in Generative AI (Chat Model Parameters section) in the OCI documentation.

Enum

Value

Supported Capabilities

Notes

RAG

Preambles

ModelFamily.COHERE_COMMAND_R

cohere.command-r-08-2024

Yes

Yes

Cohere Command R is the default model used when the options.modelFamily parameter is omitted in llm.generateText(options).

ModelFamily.COHERE_COMMAND_R_PLUS

cohere.command-r-plus-08-2024

Yes

Yes

—

Syntax

Important:

The following code sample shows the syntax for this member. It isn't a functional example. For a complete script example, see N/llm Module Script Samples.

            // Add additional code
...

const response = llm.generateText({
   prompt: "Hello World!",
   modelFamily: llm.ModelFamily.COHERE_COMMAND_R, 
   ...
});

...
// Add additional code

Additional Information

General Notices