llm.Citation

Note:

The content in this help topic pertains to SuiteScript 2.1.

Object Description

A citation returned from the LLM when source documents are provided to llm.generateText(options) or llm.generateText.promise(options).

A citation represents the content from source documents where the LLM found relevant information for its response. Citations are created using retrieval-augmented generation (RAG), which lets you provide additional context that the LLM can use to generate its responses. For more information about RAG, see What Is Retrieval-Augmented Generation (RAG)?

Citation objects are included in the llm.Response object that is returned from llm.generateText(options) or llm.generateText.promise(options), if applicable, through the Response.citations property. You can use the citation object to identify the documents that the LLM used for its response, as well as where the cited text appears in the response. The object includes properties that specify the documents used (Citation.documentIds), the start and end points of the cited text (Citation.start and Citation.end), and the content itself (Citation.text).

Supported Script Types

Server scripts

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

Module

N/llm Module

Methods and Properties

Citation Object Members

Since

2025.1

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

Syntax

Related Topics