DocumentRank.index

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description	The document's index in the original options.documents array (provided to llm.reRank(options) or llm.reRank.promise(options)). Use this index to retrieve the input document string. This value is not the document's position in the ranked results.
Type	number
Supported Script Types	Server scripts For more information, see SuiteScript 2.1 Script Types.
Module	N/llm Module
Parent Object	llm.DocumentRank
Sibling Object Members	DocumentRank Object Members
Since	2026.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 documents = ["Shipping information", "Return information"];
const response = llm.reRank({
    documents: documents,
    prompt: "How do I return an item?"
});

const documentIndex = response.documentRanks[0].index;
const mostRelevantdocument = documents[documentIndex];

...
// Add additional code 

          

General Notices