StreamedResponse.text

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description

The text returned by the LLM.

After calling a streamed method (such as llm.generateTextStreamed(options) or llm.evaluatePromptStreamed(options)), you can use this property to examine the partial response returned from the LLM before the entire response has been generated, as the following example shows:

                    var response = llm.generateTextStreamed("Write a 500 word pitch for a TV show about bears");
var iter = response.iterator();
iter.each(function(token){
    log.debug("token.value: " + token.value);
    log.debug("response.text: " + response.text);
    return true;
})

In this example, token.value contains the values of each token returned by the LLM, and response.text contains the partial response up to and including that token. For more information about iterators in SuiteScript, see Iterator.

Type

string

Supported Script Types

Server scripts

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

Module

N/llm Module

Parent Object

llm.StreamedResponse

Sibling Object Members

StreamedResponse Object Members

Since

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

const response = llm.generateTextStreamed({
    prompt: 'Hello World'
});

var iter = response.iterator();
iter.each(function(token) {
    log.debug('token.value: ' + token.value);
    log.debug('response.text: ' + response.text);
    return true;
})

const responseText = response.text;

...
// Add additional code

Errors

Syntax

Related Topics