StreamedResponse.toolCalls

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description	The tool call requests from the LLM. Note: The value of this property is not available until the entire response from the LLM has been generated. Make sure that you don't start processing this property and calling any required tools in your scripts until the streamed response is fully read.
Type	llm.ToolCall[]
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Module	N/llm Module
Parent Object	llm.Response
Sibling Object Members	Response Object Members
Since	2025.2

Errors

Error Code	Thrown If
READ_ONLY	Setting the property is attempted.

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.generateTextStreamed({
    prompt: 'Hello World',
    // myTools is an array of llm.Tool objects representing tools the LLM
    // can request
    tools: myTools
});

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

// Make sure that the response is fully read before you start working with
// this property and calling any required tools
const responseToolCalls = response.toolCalls;

...
// Add additional code 

          

General Notices