EmbedResponse Object Members in SuiteScript 2.1

The EmbedResponse object members are essential for leveraging Large Language Model (LLM) responses in SuiteScript 2.1. They allow developers to tap into processed data from LLM with precision, enhancing server-side functionalities. This article details the properties of the EmbedResponse object and their usage in scripts.

What are the EmbedResponse Object Members?

The EmbedResponse object consists of several properties that return data from LLM operations. Here's a breakdown of the key members:

Property Descriptions

• EmbedResponse.embeddings: This property returns a list of numerical embeddings generated by the LLM, which can be utilized for various applications including semantic analysis and natural language processing tasks.
• EmbedResponse.inputs: This array contains the input strings supplied to the LLM, making it easier to track what data was fed into the model.
• EmbedResponse.model: Usage of this string informs developers about the specific LLM model that produced the embeddings, aiding in performance assessments and model-specific configurations.

Syntax Example

Below is a syntactical representation of how to utilize these members:

1// Add additional code
2...
3const response = llm.embed({
4    inputs: ['Hello World']
5});
6const responseEmbeddings = response.embeddings;
7// Further processing of embeddings
8...
9// Add additional code

Errors

When interacting with the EmbedResponse object, be aware of the READ_ONLY error code, which is thrown if there is an attempt to modify a property set within the EmbedResponse:

• Error Code: READ_ONLY
• Thrown If: Setting the property is attempted.

Who This Affects

This new feature primarily impacts:

• Developers who utilize SuiteScript 2.1 for server scripting.

Key Takeaways

• The EmbedResponse object is crucial for accessing LLM responses in SuiteScript 2.1.
• It includes properties like embeddings, inputs, and model, each serving distinct purposes.
• Understanding the returned data from these properties can significantly enhance the functionality of server-side scripts.