Citation.text

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description

The cited text from the document.

Type

string

Supported Script Types

Server scripts

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

Module

N/llm Module

Parent Object

llm.Citation

Sibling Object Members

Citation 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.generateText({
    prompt: "My test prompt",
    documents: [doc1, doc2]
});

// If information in the provided documents is used to generate the response,
// the returned llm.Response object includes citations indicating where the
// cited information is located in the response
const citations = response.citations;
for (var i = 0; i < citations.length; i++) {
    var documentIds = citations[i].documentIds;
    var end = citations[i].end;
    var start = citations[i].start;
    var text = citations[i].text;

    // Work with the citation properties
}

...
// Add additional code

Errors

Syntax

Related Topics