StreamedResponse.documents

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description

The list of documents used to generate the streamed response.

This property is an array of llm.Document objects, each of which represents a document provided to llm.generateTextStreamed(options) or llm.generateTextStreamed.promise(options). This property has a value only if a provided document was used to generate the response.

Note:

The value of this property is not available until the entire response from the LLM has been generated.

Type

llm.Document[]

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

// The documents doc1 and doc2 are created using llm.createDocument(options)
const response = llm.generateTextStreamed({
    prompt: 'My test prompt',
    documents: [doc1, doc2]
});

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

// If information in the provided documents is used to generate the response,
// the returned llm.Response object includes the provided documents
const responseDocuments = response.documents;

...
// Add additional code

Errors

Syntax

Related Topics