ReRankResponse.documentRanks

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description	The document ranks returned for the prompt, ordered from most relevant to least relevant. Each rank contains an index into the original options.documents array (provided to llm.reRank(options) or llm.reRank.promise(options)) and a relevance score. The number of entries is controlled by options.topN (provided to llm.reRank(options) or llm.reRank.promise(options)), which defaults to 1. Document text is not included in the results.
Type	llm.DocumentRank[]
Supported Script Types	Server scripts For more information, see SuiteScript 2.1 Script Types.
Module	N/llm Module
Parent Object	llm.ReRankResponse
Sibling Object Members	ReRankResponse 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?",
    topN: documents.length
});

const ranks = response.documentRanks;
const mostRelevantDocument = documents[ranks[0].index];

...
// Add additional code 

          

General Notices